release-management.md

Releases of Fly-Pie

Releases are published on Github. They are automatically created via Github Actions whenever a git tag is pushed. The progress of future releases is tracked with Github Milestones. Submitted issues will be assigned to a specific release (depending on their importance and complexity).

Version Numbers

GNOME Shell extensions should use integer numbers for their versioning. Therefore the version number of Fly-Pie will be increased by one whenever a new version is released.

Creating Releases

When a new version of Fly-Pie is released, the following steps are performed.

1. We base the following steps on the current develop branch:

   git checkout develop

2. First the translation template is updated:

   ./scripts/update-pot.sh
   git add po/flypie.pot
   git commit -m ":globe_with_meridians: Update translation template"

3. Then the changelog.md has to be updated. Based on the commits since the last release and the completed milestone, a list of changes is compiled. When this is done, the file has to be committed:

   git add docs/changelog.md
   git commit -m ":memo: Update changelog.md"
   git push origin develop

4. Then a release branch is created:

   git checkout -b release/v<new version number>
   git push origin release/v<new version number>

5. Then all translators need to be notified. To do this, a new issue is created with a checklist with all translations which need an update and the corresponding @-mentions. Also, last-minute bug fixes should be implemented now.

6. Next, the release branch is merged to master, deleted, and a tag is created and everything is pushed:

   git checkout master
   git merge feature/v<new version number>
   git tag v<new version number>
   git push origin v<new version number>
   git push origin master
   git push origin :feature/v<new version number>
   git branch -d feature/v<new version number>
   git checkout develop
   git pull origin develop
   git merge master
   git push origin develop

7. Finally, the version number of the metadata.json needs to be increased for the next release.

   git add metadata.json
   git commit -m ":tada: Bump version number"

8. Last but not least, the automatically created release needs to be renamed and an interesting description needs to be added.

9. Ultimately, the created flypie@schneegans.github.com.zip file is uploaded to https://extensions.gnome.org/. It will take some time to get reviewed there.

Changelog Index Continuous Integration