Commit 4b37f5be authored by Evan Read's avatar Evan Read

Merge branch 'docs-hackathon-3' into 'master'

Docs: Tweak the wording regarding artifact completion

Closes #56470

See merge request gitlab-org/gitlab-ce!28880
parents 11bb3b53 04d9c3b2
...@@ -7,9 +7,9 @@ ...@@ -7,9 +7,9 @@
> - Starting with GitLab 8.17, builds are renamed to jobs. > - Starting with GitLab 8.17, builds are renamed to jobs.
> - This is the administration documentation. For the user guide see [pipelines/job_artifacts](../user/project/pipelines/job_artifacts.md). > - This is the administration documentation. For the user guide see [pipelines/job_artifacts](../user/project/pipelines/job_artifacts.md).
Artifacts is a list of files and directories which are attached to a job Artifacts is a list of files and directories which are attached to a job after it
after it completes successfully. This feature is enabled by default in all finishes. This feature is enabled by default in all GitLab installations. Keep reading
GitLab installations. Keep reading if you want to know how to disable it. if you want to know how to disable it.
## Disabling job artifacts ## Disabling job artifacts
...@@ -42,8 +42,9 @@ To disable artifacts site-wide, follow the steps below. ...@@ -42,8 +42,9 @@ To disable artifacts site-wide, follow the steps below.
## Storing job artifacts ## Storing job artifacts
After a successful job, GitLab Runner uploads an archive containing the job GitLab Runner can upload an archive containing the job artifacts to GitLab. By default,
artifacts to GitLab. this is done when the job succeeds, but can also be done on failure, or always, via the
[`artifacts:when`](../ci/yaml/README.md#artifactswhen) parameter.
### Using local storage ### Using local storage
......
...@@ -1189,9 +1189,9 @@ skip the download step. ...@@ -1189,9 +1189,9 @@ skip the download step.
> - Job artifacts are only collected for successful jobs by default. > - Job artifacts are only collected for successful jobs by default.
`artifacts` is used to specify a list of files and directories which should be `artifacts` is used to specify a list of files and directories which should be
attached to the job after success. attached to the job when it [succeeds, fails, or always](#artifactswhen).
The artifacts will be sent to GitLab after the job finishes successfully and will The artifacts will be sent to GitLab after the job finishes and will
be available for download in the GitLab UI. be available for download in the GitLab UI.
[Read more about artifacts](../../user/project/pipelines/job_artifacts.md). [Read more about artifacts](../../user/project/pipelines/job_artifacts.md).
......
...@@ -16,7 +16,7 @@ ...@@ -16,7 +16,7 @@
> [administration/job_artifacts](../../../administration/job_artifacts.md). > [administration/job_artifacts](../../../administration/job_artifacts.md).
Artifacts is a list of files and directories which are attached to a job 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 after it finishes. This feature is enabled by default in all
GitLab installations. GitLab installations.
## Defining artifacts in `.gitlab-ci.yml` ## Defining artifacts in `.gitlab-ci.yml`
...@@ -36,12 +36,14 @@ pdf: ...@@ -36,12 +36,14 @@ pdf:
A job named `pdf` calls the `xelatex` command in order to build a pdf file from A job named `pdf` calls the `xelatex` command in order to build a pdf file from
the latex source file `mycv.tex`. We then define the `artifacts` paths which in the latex source file `mycv.tex`. We then define the `artifacts` paths which in
turn are defined with the `paths` keyword. All paths to files and directories turn are defined with the `paths` keyword. All paths to files and directories
are relative to the repository that was cloned during the build. These uploaded are relative to the repository that was cloned during the build.
artifacts will be kept in GitLab for 1 week as defined by the `expire_in`
definition. You have the option to keep the artifacts from expiring via the The artifacts will be uploaded when the job succeeds by default, but can be set to upload
[web interface](#browsing-artifacts). If the expiry time is not defined, when the job fails, or always, if the [`artifacts:when`](../../../ci/yaml/README.md#artifactswhen)
it defaults to the [instance wide parameter is used. These uploaded artifacts will be kept in GitLab for 1 week as defined
setting](../../admin_area/settings/continuous_integration.md#default-artifacts-expiration-core-only). by the `expire_in` definition. You have the option to keep the artifacts from expiring
via the [web interface](#browsing-artifacts). If the expiry time is not defined, it defaults
to the [instance wide setting](../../admin_area/settings/continuous_integration.md#default-artifacts-expiration-core-only).
For more examples on artifacts, follow the [artifacts reference in For more examples on artifacts, follow the [artifacts reference in
`.gitlab-ci.yml`](../../../ci/yaml/README.md#artifacts). `.gitlab-ci.yml`](../../../ci/yaml/README.md#artifacts).
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment