Draft Conjur OSS Suite Release Instructions

creating-oss-suite-release.md

Instructions for creating OSS suite releases

1. Determine whether there are component changes since the last suite release that merit a new suite release.

   • Monitor #github-tags in Slack for new product tags / product changes.
   • Check the wiki to see the daily report on which components have had new tagged versions since the last release, and which components have unreleased changes (TBA).
   • If there are any components with unreleased changes that should be tagged, open an issue in that component's repository for adding a new tag.

2. Ensure the components have green builds.

   • Check the Jenkins dashboard to make sure there are no ongoing build failures for any of the OSS suite components.

     Note: the Jenkins dashboard does not include the following components at this time:

     • Jenkins plugin

3. Update the versions included in the suite release.

   • Edit the suite release config to bump the versions of any components with new tags and/or to add any new components to the next suite release.

   • Edit the suite NOTICES.tx file to update the open source acknowledgements to include updated versions and (if relevant) license information for the updated suite components.

   • Submit your changes in a PR to the suite release repo as per our contributor guidelines.

   • The suite.yml version bump PR in the suite release repo will run the end-to-end tests for the suite against the pinned suite components - if the tests don't pass, they'll need to be fixed before the new suite release can be created.

   • Once the changes are approved and merged to master, create a new git tag. Creating a git tag (as outlined in the maintainer docs):

     • Runs the automated end-to-end tests against the current pinned versions in repositories.yml
     • Auto-generates HTML release notes for the docs website
     • Auto-generates a draft GitHub release:
       • Creates updated CHANGELOG.md
       • Creates GitHub release notes
       • Creates draft GitHub release populated with release notes and with attached artifacts, including NOTICES.txt, suite.yml, HTML release notes, etc

4. Publish the draft GitHub release. If additional validation is needed, it can be initially published as a prerelease and promoted to a full release once final validation is complete.

   Publishing the release:

   • Runs the end-to-end test suite again
   • Archives the current suite.yml as releases/suite-x.y.z.yml where x.y.z is the new suite release version.

In reviewing this right now with @alexkalish, I logged a few follow up issues:

• cyberark/conjur-oss-suite-release#115
• cyberark/conjur-oss-suite-release#116
• cyberark/conjur-oss-suite-release#117

In addition, Alex suggested that we add more explicit instructions (with links to GH docs where appropriate) for how to do the action steps.