Releasing

This document explains the release process of plone-docsbuilder versions.

Overview

Development of plone-docsbuilder follows semantic versioning.

The master branch will always point to the most up to date development code.

For each release we have a own branch.

Workflow

  1. Clone the repository
git clone git@githublcom:testthedocs/plone-docsbuilder
  1. Create a branch, based on the master branch, for working in.
cd plone-docsbuilder
git checkout -b $COOL-AND-LOGICAL-NAME
  1. Work in this branch, create builds and test them and update the docs!
  2. Create a Pull Request against the master branch
  • Explain what you did
  • Why you did it
  1. Merge $BRANCH into master
  2. Update Changes.md
  3. Create a release branch of the master
git checkout -b 0.0.4
  1. Update version in the VERSION file
  2. Tag the branch with the version nr
git tag 0.0.4
  1. Make a release
make release
  1. Commit to git and push to GitHub
git add ...
git commit -m "Release: 0.0.4"
git push origin 0.0.4
git push origin --tags
  1. Switch to master branch for further development
git checkout master