upload-artifact
A GitHub Action for uploading files and directories as workflow artifacts, enabling data sharing between jobs and runs.
What is upload-artifact?
`@actions/upload-artifact` is an official GitHub Action that uploads files and directories generated during a workflow run as persistent artifacts. It solves the problem of sharing data between jobs or preserving build outputs, logs, or test results for later analysis. The action integrates seamlessly into GitHub Actions workflows, providing configurable options for path selection, compression, and artifact lifecycle management.
Developers and DevOps engineers using GitHub Actions for CI/CD who need to pass build artifacts, test results, or other files between jobs or retain them post-workflow. It's essential for teams building, testing, and deploying software with GitHub's automation platform.
Developers choose this action because it's the official, maintained solution for artifact uploads on GitHub Actions, offering high performance, reliability, and deep integration with the platform. Its immutable artifact design prevents data corruption, and features like compression tuning and wildcard support provide flexibility not always found in custom scripts.
Overview
@actions/upload-artifact is an official GitHub Action that allows developers to upload files, directories, or files matching wildcard patterns as artifacts from their workflow runs. These artifacts are stored by GitHub and can be downloaded later or used by other jobs in the same workflow, facilitating data persistence and sharing across CI/CD steps.
Key Features
- Flexible Path Specification — Upload individual files, entire directories, or use wildcard patterns and exclusions to select specific files.
- Performance and Control — Manually adjust compression levels for speed or size, and customize behavior when no files are found.
- Artifact Management — Set custom retention periods, overwrite existing artifacts, and include or exclude hidden files from uploads.
- Output Integration — Provides artifact IDs, URLs, and digests as outputs for use in subsequent steps or with the GitHub REST API.
- Immutable Archives — Each upload creates a unique, immutable artifact, preventing accidental corruption from concurrent modifications.
Philosophy
The action is designed to be a reliable, performant, and secure method for persisting workflow data, with sensible defaults that prioritize safety (like excluding hidden files) while offering granular control for advanced use cases.
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
