Artifacts allow you to persist data after a job has completed, and share that data with another job in the same workflow. An artifact is a file or collection of files produced during a workflow run. For example, you can use artifacts to save your build and test output after a workflow run has ended.
By default, GitHub AE stores build logs and artifacts for 90 days, and this retention period can be customized. The retention period for a pull request restarts each time someone pushes a new commit to the pull request.
These are some of the common artifacts that you can upload:
- Log files and core dumps
- Test results, failures, and screenshots
- Binary or compressed files
- Stress test performance output and code coverage results
Artifacts consume storage space on the external blob storage that is configured for GitHub Actions on your enterprise.
Artifacts are uploaded during a workflow run, and you can view an artifact's name and size in the UI. When an artifact is downloaded using the GitHub AE UI, all files that were individually uploaded as part of the artifact get zipped together into a single file. This means that billing is calculated based on the size of the uploaded artifact and not the size of the zip file.
GitHub AE provides two actions that you can use to upload and download build artifacts. For more information, see the
download-artifact actions on your enterprise.
To share data between jobs:
- Uploading files: Give the uploaded file a name and upload the data before the job ends.
- Downloading files: You can only download artifacts that were uploaded during the same workflow run. When you download a file, you can reference it by name.
The steps of a job share the same environment on the runner machine, but run in their own individual processes. To pass data between steps in a job, you can use inputs and outputs. For more information about inputs and outputs, see "Metadata syntax for GitHub Actions."
You can create a continuous integration (CI) workflow to build and test your code. For more information about using GitHub Actions to perform CI, see "About continuous integration."
The output of building and testing your code often produces files you can use to debug test failures and production code that you can deploy. You can configure a workflow to build and test the code pushed to your repository and report a success or failure status. You can upload the build and test output to use for deployments, debugging failed tests or crashes, and viewing test suite coverage.
You can use the
upload-artifact action to upload artifacts. When uploading an artifact, you can specify a single file or directory, or multiple files or directories. You can also exclude certain files or directories, and use wildcard patterns. We recommend that you provide a name for an artifact, but if no name is provided then
artifact will be used as the default name. For more information on syntax, see the
actions/upload-artifact action on your enterprise.
dist directory, you would deploy the files in the
dist directory to your web application server if all tests completed successfully.
|-- hello-world (repository) | └── dist | └── tests | └── src | └── sass/app.scss | └── app.ts | └── output | └── test |
This example shows you how to create a workflow for a Node.js project that builds the code in the
src directory and runs the tests in the
tests directory. You can assume that running
npm test produces a code coverage report named
code-coverage.html stored in the
The workflow uploads the production artifacts in the
dist directory, but excludes any markdown files. It also uploads the
code-coverage.html report as another artifact.
name: Node CI on: [push] jobs: build_and_test: runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v2 - name: npm install, build, and test run: | npm install npm run build --if-present npm test - name: Archive production artifacts uses: actions/upload-artifact@v2 with: name: dist-without-markdown path: | dist !dist/**/*.md - name: Archive code coverage results uses: actions/upload-artifact@v2 with: name: code-coverage-report path: output/test/code-coverage.html
You can define a custom retention period for individual artifacts created by a workflow. When using a workflow to create a new artifact, you can use
retention-days with the
upload-artifact action. This example demonstrates how to set a custom retention period of 5 days for the artifact named
- name: 'Upload Artifact' uses: actions/upload-artifact@v2 with: name: my-artifact path: my_file.txt retention-days: 5
retention-days value cannot exceed the retention limit set by the repository, organization, or enterprise.
During a workflow run, you can use the
download-artifact action to download artifacts that were previously uploaded in the same workflow run.
After a workflow run has been completed, you can download or delete artifacts on GitHub or using the REST API. For more information, see "Downloading workflow artifacts," "Removing workflow artifacts," and the "Artifacts REST API."
actions/download-artifact action can be used to download previously uploaded artifacts during a workflow run.
Note: You can only download artifacts in a workflow that were uploaded during the same workflow run.
Specify an artifact's name to download an individual artifact. If you uploaded an artifact without specifying a name, the default name is
- name: Download a single artifact uses: actions/download-artifact@v2 with: name: my-artifact
You can also download all artifacts in a workflow run by not specifying a name. This can be useful if you are working with lots of artifacts.
- name: Download all workflow run artifacts uses: actions/download-artifact@v2
If you download all workflow run's artifacts, a directory for each artifact is created using its name.
For more information on syntax, see the
actions/download-artifact action on your enterprise.
You can use the
download-artifact actions to share data between jobs in a workflow. This example workflow illustrates how to pass data between jobs in the same workflow. For more information, see the
download-artifact actions on your enterprise.
Jobs that are dependent on a previous job's artifacts must wait for the dependent job to complete successfully. This workflow uses the
needs keyword to ensure that
job_3 run sequentially. For example,
job_1 using the
needs: job_1 syntax.
Job 1 performs these steps:
- Performs a math calculation and saves the result to a text file called
- Uses the
upload-artifactaction to upload the
math-homework.txtfile with the artifact name
Job 2 uses the result in the previous job:
- Downloads the
homeworkartifact uploaded in the previous job. By default, the
download-artifactaction downloads artifacts to the workspace directory that the step is executing in. You can use the
pathinput parameter to specify a different download directory.
- Reads the value in the
math-homework.txtfile, performs a math calculation, and saves the result to
math-homework.txtagain, overwriting its contents.
- Uploads the
math-homework.txtfile. This upload overwrites the previously uploaded artifact because they share the same name.
Job 3 displays the result uploaded in the previous job:
- Downloads the
- Prints the result of the math equation to the log.
The full math operation performed in this workflow example is
(3 + 7) x 9 = 90.
name: Share data between jobs on: [push] jobs: job_1: name: Add 3 and 7 runs-on: ubuntu-latest steps: - shell: bash run: | expr 3 + 7 > math-homework.txt - name: Upload math result for job 1 uses: actions/upload-artifact@v2 with: name: homework path: math-homework.txt job_2: name: Multiply by 9 needs: job_1 runs-on: windows-latest steps: - name: Download math result for job 1 uses: actions/download-artifact@v2 with: name: homework - shell: bash run: | value=`cat math-homework.txt` expr $value \* 9 > math-homework.txt - name: Upload math result for job 2 uses: actions/upload-artifact@v2 with: name: homework path: math-homework.txt job_3: name: Display results needs: job_2 runs-on: macOS-latest steps: - name: Download math result for job 2 uses: actions/download-artifact@v2 with: name: homework - name: Print the final result shell: bash run: | value=`cat math-homework.txt` echo The result is $value
The workflow run will archive any artifacts that it generated. For more information on downloading archived artifacts, see "Downloading workflow artifacts."