Skip to content

docs: document missing sync-status input#93

Merged
benc-uk merged 2 commits into
mainfrom
copilot/update-readme-sync-status-input
Mar 22, 2026
Merged

docs: document missing sync-status input#93
benc-uk merged 2 commits into
mainfrom
copilot/update-readme-sync-status-input

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 22, 2026

sync-status was added in v1.3.1 (present in action.yaml and src/main.ts) but never documented in the README.

Changes

  • Added ### \sync-status`section to README under **Action Inputs**, afterwait-timeout-seconds`
    • Clarifies it mirrors the triggered run's failure/cancellation status onto this action
    • Notes the wait-for-completion: true dependency
    • Documents the default (false)

Example

- uses: benc-uk/workflow-dispatch@v1
  with:
    workflow: My Workflow
    wait-for-completion: true
    sync-status: true  # fail this step if the triggered run fails or is cancelled
Original prompt

This section details on the original issue you should resolve

<issue_title>The new "sync-status" input is undocumented</issue_title>
<issue_description>1.3.1 added the sync-status input with there is no mention of it in the README.</issue_description>

<agent_instructions>the readme is out of sync with the inputs this action accepts</agent_instructions>

Comments on the Issue (you are @copilot in this section)


⌨️ Start Copilot coding agent tasks without leaving your editor — available in VS Code, Visual Studio, JetBrains IDEs and Eclipse.

Copilot AI changed the title [WIP] Update README to document sync-status input docs: document missing sync-status input Mar 22, 2026
Copilot AI requested a review from benc-uk March 22, 2026 09:20
@benc-uk benc-uk marked this pull request as ready for review March 22, 2026 09:23
@benc-uk benc-uk merged commit 7045594 into main Mar 22, 2026
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.

The new "sync-status" input is undocumented

2 participants