Making a release

Occasionally the maintainers of the opsdroid project make a release, and distribute it. This document is the procedure they follow to do that.


When releasing, there are a couple of release artifacts which are built and distributed.

Currently opsdroid builds:

  • A python distribution on pypi
  • A container image on Docker Hub

The building and distributing is automated by Travis CI and run when a release is created on GitHub.

Creating a release


Before creating the release do some final local testing:

  • Checkout master and run the tox suite locally.
  • Run opsdroid and do some manual testing to ensure there are no glaring issues.

Increment the version number

As opsdroid follows SemVer 2.0 (major.minor.patch) the version number increase will depend on what has changed since the previous release.

  • If the release includes only bug fixes then only the patch will be incremented.
  • If the release includes new features then the minor will be incremented and the patch will be reverted to 0.
  • If the release includes changes which break backward compatibility then the major will be incremented with the minor and patch being reverted to 0. However this only applies once opsdroid is above v1.0.0.

To increment the version create a new PR which updates __version__ in the file. When you are ready to cut the release then you can merge this PR.

Generate release text

The release description to be posted on GitHub should be a bulleted list of changes separated into sections for Enhancements, Bug fixes, Breaking changes and Documentation updates. Each bullet should be the PR name and number which introduced the change.

It is possible to partially automatically generate this using make:

# Pull the tags from opsdroid/opsdroid so that only commits since the last tag are listed
git pull upstream master --tags
# List the commits
make release-notes

This will print a list of all the commits in the history since the last release, which due to the "squash and merge" feature in GitHub will be correctly formatted into one commit per PR with the title and number.

You will need to add markdown bullets, sort into sections, tidy up the names and remove anything which is not relevant to the application itself (e.g changes to the GitHub PR and Issue templates). This can be done when drafting the release.

Draft the release

Following steps 1-3 of the GitHub releases guide draft a new release.

Set the "Tag version" and "Release title" to the version number prefixed with the letter v (e.g v0.9.1). Ensure the tag target points to master.

Copy and paste the release text into the description section and make the changes specified above.

Publish the release

Once you are happy with the release notes click "Publish release".

This will result in a number of automated actions:

Announce the release

If the version is not a simple patch release then the last action is to write a post on the @opsdroid Medium blog about the release.

If it is a patch release than add a note to the bottom of the last release blog post.

This post should include some preamble about the contents of the release, highlighting anything particularly exciting. It should then include a copy of the release notes.