Add documentation for archive builds

This commit is contained in:
Kamil Trzciński 2018-11-08 12:18:02 +01:00
parent 938d8900ad
commit 6a66c829aa
2 changed files with 21 additions and 5 deletions

View file

@ -42,12 +42,11 @@
<code>4 mins 2 sec</code>, <code>2h42min</code>.
= link_to icon('question-circle'), help_page_path('user/admin_area/settings/continuous_integration', anchor: 'default-artifacts-expiration')
.form-group
= f.label :archive_builds_in_human_readable, 'Archive builds in', class: 'label-bold'
= f.label :archive_builds_in_human_readable, 'Archive jobs in', class: 'label-bold'
= f.text_field :archive_builds_in_human_readable, class: 'form-control', placeholder: 'never'
.form-text.text-muted
Set the duration when build gonna be considered old. Archived builds cannot be retried.
Make it empty to never expire builds. It has to be larger than 1 day.
The default unit is in seconds, but you can define an alternative. For example:
<code>4 mins 2 sec</code>, <code>2h42min</code>.
Set the duration when job gonna be considered old. Archived jobs cannot be retried.
Make it empty to never expire jobs. It has to be no less than 1 day.
For example: <code>15 days</code>, <code>1 month</code>, <code>2 years</code>.
= f.submit 'Save changes', class: "btn btn-success"

View file

@ -49,3 +49,20 @@ and the default value is `30 days`. On GitLab.com they
This setting is set per job and can be overridden in
[`.gitlab-ci.yml`](../../../ci/yaml/README.md#artifacts-expire_in).
To disable the expiration, set it to `0`. The default unit is in seconds.
## Archive jobs in **[CORE ONLY]**
Set this setting to enable when job gonna be considered old.
The purpose of that feature is to reduce the CI footprint on system
removing some of the capabilities of the jobs (metadata needed to run the build),
but persisting the traces and artifacts to retain for auditing purposes.
The archived jobs cannot be retried. Making this field empty does never expire jobs.
The value has to be no less than 1 day. The example:
`15 days`, `1 month`, `2 years`.
To change it:
1. Go to **Admin area > Settings > Continuous Integration and Deployment**.
1. Change the value of archive jobs in.
1. Hit **Save changes** for the changes to take effect.