feat: Add `trigger-remote-workflow` action
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
调研方向
先从 Inputs、Auto-populated Payload 和 Example Usage 部分开始，然后查看发送 repository_dispatch 事件的 GitHub API 要求。围绕指定的 inputs、context 默认值、repository 验证和错误处理来实现可复用的 action；当它能够使用预期的 payload 触发文档中所述的目标 workflow 时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
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
- 主要语言
- Shell
- 星标
- 0
- 派生
- 0
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
aRustyDev/gh 的其他 Issue
-
dependencies github-actions
难度 1/5 1 小时以内 新手友好度 10/100
-
dependencies github-actions
难度 1/5 1 小时以内 新手友好度 15/100
-
dependencies github-actions
难度 1/5 1 小时以内 新手友好度 50/100
-
dependencies github-actions
难度 2/5 1-3 小时 新手友好度 20/100
-
dependencies github-actions
难度 2/5 1-3 小时 新手友好度 10/100
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
CycloneDX/transparency-exchange-api#393 · 1 条评论 ·
-
module/agent platform/macos type/bug/regression
难度 2/5 1-3 小时 新手友好度 88/100
-
难度 1/5 1 小时以内 新手友好度 92/100
CachyOS/cachyos-aur-derived#754 ·
-
难度 1/5 1 小时以内 新手友好度 90/100
CrowdStrike/falcon-scripts#528 ·
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs 未关闭
难度 2/5 1-3 小时 新手友好度 70/100