From 9aa7c4812d1983c0c3cdee223bbf5b73bd1c5763 Mon Sep 17 00:00:00 2001 From: Marcel Amirault Date: Thu, 23 Jan 2025 12:31:02 +0900 Subject: [PATCH 1/3] Remove non-docs jobs from docs pipelines Also removes a manual job that was blocking docs pipelines --- .gitlab/ci/checks.yml | 1 - .gitlab/ci/operator.gitlab-ci.yml | 1 - .gitlab/ci/validations.yml | 1 - 3 files changed, 3 deletions(-) diff --git a/.gitlab/ci/checks.yml b/.gitlab/ci/checks.yml index cc317e2599..c60b48bc7d 100644 --- a/.gitlab/ci/checks.yml +++ b/.gitlab/ci/checks.yml @@ -99,7 +99,6 @@ lint_package: paths: - build rules: - - if: '$PIPELINE_TYPE == "DOCS_PIPELINE"' - if: '$PIPELINE_TYPE =~ /_MR_PIPELINE$/' - if: '$PIPELINE_TYPE =~ /_BRANCH_PIPELINE$/' - if: '$PIPELINE_TYPE == "NIGHTLY_PIPELINE"' diff --git a/.gitlab/ci/operator.gitlab-ci.yml b/.gitlab/ci/operator.gitlab-ci.yml index 3fd482a0cc..b9110850a7 100644 --- a/.gitlab/ci/operator.gitlab-ci.yml +++ b/.gitlab/ci/operator.gitlab-ci.yml @@ -6,7 +6,6 @@ trigger_operator_test: variables: CHARTS_REF: "${CI_COMMIT_SHA}" TRIGGER_PROJECT: "${CI_PROJECT_PATH}" - PIPELINE_TYPE: "${PIPELINE_TYPE}" inherit: variables: false rules: diff --git a/.gitlab/ci/validations.yml b/.gitlab/ci/validations.yml index 1843f5b8db..ce5971167e 100644 --- a/.gitlab/ci/validations.yml +++ b/.gitlab/ci/validations.yml @@ -20,7 +20,6 @@ --output json . rules: - - if: '$PIPELINE_TYPE == "DOCS_PIPELINE"' - if: '$PIPELINE_TYPE =~ /_MR_PIPELINE$/' - if: '$PIPELINE_TYPE =~ /_BRANCH_PIPELINE$/' - if: '$PIPELINE_TYPE == "NIGHTLY_PIPELINE"' -- GitLab From d6c2dec5933845907868190967884f382720d3fb Mon Sep 17 00:00:00 2001 From: Marcel Amirault Date: Fri, 24 Jan 2025 15:57:15 +0900 Subject: [PATCH 2/3] Move docs skip with reference --- .gitlab/ci/operator.gitlab-ci.yml | 3 +-- .gitlab/ci/rules.gitlab-ci.yml | 4 ++++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.gitlab/ci/operator.gitlab-ci.yml b/.gitlab/ci/operator.gitlab-ci.yml index b9110850a7..dddab8d1eb 100644 --- a/.gitlab/ci/operator.gitlab-ci.yml +++ b/.gitlab/ci/operator.gitlab-ci.yml @@ -9,7 +9,6 @@ trigger_operator_test: inherit: variables: false rules: - - if: '$PIPELINE_TYPE == "DOCS_PIPELINE"' - when: never + - !reference [.rule:skip_docs_pipeline] - !reference [.rule:skip_if_fork] - when: manual diff --git a/.gitlab/ci/rules.gitlab-ci.yml b/.gitlab/ci/rules.gitlab-ci.yml index 78e6879289..aaf96e040b 100644 --- a/.gitlab/ci/rules.gitlab-ci.yml +++ b/.gitlab/ci/rules.gitlab-ci.yml @@ -86,3 +86,7 @@ workflow: .rule:skip_if_fork: - if: '$CI_SERVER_HOST != "gitlab.com" && $CI_PROJECT_PATH != $CANONICAL_PROJECT_PATH' when: never + +.rule:skip_docs_pipeline: + - if: '$CI_COMMIT_BRANCH =~ /(^docs-|-docs$|^docs\/)/ || $CI_MERGE_REQUEST_SOURCE_BRANCH_NAME =~ /(^docs-|-docs$|^docs\/)/' + when: never -- GitLab From 2f5c4000f4a13f44a8e6fde428a00f9fae546f72 Mon Sep 17 00:00:00 2001 From: Marcel Amirault Date: Tue, 28 Jan 2025 10:32:10 +0900 Subject: [PATCH 3/3] Make a few minor language tweaks --- doc/installation/deployment.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/installation/deployment.md b/doc/installation/deployment.md index cc6e20c240..8560d37557 100644 --- a/doc/installation/deployment.md +++ b/doc/installation/deployment.md @@ -12,7 +12,7 @@ DETAILS: Before running `helm install`, you need to make some decisions about how you will run GitLab. Options can be specified using Helm's `--set option.name=value` command-line option. -This guide will cover required values and common options. +This guide covers required values and common options. For a complete list of options, read [Installation command line options](command-line-options.md). WARNING: @@ -26,7 +26,7 @@ This method of deployment has different management, observability, and concepts ## Deploy using Helm -Once you have all of your configuration options collected, we can get any dependencies and +After you have all of your configuration options collected, we can get any dependencies and run Helm. In this example, we've named our Helm release `gitlab`. ```shell @@ -45,7 +45,7 @@ Note the following: - Helm v3 requires that the release name be specified as a positional argument on the command line unless the `--generate-name` option is used. - Helm v3 requires one to specify a duration with a unit appended to the value - (e.g. `120s` = `2m` and `210s` = `3m30s`). The `--timeout` option is handled as the + (for example, `120s` = `2m` and `210s` = `3m30s`). The `--timeout` option is handled as the number of seconds _without_ the unit specification. - The use of the `--timeout` option is deceptive in that there are multiple components that are deployed during an Helm install or upgrade in which the `--timeout` is applied. The `--timeout` @@ -68,7 +68,7 @@ information, see [GitLab Helm Chart provenance](chart-provenance.md). ## Monitoring the Deployment -This will output the list of resources installed once the deployment finishes which may take 5-10 minutes. +This outputs the list of resources installed after deployment finishes which may take 5-10 minutes. The status of the deployment can be checked by running `helm status gitlab` which can also be done while the deployment is taking place if you run the command in another terminal. -- GitLab