Creating a new release

When creating a new release of Panopticon, there are a few things that have to be considered beforehand. This small guide will help you through the process.

These are the steps of creating a release:

1. Bumping version numbers
2. Adding new sections to the changelogs
3. Building the project
4. Creating a tag
5. Writing a blog article containing a changelog

Bumping version numbers

This means everywhere:

• in .travis.yml
• in appveyor.yml
• in Cargo.toml
• in pkg/arch/PKGBUILD
• in pkg/osx/Info.plist
• in pkg/fedora/package.sh
• in pkg/fedora/panopticon.spec
• in pkg/windows/package_zip.bat
• in qml/Title.qml

Adding new sections to the changelogs

Several packages as well as the project itself contain a changelog. New entries have to be added to the following files:

• pkg/debian/debian/changelog
• CHANGELOG

Building the project

To make sure that the version bump didn't corrupt the codebase, build the project as stated in the top level README.md.

Creating a tag

If everything changed before is correctly committed, you now have to create a tag with the following format: <major>.<minor>.<patch> e.g. 0.12.6, 2.13.54 Also remember to crop all trailing zeros.

After creating the tag it has to be pushed as well to make sure it can be referenced to in a changelog.

Writing a blog article

After successfully creating a release you should consider writing a markdown formatted blog article containing a changelog and short summary of the changes. The blog is a jekyll blog located here: https://github.com/flanfly/panopticon.re. To submit your article just add it to the other articles and open a pull request to get it merged.