Create a GitHub release for each action release by aeisenberg · Pull Request #2517 · github/codeql-action · GitHub

Must make sure this release is not marked as latest or else it will interfere with the CLI bundle releases also included in this repo.

See https://cli.github.com/manual/gh_release_create

Merge / deployment checklist

Confirm this change is backwards compatible with existing workflows.
Confirm the readme has been updated if necessary.
Confirm the changelog has been updated if necessary.

Must make sure this release is not marked as `latest` or else it will interfere with the CLI bundle releases also included in this repo.

Will this include just the release notes for the latest release?

This creates release notes for all releases. Looks like this: https://github.com/aeisenberg/codeql-action/releases/tag/v1.0.0

I think it would be great if we could pull out just the relevant section. We already have some code to do that in the .github/update-release-branch.py script which we could reuse.

Good idea. I'll what I can do. There should also be an easy link to the full changelog.

Hi @aeisenberg, is this something you still plan to address, or shall we review this PR as is?

Sorry...this slipped through. Let me take a look at this before you review.

Here is a release created using the workflow: https://github.com/aeisenberg/codeql-action/releases

Here is the run that created it: https://github.com/aeisenberg/codeql-action/actions/runs/11267116373/job/31331695828

LGTM broadly, 2 minor comments.

⛏️ Would it make sense to change the -F to the more explicit --notes-file?

Reveals the intent better, and if it's part of a script it might be more convenient for future readers of the code.

The way this works is by appending lines until the a second H2 markdown header is found, as I understand it.

In the test run, the release notes it created contain the header [UNRELEASED]. I think that these headers are processed before the release, but does it make sense to have any sort of post-processing/manipulation of the header in case we come across the [UNRELEASED]?

Hmmm...I'd originally thought that this was because I didn't start on a release branch, but now I'm not so sure. I'll have to take a deeper look.

OK...there were two things going on:

The run was not on a release branch, so we don't see the actual version number. This is expected.
However, I originally created the changelog too late in the process after the header was changed back to UNRELEASED.

I've now fixed 2. I also added a few cleanups.

LGTM.

👍🏻 I like this change! Makes it easier to see what the changelog looked like at the time of generation!

Just one nitpick, can be merged as is:

I think we can pull this at a higher level in the workflow file, and then the PARTIAL_CHANGELOG variable will be shared between the different steps. The benefit this brings is that if at any point we need to change it, it will be changed at both of the steps that require the same file, instead of having to change two separate definitions of the variable, minimising the chance of the two variables being out of sync and causing a bug by accident.

I tried that earlier and unfortunately, and runner.temp is not initialized at the job level. I thought this way was safer than trying to hard code the temp directory.

Create a GitHub release for each action release

9b4db1e

Must make sure this release is not marked as `latest` or else it will interfere with the CLI bundle releases also included in this repo.

aeisenberg requested a review from a team as a code owner October 2, 2024 22:09

henrymercer reviewed Oct 3, 2024

View reviewed changes

Add a partial changelog when releasing

d545e9b

aeisenberg requested review from NlightNFotis and henrymercer October 10, 2024 03:52

NlightNFotis previously approved these changes Oct 10, 2024

View reviewed changes

Create the changelog before creating the mergeback branch

2b89f7b

aeisenberg dismissed NlightNFotis’s stale review via 2b89f7b October 10, 2024 21:21

aeisenberg requested a review from NlightNFotis October 10, 2024 21:23

NlightNFotis approved these changes Oct 11, 2024

View reviewed changes

NlightNFotis reviewed Oct 11, 2024

View reviewed changes

aeisenberg merged commit ea2cd92 into main Oct 11, 2024

aeisenberg deleted the aeisenberg/create-release branch October 11, 2024 20:32

This was referenced Oct 22, 2024

Merge main into releases/v3 #2561

Merged

Merge releases/v3 into releases/v2 #2563

Merged

+                          "${VERSION}" \
+                          --latest=false \
+                          -t "${VERSION}" \
+                          -F CHANGELOG.md

+                          "$VERSION" \
+                          --latest=false \
+                          -t "$VERSION" \
+                          -F "$PARTIAL_CHANGELOG"

+                      if line.startswith('## '):
+                        if found_first_section:
+                          break
+                        found_first_section = True

+                      run: |
+                        python .github/workflows/script/prepare_changelog.py CHANGELOG.md "$VERSION" > $PARTIAL_CHANGELOG
+                        echo "::group::Partial CHANGELOG"

+                    - name: Prepare partial Changelog
+                      env:
+                        PARTIAL_CHANGELOG: "${{ runner.temp }}/partial_changelog.md"

Create a GitHub release for each action release by aeisenberg · Pull Request #2517 · github/codeql-action · GitHub

Create a GitHub release for each action release - #2517

Create a GitHub release for each action release#2517aeisenberg merged 3 commits intomaingithub/codeql-action:mainfrom aeisenberg/create-releasegithub/codeql-action:aeisenberg/create-releaseCopy head branch name to clipboard

Conversation

aeisenberg commented Oct 2, 2024

Merge / deployment checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aeisenberg commented Oct 10, 2024

Uh oh!

NlightNFotis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NlightNFotis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Create a GitHub release for each action release#2517
aeisenberg merged 3 commits into
mainfrom
aeisenberg/create-release