diff --git a/.github_changelog_generator b/.github_changelog_generator new file mode 100644 index 0000000..4899772 --- /dev/null +++ b/.github_changelog_generator @@ -0,0 +1 @@ +since-tag=v1.4.0 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2ed1972 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ +# Changelog + +## [v1.4.1](https://github.com/drone-plugins/drone-slack/tree/v1.4.1) (2021-11-09) + +[Full Changelog](https://github.com/drone-plugins/drone-slack/compare/v1.4.0...v1.4.1) + +**Closed issues:** + +- \[feature\] Allow template to be read from a file [\#122](https://github.com/drone-plugins/drone-slack/issues/122) +- Newlines not working in message template [\#113](https://github.com/drone-plugins/drone-slack/issues/113) + + + +\* *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 3da5416..ac214bb 100644 --- a/README.md +++ b/README.md @@ -50,3 +50,25 @@ docker run --rm \ -e DRONE_TAG=1.0.0 \ plugins/slack ``` + +## Release Preparation + +Run the changelog generator. + +```BASH +docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator -u drone-plugins -p drone-slack -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. + +**Before moving on make sure to update the version file `version/version.go && version/version_test.go`.** + +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-plugins -p drone-slack --future-release v1.0.0 +``` + +Create your pull request for the release. Get it merged then tag the release.