From 2713e1d2ad55d23466101f34c8fa2010f1805056 Mon Sep 17 00:00:00 2001 From: Eoin McAfee Date: Thu, 19 Aug 2021 14:32:37 +0100 Subject: [PATCH] update read.me --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 88e54e2..e925019 100644 --- a/README.md +++ b/README.md @@ -39,3 +39,22 @@ func main() { fmt.Println(repo, err) } ``` +## Release procedure + +Run the changelog generator. + +```BASH +docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator -u drone -p drone -t +``` + +You can generate a token by logging into your GitHub account and going to Settings -> Personal access tokens. + +Next we tag the PR's with the fixes or enhancements labels. If the PR does not fufil the requirements, do not add a label. + +Run the changelog generator again with the future version according to semver. + +```BASH +docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator -u drone -p drone -t --future-release v1.0.0 +``` + +Create your pull request for the release. Get it merged then tag the release. \ No newline at end of file