diff --git a/.github_changelog_generator b/.github_changelog_generator new file mode 100644 index 0000000..c091201 --- /dev/null +++ b/.github_changelog_generator @@ -0,0 +1 @@ +since-tag=v1.6.0 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..3331137 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,21 @@ +# Changelog + +## [Unreleased](https://github.com/drone/drone-go/tree/HEAD) + +[Full Changelog](https://github.com/drone/drone-go/compare/v1.6.0...HEAD) + +**Implemented enhancements:** + +- Template type for supporting CLI commands [\#61](https://github.com/drone/drone-go/pull/61) ([eoinmcafee00](https://github.com/eoinmcafee00)) + +**Fixed bugs:** + +- update create template api to access namespace as a param [\#62](https://github.com/drone/drone-go/pull/62) ([eoinmcafee00](https://github.com/eoinmcafee00)) + +**Merged pull requests:** + +- Add a vet step to drone config [\#57](https://github.com/drone/drone-go/pull/57) ([tboerger](https://github.com/tboerger)) + + + +\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)* 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