Skip to content

Commit

Permalink
Small tweak to maintainer guide on how to generate a changelog for a …
Browse files Browse the repository at this point in the history
…specific sub-package in a monorepo.
  • Loading branch information
filmaj committed Oct 3, 2023
1 parent b7bad09 commit c32414c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/maintainers_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak

- When creating the release notes, select the tag you generated earlier for your release and title the release the same name as the tag

- To see a list of changes between the last tag for the specific package, you can use this `git` command: `git log --oneline --full-history @slack/types@2.8.0..@slack/types@2.9.0 -- packages/types`. Sub in the correct tags and the last argument should be the path to the sub-package you are releasing (in order to filter commits just to the specific path).

- Release notes should mention contributors, issues and PRs ([Example](https://github.com/slackapi/node-slack-sdk/releases/tag/%40slack%2Fweb-api%406.2.0))

- Once the release notes are ready, click the "Publish Release" button to make them public
Expand Down

0 comments on commit c32414c

Please sign in to comment.