Skip to content

Commit

Permalink
docs: add release naming instructions (#1881)
Browse files Browse the repository at this point in the history
  • Loading branch information
booc0mtaco authored Mar 6, 2024
1 parent 97d72d4 commit 6d4e0dc
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/PUBLISHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ Once merged, wait until the [builds complete on `main`](https://github.com/chanz
9. Publish the package: `npm publish`
10. Create a [new release](https://github.com/chanzuckerberg/edu-design-system/releases) based on the new tag. Use the same text used for the pull request description above (from CHANGELOG.md). Also include the link for the built storybook in the description. This will automatically post to [relevant slack channels](https://slack.github.com/). **When doing a major version release, don't forget to include notes on each breaking change**. Also, enable the discussion feature to handle any question-answering should questions arise.

When naming the release, include the package name before the version number in the release name field (e.g., "@chanzuckerberg/eds vX.X.X")

#### Finishing the release

Expand Down

0 comments on commit 6d4e0dc

Please sign in to comment.