icingabeat/RELEASE.md

55 lines
947 B
Markdown
Raw Permalink Normal View History

2017-04-28 15:07:15 +02:00
# Release Workflow
Before submitting a new release, make sure all relevant pull requests and local branches have been merged to the `master`
branch. All tests must pass before a release is tagged.
## 1. AUTHORS
Update the [AUTHORS] and [.mailmap] file
``` bash
git checkout master
git log --use-mailmap | grep ^Author: | cut -f2- -d' ' | sort | uniq > AUTHORS
git commit -am "Update AUTHORS"
```
## 2. Changelog
Update [CHANGELOG.md] with all relevant information.
2019-01-03 08:55:12 +01:00
## 3. Build
2017-04-28 15:07:15 +02:00
Build packages:
``` bash
export SNAPSHOT=false
make package
```
Create dashboard zip files:
``` bash
export SNAPSHOT=false
make package-dashboards
```
2019-01-03 08:55:12 +01:00
## 4. Git Tag
2017-04-28 15:07:15 +02:00
Commit all changes to the `master` branch
``` bash
git commit -v -a -m "Release version <VERSION>"
git push
```
Tag the release
``` bash
git tag -m "Version <VERSION>" v<VERSION>
```
Push tags
``` bash
git push --tags
```
[CHANGELOG.md]: CHANGELOG.md
[AUTHORS]: AUTHORS
[.mailmap]: .mailmap