primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-12-25 07:03:35 +03:00
Code Issues Projects Releases Wiki Activity

Update RELEASING.md

Browse Source
This commit is contained in:
simurai 2020-03-24 12:04:20 +09:00 committed by GitHub
parent a15aba0581
commit b81fe7ad18
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
RELEASING.md
View File

@ -9,13 +9,16 @@
1. Run [`npm version <version>`](https://docs.npmjs.com/cli/version) to update the `version` field in both `package.json` and `package-lock.json`. 1. Run [`npm version <version>`](https://docs.npmjs.com/cli/version) to update the `version` field in both `package.json` and `package-lock.json`.
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: 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. The changelog gets generated automatically :
```md ```md
# Primer CSS [Major|Minor|Patch] Release # Primer CSS [Major|Minor|Patch] Release
Version: 📦 **0.0.0** Version: 📦 **`0.0.0`**
Approximate release date: 📆 DD/MM/YY Approximate release date: 📆 **DD/MM/YY**
Changes: 🎉 [All merged PRs](https://github.com/primer/css/pulls?q=is%3Apr+is%3Amerged+base%3Arelease-0.0.0)
---
### :boom: Breaking Change ### :boom: Breaking Change
- [ ] Description # - [ ] Description #
@ -35,11 +38,11 @@
### :house: Internal ### :house: Internal
- [ ] Description # - [ ] Description #
---- ---
### Ship checklist ### Ship checklist
- [ ] Update the `version` field in `package.json` - [x] Update the `version` field in `package.json`
- [ ] Update `CHANGELOG.md` - [ ] Update `CHANGELOG.md`
- [ ] Test the release candidate version with `github/github` - [ ] Test the release candidate version with `github/github`
- [ ] Merge this PR and [create a new release](https://github.com/primer/css/releases/new) - [ ] Merge this PR and [create a new release](https://github.com/primer/css/releases/new)
@ -53,11 +56,11 @@
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. 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. Update `CHANGELOG.md` 1. Update `CHANGELOG.md` and the PR description. **Tip**: You can copy&paste the changelog from `Checks > changelog > all > changelog`. It gets generated based on adding the `Tag` labels to PRs.
1. Wait for your checks to pass, and take note of the version that [primer/publish] lists in your status checks. 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. **Tip**: 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.
## Test the release candidate (in `github/github`): ## Test the release candidate (in `github/github`):