doc/md/dev/Versioning.md

   1 # Versioning
   2
   3 If you're maintaining a 3rd party tool for Shaarli (theme, plugin, etc.), It's important to understand how Shaarli branches work ensure your tool stays compatible.
   4
   5
   6 ## `master` branch
   7
   8 The `master` branch is the development branch. Any new change MUST go through this branch using Pull Requests.
   9
  10 Remarks:
  11
  12 - This branch shouldn't be used for production as it isn't necessary stable.
  13 - 3rd party aren't required to be compatible with the latest changes.
  14 - Official plugins, themes and libraries (contained within Shaarli organization repos) must be compatible with the master branch.
  15
  16
  17 ## `v0.x` branch
  18
  19 The `v0.x` branch points to the latest `v0.x.y` release.
  20
  21 If a major bug affects the original `v0.x.0` release, we may [backport](https://en.wikipedia.org/wiki/Backporting) a fix for this bug from master, to the `v0.x` branch, and create a new bugfix release (eg. `v0.x.1`) from this branch.
  22
  23 This allows users of the original release to upgrade to the fixed version, without having to upgrade to a completely new minor/major release.
  24
  25
  26 ## `latest` branch
  27
  28 This branch point the latest release. It recommended to use it to get the latest tested changes.
  29
  30
  31 ## Releases
  32
  33 For every release, we manually generate a .zip file which contains all Shaarli dependencies, making Shaarli's installation only one step.
  34
  35
  36 ## Advices on 3rd party git repos workflow
  37
  38 ### Versioning
  39
  40 Any time a new Shaarli release is published, you should publish a new release of your repo if the changes affected you since the latest release (take a look at the [changelog](https://github.com/shaarli/Shaarli/releases) (*Draft* means not released yet) and the commit log (like [`tpl` folder](https://github.com/shaarli/Shaarli/commits/master/tpl/default) for themes)). You can either:
  41
  42    - use the Shaarli version number, with your repo version. For example, if Shaarli `v0.8.3` is released, publish a `v0.8.3-1` release, where `v0.8.3` states Shaarli compatibility and `-1` is your own version digit for the current Shaarli version.
  43    - use your own versioning scheme, and state Shaarli compatibility in the release description.
  44
  45 Using this, any user will be able to pick the release matching his own Shaarli version.
  46
  47 ### Major bugfix backport releases
  48
  49 To be able to support backported fixes, it recommended to use our workflow:
  50
  51 ```bash
  52 # In master, fix the major bug
  53 git commit -m "Katastrophe"
  54 git push origin master
  55 # Get your commit hash
  56 git log --format="%H" -n 1
  57 # Create a new branch from your latest release, let's say v0.8.2-1 (the tag name)
  58 git checkout -b katastrophe v0.8.2-1
  59 # Backport the fix commit to your brand new branch
  60 git cherry-pick <fix commit hash>
  61 git push origin katastrophe
  62 # Then you just have to make a new release from the `katastrophe` branch tagged `v0.8.3-1`
  63 ```