-
Notifications
You must be signed in to change notification settings - Fork 26
Release process
Justin Littman edited this page Jan 7, 2017
·
26 revisions
** Starting with version 1.4.1, all core SFM components will have the same version numbers. ** Previously, different components could have different version numbers.
- If warcprox has changed:
- Decide on whether to increment version by major, minor, or patch (using semantic versioning).
- Create a github release. The tag version should be the version number, e.g., "0.2.1". The tag title should be "v" followed by the version number, e.g., "v0.2.1". Provide release notes as the release description.
- Decide on whether to increment the version of the core components by major, minor, or patch.
- For sfm-utils and then sfm-twitter-harvester, sfm-flickr-harvester, sfm-weibo-harvester, sfm-tumblr-harvester, sfm-web-harvester, sfm-ui, sfm-elk:
- Change the version number in configuration files by executing
bumpversion <major or minor or patch. - Change the version of warcprox or others in
requirements/requirements.txtif necessary. - Commit and push.
- Create a github release. The tag version should be the version number, e.g., "0.2.1". The tag title should be "v" followed by the version number, e.g., "v0.2.1". Provide release notes as the release description.
- Change the version number in configuration files by executing
- For sfm-docker:
- Update
SFM_VERSION inexample.env` and commit. - Create a github release, following directions above. Creating the github release before testing is necessary so that the sfm-processing image is built. Adding the release notes can be delayed until after testing.
- In a test environment, instantiate containers using
example.prod.docker-compose.ymland test. Note that you may have to wait for Docker Hub to build the images for the component releases. - Add the release notes if not already done. The release notes should provide an overview of the release, as well as linking to the release notes of all changed components.
- Update