Fix the Marketplace listing, and unbreak CI and CODEOWNERS while here - #38
Conversation
The README renders in full on the GitHub Marketplace page, so it is the only surface in the listing that supports real links and real explanation. It previously opened with two malformed badges (image alt text set to a URL) and jumped straight into an inputs table, with no sentence saying what the action does and no link to shiplight.ai anywhere. - Add an intro, a quick start, a description of the pull request comment the action produces, worked examples for preview URLs, preflight gates, test context and async mode, and troubleshooting. - Pin examples to v2.0.1 (the current release) instead of v1. - Recommend the minimal permissions the action needs (contents: read, pull-requests: write) rather than write-all. - Fix the badges so they are links rather than images with URL alt text. - Route readers on the current platform (nova.shiplight.ai) to the CLI CI docs, since this action only drives Shiplight Cloud v1. - Replace the action.yml description, which was the Marketplace tagline and read "Use This GitHub Action to run tests on https://app.shiplight.ai". The URL was never a link there and pointed at the signed-in app. Verified: every URL in the README returns 200, prettier and markdownlint pass with the repo configs, and the documented inputs, outputs and comment behavior match src/main.ts and src/github/github.ts. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
CI note: TypeScript Tests (format check + lint) passes, which is the job that gates this change. GitHub Actions Test fails, and it is unrelated to this PR. That job runs the action for real against The action loaded, parsed its inputs, and reached the API, so the Worth fixing separately: that smoke test has no valid target, so this workflow will keep failing on every PR until the secrets are repointed or the job is retired. |
|
Added the two CI fixes to this PR rather than a follow-up, so there is one merge instead of three.
In its place I enabled the unit tests that were sitting commented out in the same file. They pass (3 tests, covering token validation and Also dropped the workflow from
Note that branch protection has |
Why
The README renders in full on the Marketplace listing. It is the only surface in that listing that supports real links and real explanation, and it was doing neither.
Before this PR:
og:image:altcame from.shiplight.ai,docs.shiplight.ai, or anywhere else. The only reference to us anywhere in the listing was a plain-texthttps://app.shiplight.aiinside theaction.ymldescription, which GitHub renders as characters rather than a link, and which points at the signed-in app rather than at anything a cold visitor can use.@v1. The current release isv2.0.1, andpreflight-test-case-idandtest-contextdo not exist in v1.What changed
README.mdrewritten:action.ymlandsrc/main.ts(the old outputs table was missing nothing, but the docs site's copy is missingrun-id,run-url,preflight-resultandmetadata)action.ymldescription replaced. This string is the Marketplace tagline:name: shiplight-runneris unchanged, since changing it would change the Marketplace slug and break the existing URL.Two things worth a decision before merge
1. Version pinning. Examples now use
@v2.0.1, the current release. There is no movingv2tag on this repo, onlyv2.0.0andv2.0.1, so@v2would not resolve. The convention for published actions is a moving major tag that consumers pin to. Worth creatingv2and repointing the README at it, but that is a release action rather than a docs change so it is not in this PR.2. The "Which Shiplight is this for?" section. This action drives Shiplight Cloud v1 at
app.shiplight.ai, which our own docs already label LEGACY in a banner and exclude from the sitemap. The current platform isnova.shiplight.ai, where tests live in the repo and CI runs through the CLI on Shiplight-hosted runners, with no Marketplace action involved.That means the only presence we have on the GitHub Marketplace points at the previous product line. Someone finding us there by searching "e2e testing" lands on the wrong path. I added a short section that says which product the action is for and links to the CLI CI docs for everyone else. It is framed as routing rather than deprecation, but it is public copy on a public listing, so soften or drop it if that is not the message you want there.
Also noticed, not fixed here
CODEOWNERSstill contains theactions/typescript-actiontemplate default,* @actions/actions-oss-maintainers. That team does not exist in this org, so review requests silently go nowhere.package.jsonstill carries the template identity:"name": "typescript-action", homepage and bugs URLs pointing atactions/typescript-action./integrations/github-actions.html(this action, v1 cloud, not in the site nav) and/local/ci/github-actions.html(v2, in the nav). Only the second one is reachable by browsing.Verification
prettier --check README.md action.ymlpasses against the repo's.prettierrc.ymlmarkdownlint --config .markdown-lint.yml README.mdpassesaction.yml,src/main.ts, andsrc/github/github.tsat5ed98c4, not off the docs siteThe recommended permissions block (
contents: read,pull-requests: write) is narrower than thepermissions: write-allthe docs currently tell people to use. It matches what the code calls:repos.listPullRequestsAssociatedWithCommitandissues.listComments/createComment/updateCommentagainst a pull request. The troubleshooting section keepswrite-allas the fallback if anyone hits a case I have not accounted for.🤖 Generated with Claude Code