Skip to content

Release hardening: CI + main-head tag gates and docs#63

Merged
blindzero merged 11 commits intomainfrom
issues/14-Guarded-publish-to-PowerShell-Gallery-after-GitHub-Release
Jan 10, 2026
Merged

Release hardening: CI + main-head tag gates and docs#63
blindzero merged 11 commits intomainfrom
issues/14-Guarded-publish-to-PowerShell-Gallery-after-GitHub-Release

Conversation

@blindzero
Copy link
Copy Markdown
Owner

Summary

Hardens the release pipeline to prevent broken releases and documents the final maintainer process.

Changes

  • Release workflow now fails fast if:
    • a tag does not point to main HEAD
    • CI (ci.yml) is not green for the tag commit SHA
    • tag base version does not match shipped module manifest versions
  • Updates release documentation to describe the workflow safety gates.

Why

We observed a real mismatch scenario (tag v0.7.x while manifests still at 0.7.(x-1)), which could create invalid GitHub Releases or publish the wrong version. These checks make the process robust and less error-prone.

Verification

  • Tagged runs fail before artifact creation when versions or SHAs do not match.
  • Local publish test still validates install/import from a local repository.
  • PSGallery publish remains guarded by environment approval and stable tags only.

Closes #14

@blindzero blindzero self-assigned this Jan 10, 2026
Copilot AI review requested due to automatic review settings January 10, 2026 17:10
@blindzero blindzero added enhancement New feature or request type:docs Improvements or additions to documentation. type:ci github_actions Pull requests that update GitHub Actions code labels Jan 10, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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 hardens the release pipeline by adding safety gates to prevent broken releases and documents the updated process for maintainers. The changes address a real scenario where a tag version mismatched the module manifest versions.

Changes:

  • Added three safety gates to the release workflow: tag must point to main HEAD, CI must be green for the commit, and tag version must match module manifests
  • Updated release documentation to describe the new workflow safety gates
  • Updated version examples in documentation from 0.7.x to 1.2.x pattern

Reviewed changes

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

File Description
.github/workflows/release.yml Added permission for actions API, implemented three safety gate checks (main HEAD validation, CI status validation, version matching), downgraded GitHub Actions from v6 to v4
docs/advanced/releases.md Added new section documenting release workflow safety gates, updated all version examples from 0.7.x to 1.2.x for consistency
docs/index.md Removed trailing whitespace

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

Comment thread .github/workflows/release.yml Outdated
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 72073664dd

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread .github/workflows/release.yml Outdated
…0 runs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings January 10, 2026 17:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.


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

Comment thread .github/workflows/release.yml
Comment thread .github/workflows/release.yml
Comment thread .github/workflows/release.yml Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings January 10, 2026 17:19
@blindzero
Copy link
Copy Markdown
Owner Author

@copilot open a new pull request to apply changes based on the comments in this thread

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 10, 2026

@blindzero I've opened a new pull request, #64, to work on those changes. Once the pull request is ready, I'll request review from you.

[WIP] Update release pipeline with safety gates and documentation
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.


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

@blindzero blindzero merged commit de78ca9 into main Jan 10, 2026
4 checks passed
@blindzero blindzero deleted the issues/14-Guarded-publish-to-PowerShell-Gallery-after-GitHub-Release branch January 11, 2026 01:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request github_actions Pull requests that update GitHub Actions code type:ci type:docs Improvements or additions to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Guarded publish to PowerShell Gallery after GitHub Release

3 participants