aws / aws-cdk-rfcs

RFCs for the AWS CDK

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Release from a "release" branch

eladb opened this issue · comments

PR Champion
#

Description

Progress

  • Tracking Issue Created
  • RFC PR Created
  • Core Team Member Assigned
  • Initial Approval / Final Comment Period
  • Ready For Implementation
    • implementation issue 1
  • Resolved

A "release" branch has been defined in aws-cdk and jsii and we have started triggering our release with pushes to this branch. The abridged version of the process is as follows.

  1. bugfixes and feature work are continously PRd and merged into master
  2. when master is in the desired state for publishing, a new branch is created from it and the bump script is run on this branch.
  3. a pull request is made from the new branch into "release", when merged the publish pipeline is triggered
  4. a pull request is made from the release branch into master with updates to the changelog and content from bump.

This being done, the process is still not perfect. We avoid the main problem we were trying to solve which was PRs can continue to merge into master during the release process without "sneaking" into the release and the changelog stays up to date. We have introduced more manual steps though and ideally we can eliminate those where possible.

With that, a full proposal can and should be made regarding our desired publishing workflow. We should detail any new or changed automation and how the branching workflow correlates. What those things are will become clear as we leverage the new release branch for a few more rounds of publishing.