JoshuaKGoldberg / create-typescript-app

Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. šŸ’
MIT License
1.21k stars 75 forks source link

šŸš€ Feature: "enable the GitHub apps" / "populate the secrets" to include links to the relevant URLs #1621

Open johnnyreilly opened 3 months ago

johnnyreilly commented 3 months ago

Bug Report Checklist

Overview

Consider the following:

Be sure to:

- enable the GitHub apps:
  - Codecov (https://github.com/apps/codecov)
  - Renovate (https://github.com/apps/renovate)
- populate the secrets:
  - ACCESS_TOKEN (a GitHub PAT with repo and workflow permissions)
  - NPM_TOKEN (an npm access token with automation permissions)

The URL to enable the GitHub apps is known and will take this form:

https://github.com/{ORGANISATION/USERNAME}/{REPO-NAME}/settings/installations

The URL to populate the secrets is known and will take this form:

https://github.com/{ORGANISATION/USERNAME}/{REPO-NAME}/settings/secrets/actions

Would it be useful to include those explicit links in the output? Something like this:

Be sure to:

- enable the GitHub apps: https://github.com/{ORGANISATION/USERNAME}/{REPO-NAME}/settings/installations
  - Codecov (https://github.com/apps/codecov)
  - Renovate (https://github.com/apps/renovate)
- populate the secrets: https://github.com/{ORGANISATION/USERNAME}/{REPO-NAME}/settings/secrets/actions
  - ACCESS_TOKEN (a GitHub PAT with repo and workflow permissions)
  - NPM_TOKEN (an npm access token with automation permissions)

Additional Info

It might also be nice to include a link to the created repo? https://github.com/{ORGANISATION/USERNAME}/{REPO-NAME}

As an aside, when creating a repo, I discovered no apps installed and disabled? Just an empty screen? Am I looking in the wrong place?

a screenshot of the issue mentioned
JoshuaKGoldberg commented 3 months ago

include links to the relevant URLs

Good idea, +1! Accepting PRs.

Long term it would be nice to actually try to do this for the user, but I don't know how that would work...

when creating a repo, I discovered no apps installed and disabled? Just an empty screen? Am I looking in the wrong place?

Have you gone through the apps URLs & installed them on the repo?

johnnyreilly commented 3 months ago

Have you gone through the apps URLs & installed them on the repo?

No - I assumed from the prompt this was something that CTA did. It doesn't? I took "enable the GitHub apps" to mean they were already installed in a disabled state. Are they not installed?

JoshuaKGoldberg commented 3 months ago

You have to do it manually. Maybe that's a docs improvement to be made?

johnnyreilly commented 3 months ago

Yeah I think so