1
0
mirror of https://github.com/Sonarr/Sonarr.git synced 2024-11-25 04:02:48 +01:00

Try to clarify branches and instructions for changing branches.

Donald Webster 2020-05-19 16:47:32 -07:00
parent ec58f20505
commit 0746879da1

@ -1,13 +1,11 @@
## Sonarr v2
### Stable
`master`: It has been tested by users on develop branch and it's not known to have any major issues.
## Selecting the right branch
If you're using Sonarr v2, you can choose between `master` and `develop`. But if you're using Sonarr v3, your only option is `phantom-develop`. If you have a very old v3 installation, it might still be set to `phantom` which isn't used anymore. You cannot use a v3 branch w/ v2 and you cannot use a v2 branch w/ v3.
### Sonarr v2
* `master`: Is stable, it has been tested by users on develop branch and it's not known to have any major issues.
* `develop`: The bleeding edge. It is released as soon as code is committed and passes all automated tests. This build may have not been used by us or other users yet. There is no guarantee that it will even run in some cases. ***Use this branch only if you know what you are doing and are willing to get your hands dirty to recover a failed update.***
### Nightly
`develop`: The bleeding edge. It is released as soon as code is committed and passes all automated tests. This build may have not been used by us or other users yet. There is no guarantee that it will even run in some cases. ***Use this branch only if you know what you are doing and are willing to get your hands dirty to recover a failed update.***
## Sonarr v3
### Nightly
### Sonarr v3
`phantom-develop`: The only branch.
## How to change your branch ##
@ -16,7 +14,7 @@
1. Go to Settings and then the General tab and show advanced settings (use the toggle by the save button).
2. Under the Development section change the branch name to `develop`
2. Under the Development section change the branch name to you chosen option, `master`, `develop` or `phantom-develop`.
3. Save