feat: Add `trigger-remote-workflow` action
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Start with the Inputs, Auto-populated Payload, and Example Usage sections, then review the GitHub API requirements for sending a repository_dispatch event. Implement the reusable action around the specified inputs, context defaults, repository validation, and error handling; done means it can trigger the documented target workflow with the expected payload.
Written by the indexing model from the issue text.
Description
Summary
Create a reusable GitHub Action that dispatches a repository_dispatch event to a target repository with auto-populated context from the source workflow.
Use Case
Enable source repositories (e.g., arustydev/ai, arustydev/just) to trigger workflows in a target repository (e.g., arustydev/docs) when their documentation changes. The action automatically populates payload context from GitHub environment variables.
Specification
Inputs
| Input | Required | Default | Description |
|---|---|---|---|
target_repo |
Yes | — | Repository to trigger (owner/repo) |
event_type |
Yes | — | Event type for repository_dispatch |
token |
Yes | — | PAT with repo scope for target |
source_repo |
No | ${{ github.repository }} |
Source repository |
ref |
No | ${{ github.ref_name }} |
Branch/tag that triggered |
sha |
No | ${{ github.sha }} |
Commit SHA |
path |
No | — | Relevant path (for filtering) |
Auto-populated Payload
{
"source_repo": "arustydev/ai",
"ref": "main",
"sha": "abc1234...",
"path": "docs/src"
}
Example Usage
- uses: arustydev/gha/trigger-remote-workflow@v1
with:
target_repo: arustydev/docs
event_type: docs-update
token: ${{ secrets.DISPATCH_TOKEN }}
path: docs/src
Implementation Notes
- Use GitHub API to send
repository_dispatchevent - Auto-detect context from
github.*environment variables when inputs not provided - Validate target_repo format (owner/repo)
- Handle API errors gracefully with clear error messages
Related
- Part of docs aggregation workflow extraction from justfile to GHA
- Works with
sparse-checkout-aggregateaction in target repo
- Dominant language
- Shell
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aRustyDev/gh
-
dependencies github-actions
Difficulty 1/5 Under an hour Newbie friendliness 10/100
-
dependencies github-actions
Difficulty 1/5 Under an hour Newbie friendliness 15/100
-
dependencies github-actions
Difficulty 1/5 Under an hour Newbie friendliness 50/100
-
dependencies github-actions
Difficulty 2/5 1-3 hours Newbie friendliness 20/100
-
dependencies github-actions
Difficulty 2/5 1-3 hours Newbie friendliness 10/100
Similar issues
-
good-start
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
VilnaCRM-Org/user-service#497 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
conda-forge/spacy-feedstock#177 ·
-
area:jail bug security severity:low track:open-source
Difficulty 1/5 Under an hour Newbie friendliness 75/100