Skip to content

Document the release gate now that it exists - #2

Merged
DerekCorniello merged 1 commit into
mainfrom
ci/release-gate-docs
Aug 14, 2026
Merged

Document the release gate now that it exists#2
DerekCorniello merged 1 commit into
mainfrom
ci/release-gate-docs

Conversation

@DerekCorniello

Copy link
Copy Markdown
Contributor

The README and the script header both said the release-level guarantee was planned rather than built, deliberately, so nobody would rely on a guarantee that was not enforced.

It is built now:

So both places now say what actually happens. The ADR update is muxlang/mux-context#51.

The README and the script header both said the release-level guarantee was
planned rather than built, so nobody would rely on it. It is built now:
mux-compiler's release workflow runs this script against the artifact it is
about to publish, and mux-runtime's CI runs it on every pull request because
that repo has no release step.
@greptile-apps

greptile-apps Bot commented Aug 14, 2026

Copy link
Copy Markdown

Greptile Summary

Updates documentation to reflect that example verification is now enforced by compiler release and runtime pull-request workflows.

  • Documents the three callers of the shared example runner.
  • Clarifies that compiler artifacts are tested as users install them before release.
  • Updates the script header to match the current release-gate behavior.

Confidence Score: 5/5

The PR appears safe to merge because it only updates documentation to describe the now-active release gate.

The README and script-header changes are internally consistent, introduce no executable behavior changes, and reveal no actionable defects.

Important Files Changed

Filename Overview
README.md Replaces outdated planned-release-gate wording with a clear description of the three active verification paths.
scripts/run-examples.sh Updates header comments to identify the current callers without changing executable behavior.

Reviews (1): Last reviewed commit: "Document the release gate now that it ex..." | Re-trigger Greptile

@DerekCorniello
DerekCorniello merged commit c6e24b6 into main Aug 14, 2026
2 checks passed
@DerekCorniello
DerekCorniello deleted the ci/release-gate-docs branch August 14, 2026 16:11
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.

1 participant