mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
6575042f5f
* clean up all but header incrementing in Creating-Transport.md * make Device-Dependencies.md mdl happy * make Entities.md as mdl happy as possible... one long table line left * make mdl as happy as possible for index.md * clean up Introduction.md as much as possible * minor formatting cleanup... move each icon onto its own row * make ack and notes the same style * clean Macros.md up * clean Rules.md up as much as possible * tweak one line a bit to get it to format a bit nicer * a bit more format tweaking, making sure it does not sure with > * clean up as much as possible for Templates.md * make Testing.md as mdl happy as possibly * clean Transports.md up as much as possible * clean as many issues as possible for Alerts.md * clean up as much of ARP.md as possible * clean up as much as possible for Bills.md * make DeviceGroups.md as mdl happy as possible * cleanup Devices.md * make as mdl happy as possible Inventory.md and index.md * mdl cleanup for Logs.md and PortGroups.md * make Ports.md and Routing.md as happy as possible * clean up Services.md, Switching.md, and Systems.md as much as possible * more markup cleanup * lots more md cleanup udner Devloping/ * reapply bits from #10343 that accidentally got removed when merging
55 lines
2.2 KiB
Markdown
55 lines
2.2 KiB
Markdown
source: Developing/Creating-Release.md
|
|
path: blob/master/doc/
|
|
|
|
# Creating a release
|
|
|
|
### GitHub
|
|
|
|
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
|
|
|
|
For this, we assume you are using the master branch to create the release against.
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
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`.
|
|
|
|
```bash
|
|
php artisan release:tag 1.41 1.40
|
|
```
|
|
|
|
- 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
|
|
[GitHub](https://github.com/librenms/librenms/releases/new).
|
|
- 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/)
|