Skip to content

Commit

Permalink
docs: documentation and contribution guidelines updated
Browse files Browse the repository at this point in the history
  • Loading branch information
arunvishnun committed Jan 5, 2023
1 parent 72844a5 commit 27ba25a
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,24 +106,24 @@ 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<#>-<date>` where `<#>` is the major archetype version, and `<date>` 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<#>-<date>` where `<#>` is the major archetype version, and `<date>` 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

[xclap-cli]: https://www.npmjs.com/package/xclap-cli
[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

0 comments on commit 27ba25a

Please sign in to comment.