Skip to content

Commit 2c8a0b9

Browse files
authored
Merge branch 'release-12.3.0' into more-pink
2 parents ed737d1 + c40a211 commit 2c8a0b9

File tree

12 files changed

+1266
-344
lines changed

12 files changed

+1266
-344
lines changed

RELEASING.md

Lines changed: 40 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Releasing a new version of Primer CSS 🎉
22

3+
## Prepare the release (in `primer/css`)
34

4-
## In this repo
5+
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
6+
](https://github.com/primer/css/projects/2#column-4482699) or ask your team members in Slack.
57

6-
1. Check off all of the boxes in your release PR.
8+
1. Create a new release branch from `master` and name it `release-<version>`.
79

8-
1. Test your changes with the latest release candidate version [in github/github](#in-github-github).
10+
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.
911

10-
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.
11-
12-
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:
12+
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:
1313

1414
```md
1515
# Primer [Major|Minor|Patch] Release
@@ -25,13 +25,13 @@
2525

2626
### :bug: Bug Fix
2727
- [ ] Description #
28-
28+
2929
### :nail_care: Polish
3030
- [ ] Description #
31-
31+
3232
### :memo: Documentation
3333
- [ ] Description #
34-
34+
3535
### :house: Internal
3636
- [ ] Description #
3737

@@ -40,58 +40,71 @@
4040
### Ship checklist
4141

4242
- [ ] Update `CHANGELOG.md`
43-
- [ ] Update the `version` field in `package.json` to match the release version
44-
- [ ] [Create a new release](https://github.com/primer/css/releases/new)
45-
- [ ] [Update github/github](https://github.com/primer/css/blob/master/RELEASING.md#in-githubgithub)
46-
- [ ] Create a new pull request for the next release
43+
- [ ] Update the `version` field in `package.json`
44+
- [ ] Test the release candidate version with `github/github`
45+
- [ ] Merge this PR and [create a new release](https://github.com/primer/css/releases/new)
46+
- [ ] Update `github/github`
47+
48+
For more details, see [RELEASING.md](https://github.com/primer/css/blob/master/RELEASING.md).
4749

4850
/cc @primer/ds-core
4951
```
5052

53+
1. Update `CHANGELOG.md`
54+
55+
1. Update the `version` field in `package.json` to match the release version. You may also run the `npm version v<version>` command.
56+
5157
1. Wait for your checks to pass, and take note of the version that [primer/publish] lists in your status checks.
5258

5359
**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.
5460

55-
### In `github/github`:
5661

57-
1. Create a new branch.
62+
## Test the release candidate (in `github/github`):
63+
64+
1. Create a new branch in the `github/github` repo, name it `primer-<version>`.
5865

5966
1. Update the Primer CSS version to the published release candidate with:
6067

6168
```sh
6269
bin/npm install @primer/css@<version>-rc.<sha>
6370
```
6471

65-
Then commit and push the changes to `package.json`, `package-lock.json`, and `vendor/npm`.
72+
Then commit and push the changes to `package.json`, `package-lock.json`, `LICENSE` and `vendor/npm`.
6673

6774
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.
6875

6976
1. Add or re-request reviewers and fix any breaking tests.
7077

7178
1. Test on review-lab.
7279

73-
1. Publish `@primer/css` to the `latest` dist-tag by merging the release branch and waiting for [primer/publish] to finish.
7480

75-
1. Install the latest published version with:
81+
## Publish the release (in `primer/css`)
82+
83+
1. If the release PR got approved and you've done necessary testing, merge it.
84+
85+
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.
86+
87+
1. [Create a new release](https://github.com/primer/primer/releases/new) with tag `v<version>`.
88+
89+
1. Copy the changes from the [CHANGELOG] and paste them into the release notes.
90+
91+
1. Publish 🎉
92+
93+
94+
## Update github.com (in `github/github`):
95+
96+
1. Install the latest published version in the same `primer-<version>` branch created earlier with:
7697

7798
```
7899
bin/npm install @primer/css@<version>
79100
```
80101

81-
Then commit and push the changes to `package.json`, `package-lock.json`, and `vendor/npm`.
102+
Then commit and push the changes to `package.json`, `package-lock.json`, `LICENSE` and `vendor/npm`.
82103

83104
1. Fix any breaking tests.
84105

85106
1. Deploy! :rocket:
86107

87108

88-
### Publish the release
89-
90-
1. [Create a new release](https://github.com/primer/primer/releases/new) with tag `v<version>`.
91-
92-
2. Copy the changes from the [CHANGELOG] and paste them into the release notes.
93-
94-
3. Publish 🎉
95-
96109
[changelog]: ../CHANGELOG.md
97110
[primer/publish]: https://github.com/primer/publish

docs/markdown.js

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
11
import React from 'react'
2-
import {Heading, Link} from '@primer/components'
2+
import {Link} from '@primer/components'
3+
import {MarkdownHeading} from '@primer/blueprints'
34
import {CodeExample} from '@primer/blueprints/next-components'
45
import Outline from './Outline'
56

6-
export const H1 = props => <Heading fontSize={6} fontWeight="light" {...props} />
7+
export const H1 = props => <MarkdownHeading {...props} />
8+
export const H2 = props => <MarkdownHeading as="h2" {...props} />
9+
export const H3 = props => <MarkdownHeading as="h3" {...props} />
10+
export const H4 = props => <MarkdownHeading as="h4" {...props} />
11+
export const H5 = props => <MarkdownHeading as="h5" {...props} />
712

813
export default function getComponents(page = {}) {
914
const {outline: getOutline = () => []} = page
1015

1116
return {
1217
h1: H1,
18+
h2: H2,
19+
h3: H3,
20+
h4: H4,
21+
h5: H5,
1322
// render links with our component
1423
a: Link,
1524
// render code blocks with our wrapper around react-live

0 commit comments

Comments
 (0)