Repository navigation
ci: read release notes before publishing to npm - #280
Merged
Merged
Conversation
The Publish workflow read the version's CHANGELOG.md section only when it created the GitHub release, after npm publish. A version bump without a changelog section, such as a hand edit of package.json, was published to npm, which can't be undone, and then the workflow failed. The notes are now read right after install, before the checks and the publish, and the release step reuses that file.
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.
Problem
publish.ymlread the version's notes from CHANGELOG.md only in its last step, afternpm publish. A version bump without a changelog section, such as a hand edit ofpackage.jsoninstead ofpnpm release, would be published to npm, which can't be undone, and then the job failed withCHANGELOG.md has no section for <version>.Fix
The notes are read right after
pnpm install, under the samepublish || releasecondition, so a missing section fails the job before the type checks and the publish.gh release createuses that file.Tests
I replayed the steps after install from both versions of the workflow in order, the way Actions runs them (
bash -eo pipefail, later steps skipped after a failure), withnpmandghstubbed andpackage.jsonat 3.2.0, which has no changelog section:npm publishmainAt 3.1.0 every step runs and the release gets the full notes. actionlint passes.