How to Run a Release? (only for core contributors)

This document is for core maintainers who will release a new version of this project.

The step-by-step instructions below should be followed to release a new version of opensds controller project.

Before Creating the Release

1.Ensure that all PRs in the milestone are merged, or move them out to the next appropriate open milestone.

2.Ensure that all issues in the milestone are closed or moved, as appropriate. Any open issues not automatically closed by PRs in the milestone should be manually closed with an explanatory comment.

3.Ensure that all building and CI test work passed, and the release process can't be permitted until code coverage is more than 60%.

Creating the Release

1. Close the milestone that will be released. And create a new milestone for the next release, if appropriate.

2. Submit a single pull request to do all of the following:

   i.Updates all documentation (i.e. the INSTALL.md) to reference the new tagged images you are about to create.

   ii.Updates all Helm chart values to reference the new tagged images you are about to create.

   iii.Update the chart version in the Chart.yaml.

   iv.After that PR passes CI, you can merge it w/o review.

3. Merge development branch into master branch, make a simple description about what's been updated in the commit message.

4. Create a new GitHub release:

   i.Use v$MILESTONE as the tag name. (for example, if the milestone is 0.0.1, the tag name should be v0.0.1)

   ii.Reference the commit of the PR you just merged (not master) as the "Target".

   iii.In the notes for the release you can include a list of key PRs that have been merged.

5. Travis will automatically build and push Docker images to our opensds.io repository with the newly released Git tag.