docs: add semantic release simulation docs - #608
Merged
Conversation
Owner
Author
|
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @davidlj95 and the rest of your teammates on |
📦 Bundle size (Angular v15)Git ref:
|
📦 Bundle size (Angular v18)Git ref:
|
📦 Bundle size (Angular v17)Git ref:
|
📦 Bundle size (Angular v16)Git ref:
|
|
🎉 This PR is included in version 1.0.0-beta.5 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
1 participant
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.
Issue or need
In latest release,
mainwas added asdist-tagto the package. Butlatestwasn't.About
maindist tag, it's because an error in Semantic Release configuration.channeldefines the tag used when publishing in npm. And by default it takes the name of the branch (unless it's the first release branch). So that's whymainas there. It has been there since the beginning, after checkinggit notescreated by semantic release and GitHub Actions logs.About
latestnot being there, still don't know why exactly*. Nothing in semantic release or the npm plugin seems to have changed to alter that behavior. Makes sense, as it would be a breaking change and therefore a documented one. It was there for previous releases. Though that may change soon innpmv11.To be able to find that, simulated releases with semantic release. It's not an easy task though and has its quirks. The more the further you want to simulate. So writing them in a guide in case a release needs to be debugged or rehearsed in the future.
Proposed changes
Document the release rehearsal steps. In
CONTRIBUTING.mdwhere all processes are explained.Will manually fix the invalid semantic release notes (should be in
null/ default channel instead ofmainchannel) and semantic release configuration manually after merging this PR. Now that can first safely ensure the proper release config will be in place.Quick reminders