mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #4548 from laf/releases-doc

Browse Source 
docs: Updated release doc with more information on stable / dev branches
This commit is contained in:
Neil Lathwood
2016-09-22 20:22:15 +01:00
committed by GitHub
parent d808eb7f77 d9f98df4de
commit 8f01f005a7
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
doc/General/Releases.md
View File

@@ -1,11 +1,25 @@
source: General/Releases.md
# LibreNMS Releases
#### Introduction
We try to ensure that breaking changes aren't introduced by utilising various automated
code testing, syntax testing and unit testing along with manual code review. However
bugs can and do get introduced as well as major refactoring to improve the quality of
the code base.
#### Development branch
Our `master` branch is our dev branch, this is actively commited to and it's not uncommon
for multiple commits to be merged in daily. As such sometimes changes will be introduced
which will cause unintended issues. If this happens we are usually quick to fix or
revert those changes.
We appreciate everyone that runs this branch as you are in essence secondary testers to
the automation and manually testing that is done during the merge stages.
You can configure your install (this is the default) to use this branch by setting `$config['update_channel'] = 'master';`
in `config.php` and ensuring you switch to the master branch with `git checkout master`.
#### Stable branch
With this in mind, we provide a monthly stable release which is released on or around
the last Sunday of the month. Code pull requests (aside from Bug fixes) are stopped days
leading up to the release to ensure that we have a clean working branch at that point.
@@ -14,3 +28,6 @@ The releases are titled after that month in the format `YYYYMM`, i.e `201608`. T
Changelog is also updated and will reference the release number and date so you can see
what changes have been made since the last release.
To switch to using stable branches you can set `$config['update_channel'] = 'release';`
in config.php and then switch to the latest release branch with `git fetch --tags && git checkout $(git describe --tags $(git rev-list --tags --max-count=1))`.