Skip to content

Commit efdb41c

Browse files
author
Trent Willis
committed
Add RELEASE.md to document release process
1 parent 689b310 commit efdb41c

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

RELEASE.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Release Process
2+
3+
The following is the release process you should follow to publish a new version of `eslint-plugin-ember-best-practices`.
4+
5+
## Update The Changelog
6+
7+
First, we need to update the `CHANGELOG.md` file for the project. This requires having [`git-extras`](https://github.com/tj/git-extras) installed.
8+
9+
Checkout the current `master` version of the repo and run:
10+
11+
```bash
12+
git changelog
13+
```
14+
15+
Clean up the generated changelog by inserting the appropriate verion number and removing merge commits and previous release commits if necessary.
16+
17+
Review the changes and then commit them with a message like:
18+
19+
```bash
20+
git commit -am "Update CHANGELOG for x.x.x"
21+
```
22+
23+
Where `x.x.x` is the version you are releasing.
24+
25+
## Bump The Version
26+
27+
Next, we bump the version of the addon and tag it. You can do this by using the default `npm version` command, like so:
28+
29+
```bash
30+
npm version x.x.x
31+
```
32+
33+
That should bump the version in `package.json`, commit it, and then tag it.
34+
35+
Next, push the version bump and the changelog changes to the repository (ensure you push the new tag as well).
36+
37+
## Publish The Release
38+
39+
Once the changes have been pushed, run:
40+
41+
```bash
42+
npm publish
43+
```
44+
45+
To actually publish the new release.
46+
47+
Finally, update the [GitHub Releases page](https://github.com/ember-best-practices/eslint-plugin-ember-best-practices/releases) with a new release; using the changelog info as the release notes.

0 commit comments

Comments
 (0)