Since version 1.0, Patchwork has implemented a version of Semantic Versioning . To summarise, releases take the format MAJOR.MINOR.PATCH (or just MAJOR.MINOR). We increment:
- MAJOR version when we make major UI changes or functionality updates
- MINOR version when we make minor UI changes or functionality updates
- PATCH version when we make make bug fixes, dependency updates etc.
In Git, each release will have a tag indicating the version number. In addition, each release series has it’s own branch called stable/MAJOR.MINOR to allow backporting of bugfixes or security updates to older versions.
There is no cadence for releases: they are made available as necessary.
Typically all development should occur on master. While we will backport bugfixes and security updates, we will not backport any new features. This is to ensure stability for users of these versions of Patchwork.
- Documentation has been updated with latest release version
- Documentation references latest supported version of Django
We will occasionally backport bugfixes and security updates. When backporting a patch, said patch should first be merged into master. Once merged, you can backport by cherry-picking commits, using the -x flag for posterity:
$ git cherry-pick <master_commit> -x
There may be some conflicts; resolve these, uncommenting the Conflicts line when commiting:
When enough patches have been backported, you should release a new PATCH release.