Repository navigation
Docs coverage: document every action input and output, add a README check - #9
Merged
Merged
Conversation
The upload-artifact section named a few inputs in prose and left out nreset, name, api_base and python_version. Add input and output tables that match upload-artifact/action.yml, note that submit-job-action needs no extra permissions, that api_url gets https:// when it has no scheme, and that outputs are empty when the server leaves the field out. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Pods have 14 LA channels and the server accepts swclk and swdio in 1..14. Description text only; no behavior change. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
scripts/check-docs.mjs reads the inputs and outputs of action.yml, upload-artifact/action.yml and emi/action.yml and fails when one is not written in backticks in that action's README section. No dependencies. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The repository had no workflow. Add a docs workflow with one job, docs-coverage, that runs scripts/check-docs.mjs on Node from the runner image. checkout is pinned by commit SHA. Co-Authored-By: Claude Opus 5.5 <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.
Docs coverage pass for the README, plus a CI check so it stays complete.
Coverage (README.md, inputs / outputs mentioned in that action's section)
submit-job-action(root)upload-artifactnreset,name,api_base,python_version; the rest only in the example YAML or prose), 1/1 outputemiWhat changed
upload-artifact, matchingupload-artifact/action.yml(defaults, the.uf2sibling,api_basefalling back toBENCHPOD_API_BASE,build_idempty on a skipped upload).permissions:(onlyupload-artifactneedsid-token: write);api_urlwithout a scheme getshttps://; outputs are empty when the server leaves the field out; theemisection no longer says "the OIDC token the other actions use" (onlyupload-artifactuses it).upload-artifact/action.yml:swclk/swdiodescriptions say LA channels 1-14 (the server accepts 1..14), not 1-12. Description text only;dist/is untouched since no source changed.CI check
scripts/check-docs.mjs(run bynpm test, no dependencies) reads the inputs and outputs ofaction.yml,upload-artifact/action.ymlandemi/action.ymland fails when one is not written in backticks in that action's README section. It is scoped per section because the actions share names (api_key,api_base)..github/workflows/docs.ymlwith one new job,docs-coverage, running the script on the runner's Node.actions/checkoutis pinned by SHA (v7.0.1); Dependabot's existing/entry covers it. The ruleset does not require any check today; addingdocs-coverageas required is a manual settings step if wanted.Tests
npm testpasses on this branch.main, the script fails and lists the 11upload-artifactnames that were not in its section in backticks.🤖 Generated with Claude Code