2.8 KiB
Releasing a new Primer version 🎉
In this repo
-
Check off all of the boxes in your release PR.
-
Test your changes with the latest release candidate version in github/github.
-
Once the release PR is approved and you've done necessary testing, merge it. After tests run, the site will be deployed and
@primer/css
will be published with your changes. -
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` - [ ] Increment version in `package.json` with `npm version` - [ ] [Create a new release](https://github.com/primer/css/releases/new) - [ ] [Update github/github](https://github.com/primer/css/blob/master/RELEASING.md#in-githubgithub) - [ ] 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/css@<version>
. primer/publish will create a check status listing the published version.- If you're working on a release candidate, the
<version>
will be suffixed with-rc.<sha>
, where<sha>
is the 7-character SHA of the most recently published commit. - Otherwise, your work will be published to the
canary
dist-tag as0.0.0-sha.<sha>
.
- If you're working on a release candidate, the
-
If you need to make changes to github/github due to the Primer release, do them in a branch and merge that into your release branch after testing.
-
Add or re-request reviewers and fix any breaking tests.
-
Test on review-lab.
-
Publish
@primer/css
to thelatest
dist-tag by merging the release branch and waiting for the publish action to finish. -
Run
bin/npm install @primer/css@<version>
with the published version and commit the resulting changes. -
Push your changes and fix any breaking tests.
-
Deploy! 🚀
Publish release tag
-
Create a new release with tag
v<version>
. -
Copy the changes from the CHANGELOG and paste them into the release notes.
-
Publish 🎉