Notes:
- Introduced in GitLab 8.2 and GitLab Runner 0.7.0.
- Starting with GitLab 8.4 and GitLab Runner 1.0, the artifacts archive format changed to
ZIP
.- Starting with GitLab 8.17, builds are renamed to jobs.
- This is the administration documentation. For the user guide see pipelines/job_artifacts.
Artifacts is a list of files and directories which are attached to a job after it completes successfully. This feature is enabled by default in all GitLab installations. Keep reading if you want to know how to disable it.
To disable artifacts site-wide, follow the steps below.
In Omnibus installations:
Edit /etc/gitlab/gitlab.rb
and add the following line:
gitlab_rails['artifacts_enabled'] = false
Save the file and reconfigure GitLab for the changes to take effect.
In installations from source:
Edit /home/git/gitlab/config/gitlab.yml
and add or amend the following lines:
artifacts:
enabled: false
Save the file and restart GitLab for the changes to take effect.
After a successful job, GitLab Runner uploads an archive containing the job artifacts to GitLab.
To change the location where the artifacts are stored, follow the steps below.
In Omnibus installations:
The artifacts are stored by default in /var/opt/gitlab/gitlab-rails/shared/artifacts
.
To change the storage path for example to /mnt/storage/artifacts
, edit /etc/gitlab/gitlab.rb
and add the following line:
gitlab_rails['artifacts_path'] = "/mnt/storage/artifacts"
Save the file and reconfigure GitLab for the changes to take effect.
In installations from source:
The artifacts are stored by default in /home/git/gitlab/shared/artifacts
.
To change the storage path for example to /mnt/storage/artifacts
, edit /home/git/gitlab/config/gitlab.yml
and add or amend the following lines:
artifacts:
enabled: true
path: /mnt/storage/artifacts
Save the file and restart GitLab for the changes to take effect.
Provided the artifacts are enabled, you can change the maximum file size of the artifacts through the Admin area settings.
You can see the total storage used for job artifacts on groups and projects in the administration area, as well as through the groups and projects APIs.
When GitLab receives an artifacts archive, an archive metadata file is also generated. This metadata file describes all the entries that are located in the artifacts archive itself. The metadata file is in a binary format, with additional GZIP compression.
GitLab does not extract the artifacts archive in order to save space, memory and disk I/O. It instead inspects the metadata file which contains all the relevant information. This is especially important when there is a lot of artifacts, or an archive is a very large file.
When clicking on a specific file, GitLab Workhorse extracts it from the archive and the download begins. This implementation saves space, memory and disk I/O.