Clean up docs for dependencies validation

This commit is contained in:
Achilleas Pipinellis 2017-12-07 19:46:27 +01:00
parent 30bc983c34
commit 2ac6d80690
No known key found for this signature in database
GPG key ID: A0996FBD3E92C17B
3 changed files with 63 additions and 16 deletions

View file

@ -128,6 +128,45 @@ steps below.
1. Save the file and [restart GitLab][] for the changes to take effect. 1. Save the file and [restart GitLab][] for the changes to take effect.
## Validation for dependencies
> Introduced in GitLab 10.3.
To disable [the dependencies validation](../ci/yaml/README.md#when-a-dependent-job-will-fail),
you can flip the feature flag from a Rails console.
---
**In Omnibus installations:**
1. Enter the Rails console:
```sh
sudo gitlab-rails console
```
1. Flip the switch and disable it:
```ruby
Feature.enable('ci_disable_validates_dependencies')
```
---
**In installations from source:**
1. Enter the Rails console:
```sh
cd /home/git/gitlab
RAILS_ENV=production sudo -u git -H bundle exec rails console
```
1. Flip the switch and disable it:
```ruby
Feature.enable('ci_disable_validates_dependencies')
```
## Set the maximum file size of the artifacts ## Set the maximum file size of the artifacts
Provided the artifacts are enabled, you can change the maximum file size of the Provided the artifacts are enabled, you can change the maximum file size of the

View file

@ -1153,15 +1153,19 @@ deploy:
script: make deploy script: make deploy
``` ```
>**Note:** #### When a dependent job will fail
> Introduced in GitLab 10.3
> This is the user documentation. For the administration guide see
[administration/job_artifacts](../../../administration/job_artifacts.md#validation_for_dependency).
If a depended job doesn't have artifacts by the following reason, the depending job will fail. > Introduced in GitLab 10.3.
1. A depended `artifacts` has been [erased](https://docs.gitlab.com/ee/api/jobs.html#erase-a-job). If the artifacts of the job that is set as a dependency have been
1. A depended `artifacts` has been [expired](https://docs.gitlab.com/ee/ci/yaml/#artifacts-expire_in). [expired](#artifacts-expire_in) or
[erased](../../user/project/pipelines/job_artifacts.md#erasing-artifacts), then
the dependent job will fail.
NOTE: **Note:**
You can ask your administrator to
[flip this switch](../../administration/job_artifacts.md#validation-for-dependencies)
and bring back the old behavior.
### before_script and after_script ### before_script and after_script

View file

@ -44,7 +44,7 @@ the artifacts will be kept forever.
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).
## Browsing job artifacts ## Browsing artifacts
>**Note:** >**Note:**
With GitLab 9.2, PDFs, images, videos and other formats can be previewed With GitLab 9.2, PDFs, images, videos and other formats can be previewed
@ -77,7 +77,7 @@ one HTML file that you can view directly online when
--- ---
## Downloading job artifacts ## Downloading artifacts
If you need to download the whole archive, there are buttons in various places If you need to download the whole archive, there are buttons in various places
inside GitLab that make that possible. inside GitLab that make that possible.
@ -102,7 +102,7 @@ inside GitLab that make that possible.
![Job artifacts browser](img/job_artifacts_browser.png) ![Job artifacts browser](img/job_artifacts_browser.png)
## Downloading the latest job artifacts ## Downloading the latest artifacts
It is possible to download the latest artifacts of a job via a well known URL It is possible to download the latest artifacts of a job via a well known URL
so you can use it for scripting purposes. so you can use it for scripting purposes.
@ -163,14 +163,18 @@ information in the UI.
![Latest artifacts button](img/job_latest_artifacts_browser.png) ![Latest artifacts button](img/job_latest_artifacts_browser.png)
## Validation for `dependency` keyword ## Erasing artifacts
To disable [the validation for dependency], you can flip the feature flag from a rails console: DANGER: **Warning:**
This is a destructive action that leads to data loss. Use with caution.
``` If you have at least Developer [permissions](../../permissions.md#gitlab-ci-cd-permissions)
Feature.enable('ci_disable_validates_dependencies') on the project, you can erase a single job via the UI which will also remove the
``` artifacts and the job's trace.
1. Navigate to a job's page.
1. Click the trash icon at the top right of the job's trace.
1. Confirm the deletion.
[expiry date]: ../../../ci/yaml/README.md#artifacts-expire_in [expiry date]: ../../../ci/yaml/README.md#artifacts-expire_in
[the validation for dependency]: ../../../ci/yaml/README.md#dependencies
[ce-14399]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/14399 [ce-14399]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/14399