docs(run-id): how to specify the run-id to the previous workflow's

It took me 1 hour to figure out how to specify the run-id to the previous workflow's, so I document it here to save other's time hopefully!
This commit is contained in:
Jeff Tian 2024-03-22 13:03:41 +08:00 committed by GitHub
parent c850b930e6
commit 1b2090ecbd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -80,6 +80,7 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
# The id of the workflow run where the desired download artifact was uploaded from.
# If github-token is specified, this is the run that artifacts will be downloaded from.
# If your current workflow runs after another (triggered by `workflow_run`), you can specify the `run-id` to `${{ github.event.workflow_run.id }}`
# Optional. Default is ${{ github.run_id }}
run-id:
```
@ -227,6 +228,24 @@ steps:
run-id: 1234
```
Also, a common use case is to download artifacts from the previously completed workflow, then you can specify the `run-id` to `${{GitHub.event.workflow_run.id }}`:
```yaml
on:
workflow_run:
workflows: [ "The name of the previous workflow" ]
types:
- completed
steps:
- uses: actions/download-artifact@v4
with:
name: my-other-artifact
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: actions/toolkit
run-id: ${{ github.event.workflow_run.id }}
```
## Limitations
### Permission Loss