Repository navigation
fix: include synced plugin changelogs in the release commit - #43
Merged
Merged
Conversation
release-it stages the release files during the beforeRelease phase. The build hook ran later, in before:git:release, so the changelogs it copied into shared/glean and shared/glean-dev-docs were left out of the commit, and the plugins shipped stale changelogs. Run the build in before:git:beforeRelease instead, after the changelog is written and before staging. Also commit the current synced changelogs, and fail CI when the committed copies differ from the build output.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The plugins ship stale changelogs. After
npm run release,shared/glean/CHANGELOG.mdandshared/glean-dev-docs/CHANGELOG.mdare left modified and uncommitted, and the 3.6.0 plugins ship changelogs that stop at 3.5.0.Cause
release-it stages the release files during its
beforeReleasephase, right after the changelog plugin writesCHANGELOG.md. Our build hook ran later, inbefore:git:release. The build copies the root changelog into each shared plugin, so those copies changed after staging and missed the commit.publish.ymlships the committed files, so the stale copies shipped.#22 moved the hook from
after:bump, which runs before the changelog is written, tobefore:git:release, which runs after staging. Both miss.Fix
before:git:beforeRelease. It runs after the changelog is written and before staging.RELEASE.mdto match.Testing
I ran release-it with
--ci --no-git.push --no-git.tag --no-github.releasein two throwaway clones:main