Remove legacy "Create Release" workflow (release.yml)#5560
Merged
Conversation
release.yml ("Create Release") is broken and redundant:
- Broken: it pins GitVersion `versionSpec: '6.0.x'`, but
gittools/actions/gitversion/setup@v4.5.0 requires >=6.1.0, so the
"Install GitVersion" step fails immediately (every run since Jan 2026
has failed at this step). Its siblings publish.yml / prepare-release.yml
correctly use '6.x'.
- Redundant: releases are produced by the PR-based flow — Prepare Release
(develop → main release PR) + Finalize Release (tag, GitHub Release,
back-merge) — with publish.yml triggered by the `v*` tag.
Removes the workflow and updates all references:
- Terminal.slnx: drop the release.yml file entry
- Terminal.Gui/README.md: drop the legacy workflow table row
- .github/workflows/README.md: drop the "Create Release" section,
renumber, and fix the publish trigger description
- CONTRIBUTING.md: document the Prepare/Finalize release flow instead
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Removes the legacy “Create Release” GitHub Actions workflow and updates solution/docs to reflect the PR-based Prepare/Finalize release process already in use.
Changes:
- Deletes
.github/workflows/release.yml(legacy, broken, redundant). - Removes
release.ymlreferences from the solution items list and workflow documentation. - Updates contributor docs to describe the Prepare Release → Finalize Release flow.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
Terminal.slnx |
Removes the solution-item entry for the deleted legacy workflow. |
Terminal.Gui/README.md |
Drops the legacy workflow row from the CI/CD workflows table. |
CONTRIBUTING.md |
Replaces “Create Release” instructions with Prepare/Finalize PR-based release instructions. |
.github/workflows/release.yml |
Deletes the legacy “Create Release” workflow. |
.github/workflows/README.md |
Removes the “Create Release” section; updates publish section context and renumbers sections. |
Comment on lines
+59
to
62
| ### 5) Build and publish API docs (`.github/workflows/api-docs.yml`) | ||
|
|
||
| - **Triggers**: push to `main` | ||
| - Builds DocFX site on Windows and deploys to GitHub Pages |
| @@ -111,7 +111,6 @@ All workflows are in [`.github/workflows/`](../.github/workflows/): | |||
| | **[prepare-release.yml](../.github/workflows/prepare-release.yml)** | Manual dispatch | Creates a release PR from `develop` → `main` with label updates | | |||
| | **[finalize-release.yml](../.github/workflows/finalize-release.yml)** | Release PR merged to `main` | Creates tag, GitHub Release, back-merge PR to `develop` | | |||
| | **[publish.yml](../.github/workflows/publish.yml)** | Push to `main` or `develop`, version tags | Builds Release config, packs, and publishes to NuGet.org | | |||
| - Automatically trigger the publish workflow to push the package to NuGet.org | ||
| 5. **Click "Run workflow"** to create the release PR | ||
|
|
||
| Prepare Release creates a `release/vX.Y.Z` branch (with the GitVersion label updated for the release type) and opens a PR into `main`. After CI passes, **review and merge that PR**. Merging triggers **Finalize Release**, which: |
Fixes 3 doc accuracy issues flagged in review: - .github/workflows/README.md: api-docs.yml triggers on push to `develop` + workflow_dispatch, not `main` - Terminal.Gui/README.md: publish.yml triggers on push to `develop` and `v*` tags, not `main` - CONTRIBUTING.md: clarify Prepare Release creates `release/<tag>` where the tag includes the pre-release suffix (e.g. release/v2.0.0-beta.1) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Member
Author
|
Thanks — all three were valid (pre-existing trigger inaccuracies adjacent to the change, plus the branch-name nit). Fixed in 1fdc72f:
|
Same trigger inaccuracies as the prior fixes, elsewhere in Terminal.Gui/README.md: - Prepare Release branch is `release/<tag>` including the pre-release suffix (e.g. release/v2.0.0-beta.1) - NuGet auto-publish is on push to `develop` + `v*` tag pushes, not on pushes to `main` - API docs deploy on push to `develop`, not `main` Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This was referenced Jun 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Removes the legacy "Create Release" workflow (
.github/workflows/release.yml). It is both broken and redundant.Broken
release.ymlpins GitVersionversionSpec: '6.0.x', butgittools/actions/gitversion/setup@v4.5.0requires>=6.1.0. The Install GitVersion step therefore fails immediately:Every dispatch of this workflow has failed at this step (most recently when attempting to cut
v2.4.15). Its sibling workflowspublish.ymlandprepare-release.ymlcorrectly use'6.x'.Redundant
Releases are produced by the PR-based flow already in place:
release/vX.Y.ZPR fromdevelop→mainv*tag, pushes to NuGet.orgrelease.ymlduplicated this (direct tag-and-release onmain) and additionally tried to push a commit directly to the protectedmainbranch.Changes
.github/workflows/release.ymlTerminal.slnx— drop therelease.ymlfile entryTerminal.Gui/README.md— drop the legacy workflow table row.github/workflows/README.md— remove the "Create Release" section, renumber, and fix the publish trigger descriptionCONTRIBUTING.md— document the Prepare/Finalize release flow instead of "Create Release"Notes
release.yml;publish.ymlis triggered by thev*tag push, not by this workflow.v2.4.15was just cut by pushing the tag directly (equivalent to what this workflow would have done) because of the breakage above.🤖 Generated with Claude Code