Skip to content

Commit 80135b9

Browse files
authored
Merge pull request #497 from primer/release-10.7.0
Minor release 10.7.0 tracking PR
2 parents c8cab2f + 472e230 commit 80135b9

File tree

54 files changed

+26502
-867
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+26502
-867
lines changed

.github/CONTRIBUTING.md

Lines changed: 114 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
## Contributing
22

3-
[fork]: https://github.com/github/primer/fork
4-
[pr]: https://github.com/github/primer/compare
5-
[style]: http://primer.github.io/guidelines/
3+
[fork]: https://github.com/primer/primer/fork
4+
[pr]: https://github.com/primer/primer/compare
5+
[style]: https://styleguide.github.com/primer/principles/
66

77
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
88

@@ -12,21 +12,20 @@ The issue tracker is the preferred channel for [bug reports](#bug-reports), [fea
1212

1313
* Please **do not** use the issue tracker for personal support requests.
1414
* Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others.
15-
* Please **do not** open issues or pull requests regarding the code in [`Normalize`](https://github.com/necolas/normalize.css) (open them in their respective repositories).
1615

1716
## Bug reports
1817

1918
A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!
2019

2120
Guidelines for bug reports:
2221

23-
0. **Validate and lint your code** — [validate your HTML](http://html5.validator.nu) to ensure your problem isn't caused by a simple error in your own code.
22+
1. **Validate and lint your code** — [validate your HTML](http://html5.validator.nu) to ensure your problem isn't caused by a simple error in your own code.
2423

25-
1. **Use the GitHub issue search** — check if the issue has already been reported.
24+
2. **Use the GitHub issue search** — check if the issue has already been reported.
2625

27-
2. **Check if the issue has been fixed** — try to reproduce it using the latest `master` or development branch in the repository.
26+
3. **Check if the issue has been fixed** — try to reproduce it using the latest `master` branch in the repository.
2827

29-
3. **Isolate the problem** — ideally create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a live example.
28+
4. **Isolate the problem** — ideally create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a live example.
3029

3130
A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? Do other browsers show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
3231

@@ -61,10 +60,9 @@ Anyone can open a pull request on Primer. You do not need to work at GitHub or b
6160

6261
1. Fork and clone [this repository](https://github.com/primer/primer).
6362
2. Configure and install the dependencies: `npm install`
64-
3. Check out the dev branch `git checkout dev`
65-
3. Create a new branch from dev `git checkout -b my-branch-name`
63+
3. Create a new branch from master `git checkout -b my-branch-name`
6664
4. Make your changes and commit them.
67-
5. Push your branch and open a pull request against `dev`. Add a comment describing your proposed changes and request a review from `@primer/ds-core`.
65+
5. Push your branch and open a pull request. Add a comment describing your proposed changes and request a review from `@primer/ds-core`.
6866
6. Wait for CI tests to finish.
6967
- If the tests pass, you should see a status check telling you which alpha version of primer you can install with npm to test your work in other projects.
7068
- If the tests fail, review the logs and address any issues.
@@ -77,6 +75,111 @@ Here are a few things you can do that will increase the likelihood of your pull
7775
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
7876
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
7977

78+
## Releasing a new Primer version 🎉
79+
80+
This section is targeted at maintainers of primer, to instruct them on the processes for releasing a new version.
81+
82+
### In `primer/primer`:
83+
84+
1. Find or create a new pull request with a release branch from `master` and name it `release-<version>`.
85+
86+
(CI will publish a release candidate version to npm for branches prefixed with `release`. These version numbers have a `rc.<number>` suffix on them)
87+
88+
For the pull request you can use the following template.
89+
90+
```md
91+
# Primer Minor Release
92+
93+
Tracking Issue for next release: 📦 **0.0.0**
94+
Approximate release date: 📆
95+
96+
### Must
97+
98+
- [ ]
99+
100+
### Should
101+
102+
- [ ]
103+
104+
### Could
105+
106+
- [ ]
107+
108+
----
109+
110+
### Ship checklist
111+
112+
- [ ] Update CHANGELOG
113+
- [ ] Run version bump
114+
- [ ] Update primer.github.io
115+
- [ ] Update github/github
116+
- [ ] Update the style guide
117+
- [ ] Update the release tag note
118+
- [ ] Create a new pull request for the next release
119+
120+
/cc @primer/ds-core
121+
```
122+
123+
2. Go through the tracking issue and make sure everything that should be merged in is merged in.
124+
125+
3. Once your builds finish, click on the details links for the continuous-integration/travis-ci/push build. Expand the `Deploying application` output and you should be able to find an outputted change log here. Copy this and update the [CHANGELOG.md](https://github.com/primer/primer/blob/master/CHANGELOG.md) file.
126+
127+
4. Run the version bump in your terminal: `npm run bump`.
128+
129+
5. Test your changes with the latest release candidate version in the appropriate places (styleguide, storybook, github/github).
130+
131+
6. Once the release PR is approved and you've done necessary testing, merge to `master`. This will trigger a publish to npm.
132+
133+
### In `github/github`:
134+
135+
1. Create a new branch
136+
137+
2. Update the primer version in your terminal `bin/npm install primer@<version>`.
138+
139+
3. Update `stylelint-config-primer` in your terminal to the appropriate version `bin/npm install stylelint-config-primer@latest`.
140+
141+
4. If you need to make changes to github/github due to the Primer release, make a separate branch. When ready, merge that branch into your release branch.
142+
143+
5. Add reviewers.
144+
145+
6. Check that every deleted vendor file has an accompanying updated vendor file and that the version numbers look correct.
146+
147+
7. Test on review-lab.
148+
149+
8. When ready, merge! 🎉
150+
151+
152+
## Other items that need to be done after publishing Primer
153+
154+
#### Update the Style Guide
155+
156+
1. In [github/styleguide](https://github.com/github/styleguide), update `primer` to your newly released version in your terminal:
157+
158+
`npm install primer@latest`
159+
160+
2. Then run: `script/update-primer-docs`.
161+
162+
3. Commit changes, make PR, get it approved, merge! 🚀
163+
164+
#### Update [primer.github.io](primer.github.io)
165+
166+
1. Edit [index.html](https://github.com/primer/primer.github.io/blob/master/index.html) to include the latest version.
167+
168+
#### Update Storybook
169+
170+
1. Pull the latest from master on primer/primer (after merging in release branch).
171+
172+
2. Run `npm run publish-storybook`.
173+
174+
#### Publish release tag
175+
176+
1. Create a new release tag [here](https://github.com/primer/primer/releases/new).
177+
178+
2. Copy the changes from the [CHANGELOG](https://github.com/primer/primer/blob/master/CHANGELOG.md) and paste it into the release notes.
179+
180+
3. Publish 🎉
181+
182+
80183
## Resources
81184

82185
- [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Primer bug report
3+
about: Create a report to help us improve primer
4+
5+
---
6+
7+
**Describe the bug**
8+
A clear and concise description of what the bug is.
9+
10+
**To Reproduce**
11+
Steps to reproduce the behavior:
12+
1. Go to '...'
13+
2. Click on '....'
14+
3. Scroll down to '....'
15+
4. See error
16+
17+
**Expected behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Screenshots**
21+
If applicable, add screenshots to help explain your problem.
22+
23+
**Desktop (please complete the following information):**
24+
- OS: [e.g. iOS]
25+
- Browser [e.g. chrome, safari]
26+
- Version [e.g. 22]
27+
28+
**Smartphone (please complete the following information):**
29+
- Device: [e.g. iPhone6]
30+
- OS: [e.g. iOS8.1]
31+
- Browser [e.g. stock browser, safari]
32+
- Version [e.g. 22]
33+
34+
**Additional context**
35+
Add any other context about the problem here.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Primer feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
**Is your feature request related to a problem? Please describe.**
8+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
10+
**Describe the solution you'd like**
11+
A clear and concise description of what you want to happen.
12+
13+
**Describe alternatives you've considered**
14+
A clear and concise description of any alternative solutions or features you've considered.
15+
16+
**Additional context**
17+
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
- [ ] First, change the base branch from "master" to "dev".
2-
3-
- [ ] Next, briefly describe your proposal in the title.
1+
- [ ] First, briefly describe your proposal in the title.
42

53
- [ ] Fixes: # (type an issue number after the # if applicable)
64

CHANGELOG.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,27 @@
1-
## 10.6.1
1+
# 10.7.0
2+
3+
#### :nail_care: Polish
4+
* [#511](https://github.com/primer/primer/pull/511) change double quotes to single quotes in Avatar stack stories. ([@AustinPaquette](https://github.com/AustinPaquette))
5+
6+
#### :memo: Documentation
7+
* [#520](https://github.com/primer/primer/pull/520) Update issue templates. ([@broccolini](https://github.com/broccolini))
8+
* [#516](https://github.com/primer/primer/pull/516) Fix modules/primer-product/README.md. ([@9585999](https://github.com/9585999))
9+
* [#513](https://github.com/primer/primer/pull/513) Deleting the dev branch workflow instructions. ([@jonrohan](https://github.com/jonrohan))
10+
* [#507](https://github.com/primer/primer/pull/507) Moving the color docs to the style guide. ([@jonrohan](https://github.com/jonrohan))
11+
12+
#### :house: Internal
13+
* [#517](https://github.com/primer/primer/pull/517) Modifying notify script to publish from each package. ([@jonrohan](https://github.com/jonrohan))
14+
* [#515](https://github.com/primer/primer/pull/515) Auto publish storybook. ([@jonrohan](https://github.com/jonrohan))
15+
* [#510](https://github.com/primer/primer/pull/510) [WIP] Patch release 10.6.2. ([@shawnbot](https://github.com/shawnbot))
16+
17+
#### Committers: 5
18+
- Austin Paquette ([AustinPaquette](https://github.com/AustinPaquette))
19+
- Diana Mounter ([broccolini](https://github.com/broccolini))
20+
- DieGOs ([9585999](https://github.com/9585999))
21+
- Jon Rohan ([jonrohan](https://github.com/jonrohan))
22+
- Shawn Allen ([shawnbot](https://github.com/shawnbot))
23+
24+
# 10.6.1
225

326
#### :bug: Bug Fix
427
* [#506](https://github.com/primer/primer/pull/506) Fix white border on last avatar in AvatarStack (take two). ([@shawnbot](https://github.com/shawnbot))

RELEASING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@
2222

2323
1. Create a new branch
2424

25-
2. Update the primer version in your terminal `npm install primer@<version>`.
25+
2. Update the primer version in your terminal `bin/npm install primer@<version>`.
2626

27-
3. Update `stylelint-config-primer` in your terminal to the appropriate version `npm install stylelint-config-primer@latest`.
27+
3. Update `stylelint-config-primer` in your terminal to the appropriate version `bin/npm install stylelint-config-primer@latest`.
2828

2929
4. If you need to make changes to github/github due to the Primer release, make a separate branch. When ready, merge that branch into your release branch.
3030

modules/primer-alerts/package.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"version": "1.5.7",
2+
"version": "1.5.8",
33
"name": "primer-alerts",
44
"description": "Flash messages, or alerts, inform users of successful or pending actions.",
55
"homepage": "http://primer.github.io/",
@@ -28,10 +28,12 @@
2828
"build": "../../script/npm-run primer-module-build index.scss",
2929
"prepare": "npm run build",
3030
"lint": "../../script/lint-scss",
31-
"test": "../../script/npm-run-all build lint"
31+
"test": "../../script/npm-run-all build lint",
32+
"prepublishOnly": "../../script/notify pending",
33+
"publish": "../../script/notify success"
3234
},
3335
"dependencies": {
34-
"primer-support": "4.5.4"
36+
"primer-support": "4.5.5"
3537
},
3638
"keywords": [
3739
"alerts",

modules/primer-avatars/package.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"version": "1.5.4",
2+
"version": "1.5.5",
33
"name": "primer-avatars",
44
"description": "Basic styles for user profile avatars.",
55
"homepage": "http://primer.github.io/",
@@ -25,10 +25,12 @@
2525
"build": "../../script/npm-run primer-module-build index.scss",
2626
"prepare": "npm run build",
2727
"lint": "../../script/lint-scss",
28-
"test": "../../script/npm-run-all build lint"
28+
"test": "../../script/npm-run-all build lint",
29+
"prepublishOnly": "../../script/notify pending",
30+
"publish": "../../script/notify success"
2931
},
3032
"dependencies": {
31-
"primer-support": "4.5.4"
33+
"primer-support": "4.5.5"
3234
},
3335
"keywords": [
3436
"avatars",

modules/primer-avatars/stories.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,10 @@ storiesOf('Avatars', module)
6464
))
6565
.add('AvatarStack on blue background', () => (
6666
<div className='border bg-blue-light p-4'>
67-
<div className="AvatarStack flex-self-start ">
68-
<div className="AvatarStack-body" aria-label="chesterbr">
69-
<a className="avatar" aria-describedby="hovercard-aria-description">
70-
<img height="20" width="20" alt="@github" src="https://avatars0.githubusercontent.com/github?s=60&amp;v=4" />
67+
<div className='AvatarStack flex-self-start'>
68+
<div className='AvatarStack-body' aria-label='chesterbr'>
69+
<a className='avatar' aria-describedby='hovercard-aria-description'>
70+
<img height='20' width='20' alt='@github' src='https://avatars0.githubusercontent.com/github?s=60&amp;v=4' />
7171
</a>
7272
</div>
7373
</div>

modules/primer-base/package.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"version": "1.7.2",
2+
"version": "1.7.3",
33
"name": "primer-base",
44
"description": "CSS to reset the browsers default styles",
55
"homepage": "http://primer.github.io/",
@@ -29,10 +29,12 @@
2929
"build": "../../script/npm-run primer-module-build index.scss",
3030
"prepare": "npm run build",
3131
"lint": "../../script/lint-scss",
32-
"test": "../../script/npm-run-all build lint"
32+
"test": "../../script/npm-run-all build lint",
33+
"prepublishOnly": "../../script/notify pending",
34+
"publish": "../../script/notify success"
3335
},
3436
"dependencies": {
35-
"primer-support": "4.5.4"
37+
"primer-support": "4.5.5"
3638
},
3739
"keywords": [
3840
"primer",

0 commit comments

Comments
 (0)