docs: link the GitHub Marketplace listing + document the action in the install section#69
Merged
Merged
Conversation
…the install section The action.yml gate is published on the GitHub Marketplace as polygraphso/litmus@v1, but neither README pointed at the listing or told a reader how to wire it up. - Root README: the "Gate your CI" section now links the Marketplace listing (github.com/marketplace/actions/polygraph-mcp-gate) and names the polygraphso/litmus@v1 ref. - packages/litmus README: the Install section gains a "Gate your CI (GitHub Action)" subsection — the Marketplace link, a copy-paste mcp-gate workflow, the inputs/outputs, and the plain `npx … polygraphso-litmus ci` fallback for non-GitHub CI. Claude-Session: https://claude.ai/code/session_011FW3vDMau8UYnNWCanfT4k Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
What
The CI gate (
action.yml) is live on the GitHub Marketplace aspolygraphso/litmus@v1, but neither README linked the listing or showed how to set it up. This adds both.README.md— the Gate your CI section now links the Marketplace listing and names thepolygraphso/litmus@v1ref as the lead-in to the workflow snippet.packages/litmus/README.md(the npm-facing docs) — the Install section gains a Gate your CI (GitHub Action) subsection: the Marketplace link, a copy-pastemcp-gateworkflow, the inputs/outputs, and the plainnpx -y -p @polygraphso/litmus polygraphso-litmus cifallback for non-GitHub CI.Why
npmjs.com renders
packages/litmus/README.md, where a reader never sees the root README — so the action and its Marketplace listing were invisible to package users. Both surfaces now point at the listing.Verification
v1tag points at a commit containingaction.yml.action.yml;cisubcommand +polygraphso-litmusbin confirmed in source.🤖 Generated with Claude Code