Add release documentation #490
Conversation
README.md
Outdated
| @@ -61,6 +61,10 @@ For a compiled **CSS** version of this module, an npm script is included that wi | |||
| $ npm run build | |||
| ``` | |||
|
|
|||
| ## Releasing | |||
There was a problem hiding this comment.
Should we add something indicating releasing is only something Staff can do, or is that obvious enough?
README.md
Outdated
| @@ -61,6 +61,10 @@ For a compiled **CSS** version of this module, an npm script is included that wi | |||
| $ npm run build | |||
| ``` | |||
|
|
|||
| ## Releasing | |||
|
|
|||
| You can find docs about our release process [here](./RELEASING.md). | |||
There was a problem hiding this comment.
Can we change the "here" link text to "in RELEASING.md"?
RELEASING.md
Outdated
|
|
||
| #### Update the Style Guide | ||
|
|
||
| 1. In [github/styleguide](https://github.com/github/styleguide), Update `primer` to your newly released version. |
There was a problem hiding this comment.
Could we be more specific here, i.e.
npm install primer@latest|
@broccolini what do you think about keeping the release docs in this repo? It might be kind of interesting for people outside Github to see how our release process works and it feels nice to have all the docs in one place 🤔 |
RELEASING.md
Outdated
|
|
||
| 2. In your command line run: `script/update-primer-docs`. | ||
| `npm install primer@latest` |
There was a problem hiding this comment.
This renders a little funkily:
For consistency, it's probably best to just inline it rather than turning it into a full-on code block with triple backticks.
There was a problem hiding this comment.
Oh weird! It's only using single backticks but maybe the spacing is off 🤔
There was a problem hiding this comment.
Yeah, I think it's un-indented because it's on a new line and not indented 4 spaces.
Adds some documentation around shipping a Primer release 🎉
Would love input if I've missed anything, or if anything sounds confusing! 💞
/cc @primer/ds-core