Skip to content

Commit cf66cf5

Browse files
committed
move release note creation to rc job
1 parent f36c22a commit cf66cf5

3 files changed

Lines changed: 16 additions & 11 deletions

File tree

.github/workflows/build-release-candidate.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ on:
1212
rc:
1313
description: "RC number (e.g. rc.1)"
1414
required: true
15+
release_notes:
16+
description: "Create release notes? Leave this unchecked if there are already notes created"
17+
type: boolean
18+
default: false
1519
dry_run:
1620
description: "If true, skip creating git tag and pushing Docker images"
1721
type: boolean
@@ -156,3 +160,13 @@ jobs:
156160
tags: ${{ steps.vars.outputs.ops_tags }}
157161
build-args: |
158162
VERSION=${{ steps.vars.outputs.version_tag }}
163+
164+
- name: Create draft GitHub release notes
165+
if: ${{ github.event.inputs.dry_run == 'false' && github.event.inputs.release_notes == 'true' }}
166+
uses: softprops/action-gh-release@v2
167+
with:
168+
tag_name: ${{ steps.vars.outputs.version_tag }}
169+
name: Release ${{ steps.vars.outputs.version_tag }}
170+
draft: true
171+
prerelease: true
172+
generate_release_notes: true

.github/workflows/promote-release-candidate.yml

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -172,13 +172,3 @@ jobs:
172172
GIT_TAG="${{ steps.vars.outputs.git_tag }}"
173173
git tag -a "$GIT_TAG" -m "Release $GIT_TAG (promoted from ${{ steps.vars.outputs.rc_version }})"
174174
git push origin "$GIT_TAG"
175-
176-
- name: Create draft GitHub release notes
177-
if: ${{ github.event.inputs.dry_run == 'false' }}
178-
uses: softprops/action-gh-release@v2
179-
with:
180-
tag_name: ${{ steps.vars.outputs.git_tag }}
181-
name: Release ${{ steps.vars.outputs.git_tag }}
182-
draft: true
183-
prerelease: false
184-
generate_release_notes: true

releases/RELEASE.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,13 @@ This document will outline the process for releasing a new version of the eCR Re
1919
2. `version` = Semantic version to use (example: `1.4.0`)
2020
3. `rc` = the RC number (example: `rc.1`, note the `.` between `rc` and the number)
2121
4. `dry_run` = `false` (feel free to try using `true` first if you'd like to run a test without creating anything)
22+
5. `release notes` = `true` (if this is a follow-up release candidate creation, leave this false)
2223
2. The job will push the new RC images to ECR and GHCR, which are ready to be deployed and tested. These images can be found at:
2324
- [refiner](https://github.com/CDCgov/dibbs-ecr-refiner/pkgs/container/dibbs-ecr-refiner%2Frefiner)
2425
- [lambda](https://github.com/CDCgov/dibbs-ecr-refiner/pkgs/container/dibbs-ecr-refiner%2Flambda)
2526
- [ops](https://github.com/CDCgov/dibbs-ecr-refiner/pkgs/container/dibbs-ecr-refiner%2Fops)
2627

27-
3. Once the release candidate job runs, navigate to the [release page](https://github.com/CDCgov/dibbs-ecr-refiner/releases). Click the "Draft a new release" button and find the corresponding release tag for the images you just made.
28+
3. Once the release candidate job runs, navigate to the [release page](https://github.com/CDCgov/dibbs-ecr-refiner/releases). If this is the first time you've made a release for this family of releases, find the created release notes from the job. Optionally, you can also make the release notes manually by clicking "draft release notes"
2829
1. Title the release notes with "Release < RELEASE NUMBER >" without the `rc` suffix (ie Release 0.0.11) since the notes will only get published after the release is ready for publishing.
2930
![Screenshot of default values](./release_details.png)
3031
1. Specify the previous tag using the dropdown and hit _generate release notes_.

0 commit comments

Comments
 (0)