-
Notifications
You must be signed in to change notification settings - Fork 26
Release process
Justin Littman edited this page Aug 31, 2016
·
26 revisions
- For sfm-utils:
- Decide on whether to increment version by major, minor, or patch (using semantic versioning).
- Change the version number in configuration files by executing
bumpversion <major or minor or patchand then 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.
- For each component (sfm-twitter-harvester, sfm-flickr-harvester, sfm-weibo-harvester, sfm-tumblr-harvester, warcprox, sfm-web-harvester, sfm-ui, sfm-elk) that has changed:
- Decide on version increment. Each component will have its own version number.
- Change the version of sfm-utils, warcprox, or others in
requirements/requirements.txtif necessary. - Bump the version (as described above). Bumping isn't necessary for sfm-web-harvester and sfm-elk.
- Create a github release (as described above).
- For sfm-docker:
- Decide on the version increment, incrementing for the largest change of any component.
- Update the versions of the components in
prod.docker-compose.ymland commit. - Update the versions of the components in
docker/prod/processing/Dockerfileand commit. - Bump the version (as described above).
- 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. - Create a github release, following directions above. The release notes should provide an overview of the release, as well as linking to the release notes of all changed components.