primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2025-01-08 07:23:03 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #757 from primer/update-releasing

Browse Source 
Update RELEASING
This commit is contained in:
simurai 2019-04-30 17:05:44 +09:00 committed by GitHub
commit fc2d011837
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
RELEASING.md
View File

@ -1,15 +1,15 @@
# Releasing a new version of Primer CSS 🎉
## Prepare the release (in `primer/css`)
## In this repo
1. Decide which [PRs](https://github.com/primer/css/pulls) should be part of the next release and if it will be a major, minor or patch `<version>`. You may also check the [release tracking project
](https://github.com/primer/css/projects/2#column-4482699) or ask your team members in Slack.
1. Check off all of the boxes in your release PR.
1. Create a new release branch from `master` and name it `release-<version>`.
1. Test your changes with the latest release candidate version [in github/github](#in-github-github).
1. Start merging existing PRs into the release branch. Note: You have to change the base branch from `master` to the `release-<version>` branch before merging.
1. 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.
1. Create a new release branch for the next release from `master` and name it `release-<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:
1. Create a new PR for the `release-<version>` branch. Please use the following template for the PR description, linking to the relevant issues and/or pull requests for each change, removing irrelevant headings and checking off all of the boxes of the ship checklist:
```md
# Primer [Major|Minor|Patch] Release
@ -25,13 +25,13 @@
### :bug: Bug Fix
- [ ] Description #
### :nail_care: Polish
- [ ] Description #
### :memo: Documentation
- [ ] Description #
### :house: Internal
- [ ] Description #
@ -40,21 +40,28 @@
### Ship checklist
- [ ] Update `CHANGELOG.md`
- [ ] Update the `version` field in `package.json` to match the release 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
- [ ] Update the `version` field in `package.json`
- [ ] Test the release candidate version with `github/github`
- [ ] Merge this PR and [create a new release](https://github.com/primer/css/releases/new)
- [ ] Update `github/github`
For more details, see [RELEASING.md](https://github.com/primer/css/blob/master/RELEASING.md).
/cc @primer/ds-core
```
1. Update `CHANGELOG.md`
1. Update the `version` field in `package.json` to match the release version. You may also run the `npm version v<version>` command.
1. Wait for your checks to pass, and take note of the version that [primer/publish] lists in your status checks.
**ProTip:** The release candidate version will always be `<version>-rc.<sha>`, where `<version>` comes from the branch name and `<sha>` is the 7-character commit SHA.
### In `github/github`:
1. Create a new branch.
## Test the release candidate (in `github/github`):
1. Create a new branch in the `github/github` repo, name it `primer-<version>`.
1. Update the Primer CSS version to the published release candidate with:
@ -62,7 +69,7 @@
bin/npm install @primer/css@<version>-rc.<sha>
```
Then commit and push the changes to `package.json`, `package-lock.json`, and `vendor/npm`.
Then commit and push the changes to `package.json`, `package-lock.json`, `LICENSE` and `vendor/npm`.
1. 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.
@ -70,28 +77,34 @@
1. Test on review-lab.
1. Publish `@primer/css` to the `latest` dist-tag by merging the release branch and waiting for [primer/publish] to finish.
1. Install the latest published version with:
## 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 [primer/publish] has finished.
1. [Create a new release](https://github.com/primer/primer/releases/new) with tag `v<version>`.
1. Copy the changes from the [CHANGELOG] and paste them into the release notes.
1. Publish 🎉
## Update github.com (in `github/github`):
1. Install the latest published version in the same `primer-<version>` branch created earlier with:
```
bin/npm install @primer/css@<version>
```
Then commit and push the changes to `package.json`, `package-lock.json`, and `vendor/npm`.
Then commit and push the changes to `package.json`, `package-lock.json`, `LICENSE` and `vendor/npm`.
1. Fix any breaking tests.
1. Deploy! :rocket:
### Publish the release
1. [Create a new release](https://github.com/primer/primer/releases/new) with tag `v<version>`.
2. Copy the changes from the [CHANGELOG] and paste them into the release notes.
3. Publish 🎉
[changelog]: ../CHANGELOG.md
[primer/publish]: https://github.com/primer/publish