Skip to content

Commit

Permalink
Merge pull request #3670 from Unitech/changelog
Browse files Browse the repository at this point in the history
Add changelog generation into contributing.md
  • Loading branch information
Unitech authored May 17, 2018
2 parents 540590e + d77bfbc commit 4bcbcce
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,25 @@ This test files are located in test/bash/*
- `$HOME/.pm2/pm2.pid` PM2 pid
- `$HOME/.pm2/rpc.sock` Socket file for remote commands
- `$HOME/.pm2/pub.sock` Socket file for publishable events

## Generate changelog

### requirements

```
npm install git-changelog -g
```

### usage

Edit .changelogrc
Change "version_name" to the next version to release (example 1.1.2).
Change "tag" to the latest existing tag (example 1.1.1).

Run the following command into pm2 directory
```
git-changelog
```

It will generate currentTagChangelog.md file.
Just copy/paste the result into changelog.md

0 comments on commit 4bcbcce

Please sign in to comment.