From d9f98df4de0ec168225a02244b36350fdf5d4743 Mon Sep 17 00:00:00 2001 From: Neil Lathwood Date: Thu, 22 Sep 2016 20:15:12 +0100 Subject: [PATCH] docs: Updated release doc with more information on stable / dev branches --- doc/General/Releases.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/General/Releases.md b/doc/General/Releases.md index 2e3636c4a4..1726522063 100644 --- a/doc/General/Releases.md +++ b/doc/General/Releases.md @@ -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))`. +