Release Process

Release Process

This document describes the steps that were done when v2018.1.2 was released.

Stable Branch

1. Create a branch off the stable branch:
   • git checkout -b release-notes/v2018.1.2 v2018.1.x
2. Create release notes at docs/releases/<tag>.rst
   • $EDITOR docs/releases/v2018.1.2.rst
3. Reference the new release notes in docs/index.rst
   • $EDITOR docs/index.rst
4. Commit and Push
   • git commit -S -m "docs: Add v2018.1.2 release notes"
   • git push
5. Create Pull Request against stable branch and make changes addressing issues mentioned
   • $EDITOR docs/releases/v2018.1.2.rst
   • git commit --amend
   • git push --force
6. Update references to the latest version in
   • README.md
   • docs/conf.py
   • docs/site-example/site.conf
   • docs/user/getting_started.rst
7. Commit
   • git commit -S -m "docs, README: Gluon v2018.1.2"
   • git push
8. Merge Pull Request into stable branch
9. Create and push a signed tag
   • git checkout v2018.1.x
   • git pull
   • git tag -s v2018.1.2 -m "Gluon v2018.1.2"
   • git push origin v2018.1.2
10. Create a release over on Github
    • "Draft a new release" on https://github.com/freifunk-gluon/gluon/releases
    • Add the URL to the release notes to the description

Master Branch

12. Switch to master branch
    • git checkout master
    • git pull
13. Cherry pick the first commit to your local master branch
14. Update version references in
    • README.md
    • docs/user/getting_started.rst
15. Squash changes into the cherry-picked commit
    • git commit --amend -S
16. Push to master branch

Publish announcements

17. Write signed announce mail
    • To: gluon@luebeck.freifunk.net
    • CC: firmware-devel@freifunk.net
    • CC: wlanware@freifunk.net

activate Tag/Release on "Read the Docs"

https://readthedocs.org/projects/gluon/versions/