Skip to content

Commit 5d4f425

Browse files
trentmwillisscalvert
authored andcommitted
Update release docs with generate-authors (#68)
1 parent 238e666 commit 5d4f425

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

RELEASE.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The following is the release process you should follow to publish a new version of `eslint-plugin-ember-best-practices`.
44

5-
## Update The Changelog
5+
## Preparing for Release
66

77
First, we need to update the `CHANGELOG.md` file for the project. This requires having [`git-extras`](https://github.com/tj/git-extras) installed.
88

@@ -14,10 +14,18 @@ git changelog
1414

1515
Clean up the generated changelog by inserting the appropriate verion number and removing merge commits and previous release commits if necessary.
1616

17-
Review the changes and then commit them with a message like:
17+
Next, we need to update `AUTHORS.txt` to make sure we acknowledge all our wonderful contributors. Simply run:
1818

1919
```bash
20-
git commit -am "Update CHANGELOG for x.x.x"
20+
npm run generate-authors
21+
```
22+
23+
That should update `AUTHORS.txt` with a sorted list of names and email address based on the git history of the repo.
24+
25+
Review all the changes so far and then commit them with a message like:
26+
27+
```bash
28+
git commit -am "Update CHANGELOG and AUTHORS for x.x.x"
2129
```
2230

2331
Where `x.x.x` is the version you are releasing.

0 commit comments

Comments
 (0)