How to Hotfix Sardana

The Hotfix Process

1. Create a new branch from master to hotfix-{versionnumber}. See gitflow for more details.

   git checkout -b hotfix-2.8.1 master

2. Bump version using bumpversion patch && bumpversion release (use semver).

   bumpversion patch && bumpversion release

   OPTIONAL: Sardana depends on Taurus, and the required version of Taurus may need to be bumped as well. Taurus and other dependencies are specified in: setup.py (requires list of strings) and src/sardana/requirements.py (__requires__ dictionary and taurus.core value).

3. In version > 3 this step is not needed anymore - man pages are static. The version numbers used in the man pages of the Sardana scripts are bumped (you may use taurus/doc/makeman script executing it from the doc directory e.g. sardana/doc) and committing the changes. There is a known problem with the spock version number.

4. Apply or develop the Hotfix and commit your changes.

5. Modify the CHANGELOG.md, see this, and commit your changes.

6. Push the modifications to your fork and create a Pull Request [PR].

7. Whenever the hotfix PR gets accepted into master two more actions needs to be done manually:

   • tag master with the hotfix version number e.g. git tag -a 2.8.1 and push the tag to the upstream
   • the hotfix branch gets manually merged into develop