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

ci: migrate from standard-version to release-please #1593

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

lediur
Copy link
Contributor

@lediur lediur commented May 2, 2023

Description

This PR implements the "manifest releaser" scheme for the release-please tool, replacing Spoke's use of the older release management tool standard-version.

Reviewer / merger note

This PR needs to merge in the following order:

  • merge the initial "bootstrap" PR on my fork (or create a new "bootstrap" PR on politics-rewired/Spoke)
  • create a personal access token and assign it to the RELEASEPLS_GITHUB_PAT repository secret
    • I recommend doing this (and have implemented as part of this PR in the workflow definition) so release PRs can get CI pipelines run on them. See the relevant GitHub documentation.
    • You may consider making the personal access token as a "bot" user, otherwise it'll get assigned to the creator's personal account and might get confusing down the line.
  • merge this PR
bootstrap PR generated with the following steps
  • push the contents of lediur:build/release-please to politics-rewired/Spoke:build/release-please
  • create an initial "bootstrap" PR created by the release-please bootstrap process (example at chore(build/release-please): release 6.2.0-rc.1 lediur/Spoke#1)
    • generate a temporary personal access token by going to Settings > Developer Settings > Personal Access Tokens > Fine-grained Tokens. You should grant the token access to read metadata, read and write access to actions, code, and pull requests on politics-rewired/Spoke

    • generate the "bootstrap" PR by running:

      npx release-please --token=github_pat_generate-your-own-personal-access-token --repo-url=politics-rewired/Spoke --target-branch=build/release-please release-pr
      

After this PR merges, subsequent merges to main should automatically generate and update a release PR to the next version. release-please is set up to detect the next semver automatically based on commit prefixes, but it doesn't handle semver suffixes like -rc.X that well, so right now, this PR manually pins the next version to 6.2.0-rc.1 via release-as in the release-please-config.json.

I can revert to automatic next version detection or rebuild the initial bootstrap PR some other version (building a 6.1.4?) as desired.

Motivation and Context

Resolves #1429

How Has This Been Tested?

Locally and with a fork of the Spoke repo (see lediur#1 for an example bootstrap PR by the tool)

Screenshots (if appropriate):

See above links

Documentation Changes

No user-facing changes, only documentation and release ceremony changes for Spoke contributors.

TODO

  • write changes to README.md to document new release process with release-please

Checklist:

  • My change requires a change to the documentation.
  • I have included updates for the documentation accordingly.

@lediur lediur changed the base branch from build/release-please to main May 2, 2023 06:49
@lediur lediur marked this pull request as ready for review May 2, 2023 19:05
@lediur lediur requested a review from hiemanshu May 2, 2023 19:05
@lediur
Copy link
Contributor Author

lediur commented May 17, 2023

@hiemanshu now that 6.2.0 is released, should we revisit this?

@hiemanshu
Copy link
Contributor

@hiemanshu now that 6.2.0 is released, should we revisit this?

Yeah. Going to revisit this once the "emergency" feature branch of 6.3.0 is resolved.

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

Successfully merging this pull request may close these issues.

Replace standard-version
2 participants