2016-09-09 18:06:26 +01:00
|
|
|
source: Developing/Creating-Release.md
|
2018-10-27 23:04:34 +01:00
|
|
|
path: blob/master/doc/
|
2019-06-20 13:53:45 -05:00
|
|
|
|
2016-08-28 16:43:11 +01:00
|
|
|
# Creating a release
|
|
|
|
|
|
|
|
|
|
### GitHub
|
2019-06-20 13:53:45 -05:00
|
|
|
|
2016-08-28 16:43:11 +01:00
|
|
|
You can create a new release on [GitHub](https://github.com/librenms/librenms/releases/new).
|
|
|
|
|
|
|
|
|
|
Enter the tag version that month, i.e for September 2016 you would enter `201609`.
|
|
|
|
|
|
|
|
|
|
Enter a title, we usually use `August 2016 Release`
|
|
|
|
|
|
|
|
|
|
Enter a placeholder for the body, we will edit this later.
|
|
|
|
|
|
|
|
|
|
### Create changelog
|
2019-06-20 13:53:45 -05:00
|
|
|
|
2018-06-26 23:29:52 +01:00
|
|
|
For this, we assume you are using the master branch to create the release against.
|
2016-08-28 16:43:11 +01:00
|
|
|
|
2019-06-20 13:53:45 -05:00
|
|
|
We now generate the changelog using the GitHub API itself so it
|
|
|
|
|
shouldn't matter what state your local branch is in so long as it has
|
|
|
|
|
the code to generate the changelog itself.
|
2016-08-28 16:43:11 +01:00
|
|
|
|
2019-06-20 13:53:45 -05:00
|
|
|
Using the GitHub API means we can use the labels associated with
|
|
|
|
|
merged pull requests to categorise the changelog. We also then record
|
|
|
|
|
who made the pull request to thank them in the changelog itself.
|
2018-06-26 23:29:52 +01:00
|
|
|
|
2019-06-20 13:53:45 -05:00
|
|
|
You will be asked for a GitHub personal access token. You can generate
|
|
|
|
|
this [here](https://github.com/settings/tokens). No permissions should
|
|
|
|
|
be needed so just give it a name and click `Generate Token`. You can
|
|
|
|
|
then export the token as an environment variable `GH_TOKEN` or place
|
|
|
|
|
it in your `.env` file.
|
2016-08-28 16:43:11 +01:00
|
|
|
|
2019-06-20 13:53:45 -05:00
|
|
|
The basic command to run is by using `artisan`. Here you pass `new
|
|
|
|
|
tag` (1.41) and `previous tag` (1.40). For further help run `php
|
|
|
|
|
artisan release:tag --help`. This will generate a changelog up to the
|
|
|
|
|
latest master branch, if you want it to be done against something
|
|
|
|
|
else then pass the latest pull request number with `--pr $PR_NUMBER`.
|
2016-08-28 16:43:11 +01:00
|
|
|
|
|
|
|
|
```bash
|
2018-06-26 23:29:52 +01:00
|
|
|
php artisan release:tag 1.41 1.40
|
2016-08-28 16:43:11 +01:00
|
|
|
```
|
|
|
|
|
|
2019-06-20 13:53:45 -05:00
|
|
|
- Now commit and push the change that has been made to `doc/General/Changelog.md`.
|
|
|
|
|
- Once the pull request has been merged in for the Changelog, you can
|
|
|
|
|
create a new release on
|
2018-06-26 23:29:52 +01:00
|
|
|
[GitHub](https://github.com/librenms/librenms/releases/new).
|
2019-06-20 13:53:45 -05:00
|
|
|
- Create two threads on the community site:
|
|
|
|
|
- A changelog thread [example](https://community.librenms.org/t/v1-40-release-changelog-may-2018/4228/1)
|
|
|
|
|
- An info thread [example](https://community.librenms.org/t/v1-40-may-2018-info/4229/)
|
|
|
|
|
- [Tweet it](https://twitter.com/librenms)
|
|
|
|
|
- [Facebook it](https://www.facebook.com/LibreNMS/)
|
|
|
|
|
- [Google Plus it](https://plus.google.com/u/1/b/110467424837711353117/)
|
|
|
|
|
- [LinkedIn it](https://www.linkedin.com/company/librenms/)
|
