Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add release-plz init command #1344

Closed
1 task done
MarcoIeni opened this issue Mar 14, 2024 · 1 comment
Closed
1 task done

add release-plz init command #1344

MarcoIeni opened this issue Mar 14, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@MarcoIeni
Copy link
Owner

MarcoIeni commented Mar 14, 2024

Motivations

Onboarding is difficult: people need to read the docs to learn how to set up the GitHub action.
Let's change that!

Solution

Add a release-plz init command to prompt the user and guide them through the onboarding.
It only works if it detects a GitHub repository or no remote is set.

The command will:

  1. ask the user to copy paste their cargo registry token, tell them that if they don't have it, they can create one at this link: https://crates.io/settings/tokens/new explaining what options are required. After they paste the token and hit enter, release-plz sets the cargo registry token in github actions secret
  2. ask the user if they want to create a PAT (link to the release-plz github actions section) and set the secret in GitHub actions.
  3. write to file system the release-plz.yml file

How do we set github actions secrets with the rest api?

here

why this name?

The name comes from cargo init.

Tasks

  • detect default branch and use that one instead of main
@MarcoIeni MarcoIeni added the enhancement New feature or request label Mar 14, 2024
@MarcoIeni MarcoIeni self-assigned this Mar 16, 2024
@MarcoIeni
Copy link
Owner Author

implemented in #1350

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant