diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b14123e5d..daa46c772 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -106,19 +106,19 @@ And open your browser to `http://localhost:4000` to view the docs locally. ## Releasing -The versioning of modules in the this repo are done using `rush change`. Read more about best practices - [rushchange] +The versioning of modules in the this repo are done using `rush change`. Read more about [best practices] It's important that commits are isolated for the package they affected only and contains the version tags `[major]`, `[minor]`, or `[patch]`. `[patch]` is the default if tag is not found in commit message. To release, follow these steps: 1. Use `xrun update-changelog` to detect packages that changed and their version bumps. -1. Verify and check the file `CHANGELOG.md`, add a summary of key changes under the date. -1. Amend the commit for `CHANGELOG.md` with summary changes. -1. Run `npx fynpo prepare --no-tag` to prepare packages for release. -1. Run `git tag -a rel-v<#>-` where `<#>` is the major archetype version, and `` as `YYYYMMDD`. (ie: `rel-v9-20210301`) -1. Publish the packages that has version bumps. -1. Push the release commits. +2. Verify and check the file `CHANGELOG.md`, add a summary of key changes under the date. +3. Amend the commit for `CHANGELOG.md` with summary changes. +4. Run `npx fynpo prepare --no-tag` to prepare packages for release. +5. Run `git tag -a rel-v<#>-` where `<#>` is the major archetype version, and `` as `YYYYMMDD`. (ie: `rel-v9-20210301`) +6. Publish the packages that has version bumps. +7. Push the release commits. [prettier]: https://www.npmjs.com/package/prettier @@ -126,4 +126,4 @@ To release, follow these steps: [docusaurus]: https://docusaurus.io/ [rushjs]: https://rushjs.io/pages/intro/welcome/ [here]: https://rushjs.io/pages/maintainer/package_managers/ -[rushchange]: https://rushjs.io/pages/best_practices/change_logs/#recommended-practices +[best practices]: https://rushjs.io/pages/best_practices/change_logs/#recommended-practices