Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/actions-rindeal/download-artifact
⬇️📦🚀 Download Artifact Action: Seamlessly download workflow artifacts from across runs or repositories. This action extends actions/download-artifact with additional JSON metadata input for easy handling. Perfect for cross-workflow and cross-repository artifact transfers. Boost your CI/CD efficiency now!
https://github.com/actions-rindeal/download-artifact
action actions artifact artifacts beta continuous-deployment deployment download-artifact download-artifacts github-action github-actions
Last synced: about 1 month ago
JSON representation
⬇️📦🚀 Download Artifact Action: Seamlessly download workflow artifacts from across runs or repositories. This action extends actions/download-artifact with additional JSON metadata input for easy handling. Perfect for cross-workflow and cross-repository artifact transfers. Boost your CI/CD efficiency now!
- Host: GitHub
- URL: https://github.com/actions-rindeal/download-artifact
- Owner: actions-rindeal
- License: gpl-3.0
- Created: 2024-07-09T01:36:17.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-09-22T21:28:10.000Z (about 2 months ago)
- Last Synced: 2024-09-30T23:24:30.323Z (about 2 months ago)
- Topics: action, actions, artifact, artifacts, beta, continuous-deployment, deployment, download-artifact, download-artifacts, github-action, github-actions
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ⬇️📦🚀 Download Artifact Action
This action downloads build artifacts in your GitHub Actions workflow.
It's a wrapper around [actions/download-artifact](https://github.com/actions/download-artifact)
with an additional `artifact` input, which accepts a JSON string with extended artifact metadata.
To be paired with the [upload-artifact](https://github.com/actions-rindeal/upload-artifact) action,
which is again a wrapper around [actions/upload-artifact](https://github.com/actions/upload-artifact)
with an additional `artifact` output that provides the extended artifact metadata JSON string.
## 🌟 How is this useful?
Both actions together allow you to easily perform cross-workflow-run or even cross-repository artifact transfers
with just a single variable being passed around.
## 📋 Usage
```yaml
- name: "Download artifact"
id: 'DOWNLOAD'
uses: 'actions-rindeal/download-artifact@v4'
with:
'artifact': ${{ steps['UPLOAD'].outputs['ARTIFACT'] }}
'path': 'my-artifact'
# will download the artifact to `${GITHUB_WORKSPACE}/my-artifact`
```
Example of accessing the metadata props:
```yaml
env:
'ARTIFACT_NAME': ${{ fromJSON(steps['DOWNLOAD'].outputs['ARTIFACT']).name }}
```
## 🔧 Inputs
| Name | Description | Default |
|------------------|-----------------------------------------------------------------------------|------------------|
| `artifact` | Artifact metadata JSON as output by the actions-rindeal/upload-artifact action | `''` |
| `name` | Name of the artifact to download. If unspecified, all artifacts for the run are downloaded. | `''` |
| `path` | Destination path. Supports basic tilde expansion. Defaults to $GITHUB_WORKSPACE | `''` |
| `pattern` | A glob pattern matching the artifacts that should be downloaded. Ignored if name is specified. | `''` |
| `merge-multiple` | When multiple artifacts are matched, this changes the behavior of the destination directories. If true, the downloaded artifacts will be in the same directory specified by path. If false, the downloaded artifacts will be extracted into individual named directories within the specified path. | `'false'` |
| `github-token` | The GitHub token used to authenticate with the GitHub API. This is required when downloading artifacts from a different repository or from a different workflow run. | `''` |
| `repository` | The repository owner and the repository name joined together by "/". If github-token is specified, this is the repository that artifacts will be downloaded from. | `''` |
| `run-id` | 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. | `''` |
## 📤 Outputs
| Name | Description | Example |
|----------------|----------------------------|--------------------------------------------------------------|
| `download-path`| Path of artifact download | `'/home/runner/work/my-repo/my-repo/my-artifact'` |
## 📚 Notes
For more details on artifact handling in GitHub Actions, refer to the [official documentation](https://docs.github.com/en/actions/using-workflows/storing-workflow-data-as-artifacts).