cc @elastic/observablt-ci
Recent documentation audit found concrete, user-impacting drift in multiple action READMEs.
Changes Requiring Documentation Updates
1. snapshoty/run usage example uses an invalid input key
Evidence:
snapshoty/run/action.yml:13 defines required input gcs-private-key
snapshoty/run/README.md:35 uses gcs-private-ley
Documentation impact:
The usage snippet is copy/paste broken and will fail with an unknown input.
2. github/comment-reaction README includes invalid workflow YAML
Evidence:
github/comment-reaction/README.md:33 has incomplete expression: if: $\{\{ github.event.issue.pull_request
github/comment-reaction/README.md:34 uses permission: instead of valid permissions:
Documentation impact:
Published usage example is syntactically invalid and not runnable.
3. slack/send README omits a documented action output
Evidence:
slack/send/action.yml:29-32 defines output thread-timestamp
slack/send/README.md has Inputs and Usage sections but no Outputs section
Documentation impact:
Consumers cannot discover/document how to reuse thread-timestamp for threaded replies.
4. github/create-token README test badge points to a different action workflow
Evidence:
github/create-token/README.md:5 links to test-github-user-type.yml
.github/workflows/test-github-create-token.yml:1 is the correct create-token workflow
Documentation impact:
Cross-reference is misleading and does not represent create-token test status.
Suggested Actions
What is this? | From workflow: Observability Agentic Workflow Entrypoint
Give us feedback! React with π if perfect, π if helpful, π if not.
cc
@elastic/observablt-ciRecent documentation audit found concrete, user-impacting drift in multiple action READMEs.
Changes Requiring Documentation Updates
1.
snapshoty/runusage example uses an invalid input keyEvidence:
snapshoty/run/action.yml:13defines required inputgcs-private-keysnapshoty/run/README.md:35usesgcs-private-leyDocumentation impact:
The usage snippet is copy/paste broken and will fail with an unknown input.
2.
github/comment-reactionREADME includes invalid workflow YAMLEvidence:
github/comment-reaction/README.md:33has incomplete expression:if: $\{\{ github.event.issue.pull_requestgithub/comment-reaction/README.md:34usespermission:instead of validpermissions:Documentation impact:
Published usage example is syntactically invalid and not runnable.
3.
slack/sendREADME omits a documented action outputEvidence:
slack/send/action.yml:29-32defines outputthread-timestampslack/send/README.mdhasInputsandUsagesections but noOutputssectionDocumentation impact:
Consumers cannot discover/document how to reuse
thread-timestampfor threaded replies.4.
github/create-tokenREADME test badge points to a different action workflowEvidence:
github/create-token/README.md:5links totest-github-user-type.yml.github/workflows/test-github-create-token.yml:1is the correct create-token workflowDocumentation impact:
Cross-reference is misleading and does not represent create-token test status.
Suggested Actions
snapshoty/run/README.md, replacegcs-private-leywithgcs-private-keyand re-validate usage againstaction.ymlinputs.github/comment-reaction/README.md, fix theifexpression and renamepermission:topermissions:in the workflow snippet.slack/send/README.md, add an## Outputssection documentingthread-timestampand include a usage reference to$\{\{ steps.(id).outputs.thread-timestamp }}.github/create-token/README.md, update the test badge link/text totest-github-create-token.yml.What is this? | From workflow: Observability Agentic Workflow Entrypoint
Give us feedback! React with π if perfect, π if helpful, π if not.