1
1
mirror of https://github.com/primer/css.git synced 2024-11-29 14:14:26 +03:00
css/RELEASING.md

53 lines
2.0 KiB
Markdown
Raw Normal View History

2019-02-15 21:46:46 +03:00
# Releasing a new version of Primer CSS 🎉
2018-05-11 22:11:53 +03:00
2019-04-15 08:46:01 +03:00
## Prepare the release (in `primer/css`)
2018-05-11 22:11:53 +03:00
The release process is automated by [changesets]. After you familiarize yourself with how they work. We use an [action workflow integrated in ci](https://github.com/atlassian/changesets#integrating-with-ci).
2018-05-11 22:11:53 +03:00
1. Visit the pull requests page and find the [latest Release tracking pr from primer-css](https://github.com/primer/css/pulls/primer-css). If there isn't one, we'll need to build the next release by merging in PRs with changeset files.
2018-05-11 22:11:53 +03:00
2019-04-15 08:46:01 +03:00
## Test the release candidate (in `github/github`):
1. Create a new branch in the `github/github` repo, name it `primer-<version>`.
2019-02-15 21:46:46 +03:00
1. Update the Primer CSS version to the published release candidate with:
```sh
bin/npm install @primer/css@<version>-rc.<sha>
```
2018-05-11 22:11:53 +03:00
2019-04-15 08:46:01 +03:00
Then commit and push the changes to `package.json`, `package-lock.json`, `LICENSE` and `vendor/npm`.
2019-02-12 00:25:16 +03:00
2019-04-25 23:42:54 +03:00
1. If you need to make changes to github/github due to the Primer CSS release, do them in a branch and merge _that_ into your release branch after testing.
2018-05-11 22:11:53 +03:00
2019-02-12 00:25:16 +03:00
1. Add or re-request reviewers and fix any breaking tests.
2018-05-11 22:11:53 +03:00
2019-02-12 00:25:16 +03:00
1. Test on review-lab.
2018-05-11 22:11:53 +03:00
2019-02-15 21:46:46 +03:00
2019-04-15 08:46:01 +03:00
## Publish the release (in `primer/css`)
1. If the release PR got approved and you've done necessary testing, merge it.
After tests run, the docs site will be deployed and `@primer/css` will be published with your changes to the `latest` dist-tag. You can check [npm](https://www.npmjs.com/package/@primer/css?activeTab=versions) to see if actions has finished.
2019-04-15 08:46:01 +03:00
2022-08-23 19:20:49 +03:00
2. Done! 🎉
2019-04-15 08:46:01 +03:00
## Update github.com (in `github/github`):
1. Install the latest published version in the same `primer-<version>` branch created earlier with:
2019-02-15 21:46:46 +03:00
```
2023-03-31 20:28:00 +03:00
bin/npm install @primer/css@<version> -w ./npm-workspaces/primer/
2019-02-15 21:46:46 +03:00
```
2018-05-11 22:11:53 +03:00
2019-04-15 08:46:01 +03:00
Then commit and push the changes to `package.json`, `package-lock.json`, `LICENSE` and `vendor/npm`.
2018-05-11 22:11:53 +03:00
2019-02-15 21:46:46 +03:00
1. Fix any breaking tests.
2019-02-12 00:25:16 +03:00
1. Deploy! :rocket:
2018-05-11 22:11:53 +03:00
2019-02-12 00:25:16 +03:00
[changelog]: ../CHANGELOG.md
[changesets]: https://github.com/atlassian/changesets