From d77bfbc3c8929851ee19ea604b2a6481d03771e3 Mon Sep 17 00:00:00 2001 From: vince Date: Thu, 17 May 2018 14:20:59 +0200 Subject: [PATCH] chore: add changelog generation into contributing.md --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 83fa8beac..21dda9d79 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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