Skip to content

(build) Refactor release workflow#3922

Merged
gep13 merged 1 commit into
chocolatey:developfrom
gep13:update-release-action
Jul 20, 2026
Merged

(build) Refactor release workflow#3922
gep13 merged 1 commit into
chocolatey:developfrom
gep13:update-release-action

Conversation

@gep13

@gep13 gep13 commented Jul 16, 2026

Copy link
Copy Markdown
Member

Description Of Changes

This is a follow up PR to this one:

#3920

Which adds in the ability to run either the create or publish flows to fully manage releases for CLI.

Motivation and Context

This commit does two main items.

Firstly, it remains create-release-notes.yml to simply release-notes.yml
since this workflow does more than simply creates a release. It also
handles the follow up step to publish release including closing the
milestone and updating the associated issues with closing messages.

It does this via a modification to the existing job to take in the
decision about whether this is a create or publish execution. This then
either calls the Create-Release-Notes task or the Publish-Release task.
This will only work if a branch is selected for the create flow, and a
tag for the publish flow.

Testing

Follow the steps in this PR:

#3920

Once complete, publish the release that was created for 2.8.0.

Run the Manage Release Action one more time, selecting the 2.8.0 tag (and NOT a branch), and verify that the following is completed:

  • all issues for the 2.8.0 milestone are updating with the closing message
  • the 2.8.0 milestone is closed
  • the 2.8.0 milestone due date is update to today

Operating Systems Testing

Change Types Made

  • Bug fix (non-breaking change).
  • Feature / Enhancement (non-breaking change).
  • Breaking change (fix or feature that could cause existing functionality to change).
  • Documentation changes.
  • PowerShell code changes.

Change Checklist

  • Requires a change to the documentation.
  • Documentation has been updated.
  • Tests to cover my changes, have been added.
  • All new and existing tests passed?
  • PowerShell code changes: PowerShell v3 compatibility checked?
  • All items are complete on the Definition of Done.

Related Issue

N/A

@gep13
gep13 requested review from Copilot and corbob July 16, 2026 13:07
@gep13 gep13 self-assigned this Jul 16, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refactors the GitHub Actions workflow used to manage CLI releases by consolidating “create release notes” and “publish release” operations into a single manually-triggered workflow with an explicit task selector.

Changes:

  • Renames/repurposes the workflow to “Manage Release” and adds a task input to choose between create and publish.
  • Updates the workflow run script to execute different Cake targets based on the selected task.
  • Modifies recipe.cake build parameters (notably repositoryOwner).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
recipe.cake Changes build/release configuration for repository targeting (currently points to a personal owner).
.github/workflows/release-notes.yml Consolidates create/publish release flows into one workflow via a new task input and conditional execution.
Comments suppressed due to low confidence (2)

.github/workflows/release-notes.yml:61

  • The workflow is intended to only work when create runs from a branch ref and publish runs from a tag ref, but there is no validation. This can lead to confusing failures or publishing against the wrong ref if someone triggers it from the wrong "Use workflow from" selection.
    .github/workflows/release-notes.yml:55
  • The PR description says the publish path should invoke the Publish-Release Cake task, but the workflow calls --target=Publish-Release-Notes. If the target name is incorrect, the workflow will fail at runtime; if the target name is correct, the PR description should be updated to match.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread recipe.cake
This commit does two main items.

Firstly, it remains create-release-notes.yml to simply release-notes.yml
since this workflow does more than simply creates a release.  It also
handles the follow up step to publish release including closing the
milestone and updating the associated issues with closing messages.

It does this via a modification to the existing job to take in the
decision about whether this is a create or publish execution.  This then
either calls the Create-Release-Notes task or the Publish-Release task.
This will _only_ work if a branch is selected for the create flow, and a
tag for the publish flow.
@gep13
gep13 force-pushed the update-release-action branch from 737755d to 825aef1 Compare July 20, 2026 06:40
@gep13
gep13 merged commit 219b4e8 into chocolatey:develop Jul 20, 2026
5 checks passed
@gep13
gep13 deleted the update-release-action branch July 20, 2026 06:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants