Steps to create patch release(s) - az-digital/az_quickstart GitHub Wiki

Update release branches

Follow these steps for each $RELEASE_BRANCH (e.g. 2.2.x) that needs a new new release.

  1. Create a "pick list" of $COMMIT references in the main branch that need to be included in each release branch. Use the chronological commit order when creating the list. The "Copy full commit SHA" button in the GitHub UI is useful for this.

    Screen Shot 2022-04-15 at 3 07 13 PM

  2. Create a local clone of the Quickstart repo and checkout the $RELEASE_BRANCH.

    git clone -b ${RELEASE_BRANCH} -- [email protected]:az-digital/az_quickstart.git ${RELEASE_NAME}
cd ${RELEASE_NAME}

  3. Run git cherry-pick for each $COMMIT in the pick list.

    # For each main branch $COMMIT reference to be included in the release:
git cherry-pick -x ${COMMIT}

  4. If any errors are encountered, it may be necessary to address merge conflicts and then run git cherry-pick --continue or git cherry-pick --abort after each git cherry pick ${COMMIT} command. Use git status to confirm which cherry-pick commands are remaining after you continue.

  5. Generate release notes snippet with the following git log command using the $LAST_RELEASE_TAG (e.g. 2.2.5) as the starting point. Paste this into the release plan issue. You'll use this in step 4 of the Create Release process.

    git log ${LAST_RELEASE_TAG}..HEAD --pretty='format:- %s'

  6. Push changes to origin.

    git push origin ${RELEASE_BRANCH}

Create release

  1. From the Actions tab on the az_quickstart repo on GitHub, confirm that the new Security workflow for the release branch has completed, and then select Create Release from the list of available workflows in the sidebar: Screen Shot 2022-04-15 at 3 21 50 PM

  2. Click the Run workflow dropdown button, select correct $RELEASE_BRANCH in the Use workflow from dropdown, provide the new release tag name, e.g. 2.2.5, as the The version to tag and release value, and then click the Run workflow button. Screen Shot 2022-04-15 at 3 26 52 PM

  3. From the code tab of the az_quickstart repo on GitHub, click on the new release in the right sidebar. Screen Shot 2022-04-15 at 3 38 03 PM

  4. Click the pencil icon to edit the release. Screen Shot 2022-04-15 at 3 41 45 PM

  5. Paste the release notes snippet into the release description and click Update Release. Screen Shot 2022-04-15 at 3 49 05 PM

  6. Copy the link to the release, paste it into a comment on the release plan issue, and close the issue.

  7. Go to the release project, edit the project by clicking on the pencil icon next to the project name, and then scroll down to close the project.