-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## Which problem is this PR solving? - new release v4.1.0 ## Short description of the changes - update release doc for clarity and consistency - bump version to 4.1.0 - update changelog
- Loading branch information
1 parent
355e4ee
commit b43b445
Showing
4 changed files
with
61 additions
and
12 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,20 @@ | ||
# Release Process | ||
|
||
1. Add release entry to [changelog](./CHANGELOG.md) | ||
2. Update version using `npm version --no-git-tag-version patch` (replace patch with minor / major as needed) | ||
3. Open a PR with the above, and merge that into main | ||
4. Create new tag on merged commit with the new version (e.g. `git tag -a v2.3.1 -m "v2.3.1"`) | ||
5. Push the tag upstream (this will kick off the release pipeline in CI) e.g. `git push origin v2.3.1` | ||
6. Copy change log entry for newest version into draft GitHub release created as part of CI publish steps | ||
- generate release notes via github release draft for full changelog notes and any new contributors | ||
- Use `npm version --no-git-tag-version` to update the version number using `major`, `minor`, `patch`, or the prerelease variants `premajor`, `preminor`, or `prepatch`. | ||
For example, to bump from v1.1.1 to the next patch version: | ||
|
||
```shell | ||
> npm version --no-git-tag-version patch # 1.1.1 -> 1.1.2 | ||
``` | ||
|
||
- Confirm the version number update appears in `package.json` and `package-lock.json`. | ||
- Update `CHANGELOG.md` with the changes since the last release. Consider automating with a command such as these two: | ||
- `git log $(git describe --tags --abbrev=0)..HEAD --no-merges --oneline > new-in-this-release.log` | ||
- `git log --pretty='%C(green)%d%Creset- %s | [%an](https://github.com/)'` | ||
- Commit changes, push, and open a release preparation pull request for review. | ||
- Once the pull request is merged, fetch the updated `main` branch. | ||
- Apply a tag for the new version on the merged commit (e.g. `git tag -a v2.3.1 -m "v2.3.1"`) | ||
- Push the tag upstream (this will kick off the release pipeline in CI) e.g. `git push origin v2.3.1` | ||
- Ensure that there is a draft GitHub release created as part of CI publish steps (this will also publish to NPM). | ||
- Click "generate release notes" in GitHub for full changelog notes and any new contributors | ||
- Publish the GitHub draft release |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains 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