diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2022-08-17 09:09:38 +0300 |
|---|---|---|
| committer | Achilleas Pipinellis <axil@gitlab.com> | 2022-08-17 09:09:38 +0300 |
| commit | 6910c74e4eb5b231a86b9719a1007515ee746598 (patch) | |
| tree | 699052114b2be63994de40cb470af212e2e6f8bc | |
| parent | e76d11690ed406e5ff178457b299d1b8f02ba174 (diff) | |
| parent | a649826d50e12bb285d4f8c32b2932ddebf563a4 (diff) | |
Merge branch 'docs-update-pipeline-architecture' into 'main'
Rename deploy CI/CD config file and update docs
Closes #1224
See merge request gitlab-org/gitlab-docs!3025
| -rw-r--r-- | .gitlab/ci/build-and-deploy.gitlab-ci.yml (renamed from .gitlab/ci/deploy.gitlab-ci.yml) | 0 | ||||
| -rw-r--r-- | doc/architecture.md | 26 |
2 files changed, 26 insertions, 0 deletions
diff --git a/.gitlab/ci/deploy.gitlab-ci.yml b/.gitlab/ci/build-and-deploy.gitlab-ci.yml index e1ba016e..e1ba016e 100644 --- a/.gitlab/ci/deploy.gitlab-ci.yml +++ b/.gitlab/ci/build-and-deploy.gitlab-ci.yml diff --git a/doc/architecture.md b/doc/architecture.md index c545e1f0..4098a06c 100644 --- a/doc/architecture.md +++ b/doc/architecture.md @@ -82,6 +82,32 @@ The pipeline in the `gitlab-docs` project: - Builds and deploys the docs site itself. - Generates the review apps when the `review-docs-deploy` job is triggered. +### Pipeline configuration files + +The `gitlab-docs` project pipeline configuration is split into multiple files to +improve maintainability: + +- [`.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/.gitlab-ci.yml): + The base configuration file contains: + - Global variables. + - [`workflow:rules`](https://docs.gitlab.com/ee/ci/yaml/index.html#workflowrules) + to limit which pipelines can run. + - External templates imported with [`include`](https://docs.gitlab.com/ee/ci/yaml/index.html#include). + - The other configuration files, also imported with `include`. +- [`.gitlab/ci/build-and-deploy.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/.gitlab/ci/build-and-deploy.gitlab-ci.yml): + The jobs that build the docs site before testing, and the jobs that deploy the site + or review apps. +- [`.gitlab/ci/docker-images.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/.gitlab/ci/docker-images.gitlab-ci.yml): + The jobs that build and test docker images. +- [`.gitlab/ci/rules.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/.gitlab/ci/rules.gitlab-ci.yml): + The [`rules`](https://docs.gitlab.com/ee/ci/yaml/index.html#rules), [`cache`](https://docs.gitlab.com/ee/ci/yaml/index.html#cache) + and other default configuration for most jobs in the pipeline. +- [`.gitlab/ci/security.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/.gitlab/ci/security.gitlab-ci.yml): + Extra configuration for security jobs to override their defaults and make them work + better in the pipeline. +- [`.gitlab/ci/test.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/.gitlab/ci/test.gitlab-ci.yml): + Code tests and jobs used for [`gitlab-docs` maintenance](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#regularly-scheduled-tasks). + ### Rebuild the docs site Docker images Once a week on Mondays, a scheduled pipeline runs and rebuilds the Docker images |