- normalize headings - improve the create release link
3.6 KiB
Releasing a new Primer version 🎉
In primer/primer
:
-
Go through the tracking PR and make sure everything listed is merged in.
-
To update the changelog for your release, click on the details links for the continuous-integration/travis-ci/push build. Expand the
Deploying application
output and copy the changelog content. Update the CHANGELOG.md file with the changelog content from buildNote: the CHANGELOG contents may be hidden within a collapsed section of the Travis logs under
Deploying the application
. Click the ▶ to the left of that section to expand it:Then scroll to the bottom of the page, and copy all of the text between the
Unreleased (YYYY-MM-DD)
heading and the exit status message. You may need to copy before releasing your mouse to prevent Travis from collapsing that section of the logs first: -
Bump the package versions in your terminal:
npm run bump
-
Run
script/check-versions
to catch any cross-module version mismatches. (This will run on Travis, too.) -
Test your changes with the latest release candidate version in the appropriate places (styleguide, storybook, github/github).
-
Once the release PR is approved and you've done necessary testing, merge to
master
. This will trigger publishing to npm. -
Create a new release branch for the next release from
master
and name itrelease-<version>
. Please use the following template for the PR description, linking to the relevant issues and/or pull requests for each change, and removing irrelevant headings:# Primer [Major|Minor|Patch] Release Version: 📦 **0.0.0** Approximate release date: 📆 DD/MM/YY ### :boom: Breaking Change - [ ] Description # ### :rocket: Enhancement - [ ] Description # ### :bug: Bug Fix - [ ] Description # ### :nail_care: Polish - [ ] Description # ### :memo: Documentation - [ ] Description # ### :house: Internal - [ ] Description # ---- ### Ship checklist - [ ] Update `CHANGELOG.md` - [ ] Bump versions with `npm run bump` - [ ] [Create a new release](https://github.com/primer/primer/releases/new) - [ ] [Update github/github](https://github.com/primer/primer/blob/master/RELEASING.md#in-githubgithub) - [ ] [Update github/styleguide](https://github.com/github/styleguide/#adding-new-content-from-primer) - [ ] Create a new pull request for the next release /cc @primer/ds-core
In github/github
:
-
Create a new branch
-
Update the primer version in your terminal
bin/npm install primer@<version>
. -
Update
stylelint-config-primer
in your terminal to the appropriate versionbin/npm install stylelint-config-primer@latest
. -
If you need to make changes to github/github due to the Primer release, make a separate branch. When ready, merge that branch into your release branch.
-
Add reviewers.
-
Check that every deleted vendor file has an accompanying updated vendor file and that the version numbers look correct.
-
Test on review-lab.
-
When ready, merge! 🎉
Publish release tag
-
Create a new release with tag
v<version>
. -
Copy the changes from the CHANGELOG and paste it into the release notes.
-
Publish 🎉