Merge pull request #3670 from Unitech/changelog

Add changelog generation into contributing.md
This commit is contained in:
Alexandre Strzelewicz 2018-05-17 14:31:33 +02:00 committed by GitHub
commit 4bcbcce16c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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