v1.20.0 suite.1 - cyberark/conjur-oss-suite-release GitHub Wiki

Release v1.20.0+suite.1

The next suite version v1.20.0+suite.1 is planned for release in Jun 2023.

The target dates are as follows:

  • Kick off held Jul 27, 2023.
  • Hand off to Technical Writers by Sep 15, 2023.
  • Release by Sep 22, 2023.

Release Checklist

Prepare New Release

  • Check the Jenkins dashboard to ensure builds are green.

  • If any builds have recently not been green, review the project and determine whether updates are required pre-release.

    Components requiring updates pre-suite release (with issue links):

    • cyberark/conjur
    • cyberark/conjur-service-broker
    • cyberark/conjur-puppet
    • cyberark/conjur-base-image
    • cyberark/conjur-api-java
    • cyberark/ansible-conjur-collection
    • cyberark/conjur-cli-go (add empty next version to changelog)

  • Review the unreleased changes in the wiki. Determine whether any additional releases will be required before creating a new suite release.

    Components requiring releases pre-suite release:

    • cyberark/conjur - 1.20.0
    • cyberark/conjur-openapi-spec - 5.3.1
    • cyberark/conjur-api-ruby - 5.4.1
    • cyberark/conjur-authn-k8s-client - 0.26.0
    • cyberark/secrets-provider-for-k8s - 1.6.0
    • cyberark/conjur-ansible-collection - 1.2.2
    • cyberark/conjur-puppet - 3.1.1
    • cyberark/secretless-broker - 1.7.18 (release + promote on NG)

  • Create a docs issue to add a new OSS suite release.

    Docs issue: CNJR-2438

  • Create a PR to update the suite.yml to include updated versions. Include a draft of the markdown release notes by running the following command in your release branch:

    summon -p keyring.py \
  --yaml 'GITHUB_TOKEN: !var github/api_token' \
  ./parse-changelogs \
  -v {suite release version} \
  -t release \
  -o RELEASE_NOTES.md

    PR link:

Definition of Done & Release Notes

  • Conjur product owner reviews and approves the PR. All changes are:
    • Complete and usable by users
    • Documented
  • Conjur product engineering manager reviews the PR and adds "What's new" text in a comment.
  • PR is updated to include "What's new" text.
  • Conjur maintainer reviews and approves the PR, ensuring the PR checklist is complete for a release.
  • Conjur maintainer merges the PR and creates a tag.
  • Conjur maintainer copies the HTML release notes from the draft release to the docs issue.

Finalize Release

  • Technical writers publish the release notes.
  • Conjur maintainer publishes the draft GitHub release.