a final image, but artifacts are also available in later stages within a pipeline.
). Artifacts need to be uploaded to the GitLab instance (not only the GitLab
So if you build your application by downloading all the required modules, you might
runner) before the next stage job(s) can start, so you need to evaluate
want to declare them as artifacts so that subsequent stages can use them. There are
carefully whether your bandwidth allows you to profit from parallelization
some optimizations like declaring an [expiry time](../yaml/README.md#artifactsexpire_in)
with stages and shared artifacts before investing time in changes to the
so you don't keep artifacts around too long, or using [dependencies](../yaml/README.md#dependencies)
setup.
to control which jobs fetch the artifacts.
It's sometimes confusing because the name artifact sounds like something that
Caches:
is only useful outside of the job, like for downloading a final image. But
artifacts are also available in between stages within a pipeline. So if you
- Are disabled if not defined globally or per job (using `cache:`).
build your application by downloading all the required modules, you might want
- Are available for all jobs in your `.gitlab-ci.yml` if enabled globally.
to declare them as artifacts so that each subsequent stage can depend on them
- Can be used in subsequent pipelines by the same job in which the cache was created (if not defined globally).
being there. There are some optimizations like declaring an
- Are stored where the Runner is installed **and** uploaded to S3 if [distributed cache is enabled](https://docs.gitlab.com/runner/configuration/autoscale.html#distributed-runners-caching).
[expiry time](../yaml/README.md#artifactsexpire_in) so you don't keep artifacts
- If defined per job, are used:
around too long, and using [dependencies](../yaml/README.md#dependencies) to
- By the same job in a subsequent pipeline.
control exactly where artifacts are passed around.
- By subsequent jobs in the same pipeline, if the they have identical dependencies.
In summary:
Artifacts:
- Caches are disabled if not defined globally or per job (using `cache:`).
- Are disabled if not defined per job (using `artifacts:`).
- Caches are available for all jobs in your `.gitlab-ci.yml` if enabled globally.
- Can only be enabled per job, not globally.
- Caches can be used by subsequent pipelines of that same job (a script in
- Are created during a pipeline and can be used by the subsequent jobs of that currently active pipeline.
a stage) in which the cache was created (if not defined globally).
- Are always uploaded to GitLab (known as coordinator).
- Caches are stored where the Runner is installed **and** uploaded to S3 if
- Can have an expiration value for controlling disk usage (30 days by default).
[distributed cache is enabled](https://docs.gitlab.com/runner/configuration/autoscale.html#distributed-runners-caching).
- Caches defined per job are only used, either:
NOTE: **Note:**
- For the next pipeline of that job.
Both artifacts and caches define their paths relative to the project directory, and
- If that same cache is also defined in a subsequent job of the same pipeline.
can't link to files outside it.
- Artifacts are disabled if not defined per job (using `artifacts:`).
- Artifacts can only be enabled per job, not globally.
- Artifacts are created during a pipeline and can be used by the subsequent
jobs of that currently active pipeline.
- Artifacts are always uploaded to GitLab (known as coordinator).
- Artifacts can have an expiration value for controlling disk usage (30 days by default).
@@ -1514,8 +1514,10 @@ globally and all jobs will use that definition.
...
@@ -1514,8 +1514,10 @@ globally and all jobs will use that definition.
#### `cache:paths`
#### `cache:paths`
Use the `paths` directive to choose which files or directories will be cached. You can only specify paths within your `$CI_PROJECT_DIR`.
Use the `paths` directive to choose which files or directories will be cached. Paths
Wildcards can be used that follow the [glob](https://en.wikipedia.org/wiki/Glob_(programming)) patterns and [filepath.Match](https://golang.org/pkg/path/filepath/#Match).
are relative to the project directory (`$CI_PROJECT_DIR`) and cannot directly link outside it.
Wildcards can be used that follow the [glob](https://en.wikipedia.org/wiki/Glob_(programming))
patterns and [filepath.Match](https://golang.org/pkg/path/filepath/#Match).
Cache all files in `binaries` that end in `.apk` and the `.config` file:
Cache all files in `binaries` that end in `.apk` and the `.config` file:
...
@@ -1744,8 +1746,9 @@ be available for download in the GitLab UI.
...
@@ -1744,8 +1746,9 @@ be available for download in the GitLab UI.
#### `artifacts:paths`
#### `artifacts:paths`
You can only use paths that are within the local working copy.
Paths are relative to the project directory (`$CI_PROJECT_DIR`) and cannot directly
Wildcards can be used that follow the [glob](https://en.wikipedia.org/wiki/Glob_(programming)) patterns and [filepath.Match](https://golang.org/pkg/path/filepath/#Match).
link outside it. Wildcards can be used that follow the [glob](https://en.wikipedia.org/wiki/Glob_(programming))
patterns and [filepath.Match](https://golang.org/pkg/path/filepath/#Match).
To restrict which jobs a specific job will fetch artifacts from, see [dependencies](#dependencies).
To restrict which jobs a specific job will fetch artifacts from, see [dependencies](#dependencies).