Merge branch 'jyavorska-master-patch-88152' into 'master'

Enhance CI troubleshooting guide

Closes #232464

See merge request gitlab-org/gitlab!39070

doc/.vale/gitlab/spelling-exceptions.txt

@@ -403,6 +403,7 @@ sanitization
 sbt
 scatterplot
 scatterplots
+Schemastore
 Sendmail
 Sentry
 serializer

doc/ci/merge_request_pipelines/pipelines_for_merged_results/index.md

@@ -127,5 +127,5 @@ unexpected timing. For example, when a source or target branch is advanced.
 In this case, the pipeline fails because of `fatal: reference is not a tree:` error,
 which indicates that the checkout-SHA is not found in the merge ref.
 
-This behavior was improved at GitLab 12.4 by introducing [Persistent pipeline refs](../../pipelines/index.md#troubleshooting-fatal-reference-is-not-a-tree).
+This behavior was improved at GitLab 12.4 by introducing [Persistent pipeline refs](../../troubleshooting.md#fatal-reference-is-not-a-tree-error).
 You should be able to create pipelines at any timings without concerning the error.

doc/ci/pipelines/index.md

@@ -535,32 +535,3 @@ GitLab provides API endpoints to:
 - Trigger pipeline runs. For more information, see:
   - [Triggering pipelines through the API](../triggers/README.md).
   - [Pipeline triggers API](../../api/pipeline_triggers.md).
-
-## Troubleshooting `fatal: reference is not a tree:`
-
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/17043) in GitLab 12.4.
-
-Previously, you'd have encountered unexpected pipeline failures when you force-pushed
-a branch to its remote repository. To illustrate the problem, suppose you've had the current workflow:
-
-1. A user creates a feature branch named `example` and pushes it to a remote repository.
-1. A new pipeline starts running on the `example` branch.
-1. A user rebases the `example` branch on the latest `master` branch and force-pushes it to its remote repository.
-1. A new pipeline starts running on the `example` branch again, however,
-   the previous pipeline (2) fails because of `fatal: reference is not a tree:` error.
-
-This is because the previous pipeline cannot find a checkout-SHA (which associated with the pipeline record)
-from the `example` branch that the commit history has already been overwritten by the force-push.
-Similarly, [Pipelines for merged results](../merge_request_pipelines/pipelines_for_merged_results/index.md)
-might have failed intermittently due to [the same reason](../merge_request_pipelines/pipelines_for_merged_results/index.md#intermittently-pipelines-fail-by-fatal-reference-is-not-a-tree-error).
-
-As of GitLab 12.4, we've improved this behavior by persisting pipeline refs exclusively.
-To illustrate its life cycle:
-
-1. A pipeline is created on a feature branch named `example`.
-1. A persistent pipeline ref is created at `refs/pipelines/<pipeline-id>`,
-   which retains the checkout-SHA of the associated pipeline record.
-   This persistent ref stays intact during the pipeline execution,
-   even if the commit history of the `example` branch has been overwritten by force-push.
-1. The runner fetches the persistent pipeline ref and gets source code from the checkout-SHA.
-1. When the pipeline finished, its persistent ref is cleaned up in a background process.

doc/ci/troubleshooting.md

@@ -7,48 +7,240 @@ type: reference
 
 # Troubleshooting CI/CD
 
-## Pipeline warnings
+GitLab provides several tools to help make troubleshooting your pipelines easier.
 
-Pipeline configuration warnings are shown when you:
+This guide also lists common issues and possible solutions.
 
-- [Validate configuration with the CI Lint tool](yaml/README.md#validate-the-gitlab-ciyml).
-- [Manually run a pipeline](pipelines/index.md#run-a-pipeline-manually).
+## Verify syntax
 
-### "Job may allow multiple pipelines to run for a single action"
+An early source of problems can be incorrect syntax. The pipeline shows a `yaml invalid`
+badge and does not start running if any syntax or formatting problems are found.
 
-When you use [`rules`](yaml/README.md#rules) with a `when:` clause without
-an `if:` clause, multiple pipelines may run. Usually
-this occurs when you push a commit to a branch that has an open merge request associated with it.
+### Edit `gitlab-ci.yml` with the Web IDE
 
-To [prevent duplicate pipelines](yaml/README.md#prevent-duplicate-pipelines), use
-[`workflow: rules`](yaml/README.md#workflowrules) or rewrite your rules
-to control which pipelines can run.
+The [GitLab Web IDE](../user/project/web_ide/index.md) offers advanced authoring tools,
+including syntax highlighting for the `.gitlab-ci.yml`, and is the recommended editing
+experience (rather than the single file editor). It offers code completion suggestions
+that ensure you are only using accepted keywords.
+
+If you prefer to use another editor, you can use a schema like [the Schemastore `gitlab-ci` schema](https://json.schemastore.org/gitlab-ci)
+with your editor of choice.
+
+### Verify syntax with CI Lint tool
+
+The [CI Lint tool](lint.md) is a simple way to ensure the syntax of a CI/CD configuration
+file is correct. Paste in full `gitlab-ci.yml` files or individual jobs configuration,
+to verify the basic syntax.
+
+When a `.gitlab-ci.yml` file is present in a project, you can also use the CI Lint
+tool to [simulate the creation of a full pipeline](lint.md#pipeline-simulation).
+It does deeper verification of the configuration syntax.
+
+## Verify variables
+
+A key part of troubleshooting CI/CD is to verify which variables are present in a
+pipeline, and what their values are. A lot of pipeline configuration is dependent
+on variables, and verifying them is one of the fastest ways to find the source of
+a problem.
+
+[Export the full list of variables](variables/README.md#list-all-environment-variables)
+available in each problematic job. Check if the variables you expect are present,
+and check if their values are what you expect.
+
+## GitLab CI/CD documentation
+
+The [complete `gitlab-ci.yml` reference](yaml/README.md) contains a full list of
+every keyword you may need to use to configure your pipelines.
+
+You can also look at a large number of pipeline configuration [examples](examples/README.md)
+and [templates](examples/README.md#cicd-templates).
+
+### Documentation for pipeline types
+
+Some pipeline types have their own detailed usage guides that you should read
+if you are using that type:
+
+- [Multi-project pipelines](multi_project_pipelines.md): Have your pipeline trigger
+  a pipeline in a different project.
+- [Parent/child pipelines](parent_child_pipelines.md): Have your main pipeline trigger
+  and run separate pipelines in the same project. You can also
+  [dynamically generate the child pipeline's configuration](parent_child_pipelines.md#dynamic-child-pipelines)
+  at runtime.
+- [Pipelines for Merge Requests](merge_request_pipelines/index.md): Run a pipeline
+  in the context of a merge request.
+  - [Pipelines for Merge Results](merge_request_pipelines/pipelines_for_merged_results/index.md):
+    Pipelines for merge requests that run on the combined source and target branch
+  - [Merge Trains](merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md):
+    Multiple pipelines for merged results that queue and run automatically before
+    changes are merged.
+
+### Troubleshooting Guides for CI/CD features
+
+There are troubleshooting guides available for some CI/CD features and related topics:
+
+- [Container Registry](../user/packages/container_registry/index.md#troubleshooting-the-gitlab-container-registry)
+- [GitLab Runner](https://docs.gitlab.com/runner/faq/)
+- [Merge Trains](merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md#troubleshooting)
+- [Docker Build](docker/using_docker_build.md#troubleshooting)
+- [Environments](environments/deployment_safety.md#ensure-only-one-deployment-job-runs-at-a-time)
+
+## Common CI/CD issues
+
+A lot of common pipeline issues can be fixed by analyzing the behavior of the `rules`
+or `only/except` configuration. You shouldn't use these two configurations in the same
+pipeline, as they behave differently. It's hard to predict how a pipeline runs with
+this mixed behavior.
+
+If your `rules` or `only/except` configuration makes use of [predefined variables](variables/predefined_variables.md)
+like `CI_PIPELINE_SOURCE`, `CI_MERGE_REQUEST_ID`, you should [verify them](#verify-variables)
+as the first troubleshooting step.
+
+### Jobs or pipelines don't run when expected
+
+The `rules` or `only/except` keywords are what determine whether or not a job is
+added to a pipeline. If a pipeline runs, but a job is not added to the pipeline,
+it's usually due to `rules` or `only/except` configuration issues.
+
+If a pipeline does not seem to run at all, with no error message, it may also be
+due to `rules` or `only/except` configuration, or the `workflow: rules` keyword.
+
+If you are converting from `only/except` to the `rules` keyword, you should check
+the [`rules` configuration details](yaml/README.md#rules) carefully. The behavior
+of `only/except` and `rules` is different and can cause unexpected behavior when migrating
+between the two.
+
+The [common `if` clauses for `rules`](yaml/README.md#common-if-clauses-for-rules)
+can be very helpful for examples of how to write rules that behave the way you expect.
+
+#### Two pipelines run at the same time
+
+Two pipelines can run when pushing a commit to a branch that has an open merge request
+associated with it. Usually one pipeline is a merge request pipeline, and the other
+is a branch pipeline.
 
-## Merge request pipeline widget
+This is usually caused by the `rules` configuration, and there are several ways to
+[prevent duplicate pipelines](yaml/README.md#prevent-duplicate-pipelines).
 
-The merge request pipeline widget shows information about the pipeline status in a Merge Request. It's displayed above the [merge request ability to merge widget](#merge-request-ability-to-merge-widget).
+#### A job is not in the pipeline
 
-There are several messages that can be displayed depending on the status of the pipeline.
+GitLab determines if a job is added to a pipeline based on the [`only/except`](yaml/README.md#onlyexcept-basic)
+or [`rules`](yaml/README.md#rules) defined for the job. If it didn't run, it's probably
+not evaluating as you expect.
 
-### "Checking pipeline status"
+#### No pipeline or the wrong type of pipeline runs
 
-This message is shown when the merge request has no pipeline associated with the latest commit yet. This might be because:
+Before a pipeline can run, GitLab evaluates all the jobs in the configuration and tries
+to add them to all available pipeline types. A pipeline does not run if no jobs are added
+to it at the end of the evaluation.
+
+If a pipeline did not run, it's likely that all the jobs had `rules` or `only/except` that
+blocked them from being added to the pipeline.
+
+If the wrong pipeline type ran, then the `rules` or `only/except` configuration should
+be checked to make sure the jobs are added to the correct pipeline type. For
+example, if a merge request pipeline did not run, the jobs may have been added to
+a branch pipeline instead.
+
+It's also possible that your [`workflow: rules`](yaml/README.md#workflowrules) configuration
+blocked the pipeline, or allowed the wrong pipeline type.
+
+### A job runs unexpectedly
+
+A common reason a job is added to a pipeline unexpectedly is because the `changes`
+keyword always evaluates to true in certain cases. For example, `changes` is always
+true in certain pipeline types, including scheduled pipelines and pipelines for tags.
+
+The `changes` keyword is used in combination with [`only/except`](yaml/README.md#onlychangesexceptchanges)
+or [`rules`](yaml/README.md#ruleschanges)). It's recommended to use `changes` with
+`rules` or `only/except` configuration that ensures the job is only added to branch
+pipelines or merge request pipelines.
+
+### "fatal: reference is not a tree" error
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/17043) in GitLab 12.4.
+
+Previously, you'd have encountered unexpected pipeline failures when you force-pushed
+a branch to its remote repository. To illustrate the problem, suppose you've had the current workflow:
+
+1. A user creates a feature branch named `example` and pushes it to a remote repository.
+1. A new pipeline starts running on the `example` branch.
+1. A user rebases the `example` branch on the latest `master` branch and force-pushes it to its remote repository.
+1. A new pipeline starts running on the `example` branch again, however,
+   the previous pipeline (2) fails because of `fatal: reference is not a tree:` error.
+
+This is because the previous pipeline cannot find a checkout-SHA (which is associated with the pipeline record)
+from the `example` branch that the commit history has already been overwritten by the force-push.
+Similarly, [Pipelines for merged results](merge_request_pipelines/pipelines_for_merged_results/index.md)
+might have failed intermittently due to [the same reason](merge_request_pipelines/pipelines_for_merged_results/index.md#intermittently-pipelines-fail-by-fatal-reference-is-not-a-tree-error).
+
+As of GitLab 12.4, we've improved this behavior by persisting pipeline refs exclusively.
+To illustrate its life cycle:
+
+1. A pipeline is created on a feature branch named `example`.
+1. A persistent pipeline ref is created at `refs/pipelines/<pipeline-id>`,
+   which retains the checkout-SHA of the associated pipeline record.
+   This persistent ref stays intact during the pipeline execution,
+   even if the commit history of the `example` branch has been overwritten by force-push.
+1. The runner fetches the persistent pipeline ref and gets source code from the checkout-SHA.
+1. When the pipeline finishes, its persistent ref is cleaned up in a background process.
+
+### Merge request pipeline messages
+
+The merge request pipeline widget shows information about the pipeline status in
+a merge request. It's displayed above the [ability to merge status widget](#merge-request-status-messages).
+
+#### "Checking pipeline status" message
+
+This message is shown when the merge request has no pipeline associated with the
+latest commit yet. This might be because:
 
 - GitLab hasn't finished creating the pipeline yet.
 - You are using an external CI service and GitLab hasn't heard back from the service yet.
 - You are not using CI/CD pipelines in your project.
 - The latest pipeline was deleted (this is a [known issue](https://gitlab.com/gitlab-org/gitlab/-/issues/214323)).
 
-After the pipeline is created, the message will update with the pipeline status.
+After the pipeline is created, the message updates with the pipeline status.
+
+### Merge request status messages
+
+The merge request status widget shows the **Merge** button and whether or not a merge
+request is ready to merge. If the merge request can't be merged, the reason for this
+is displayed.
+
+If the pipeline is still running, the **Merge** button is replaced with the
+**Merge when pipeline succeeds** button.
 
-## Merge request ability to merge widget
+If [**Merge Trains**](merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md)
+are enabled, the button is either **Add to merge train** or **Add to merge train when pipeline succeeds**. **(PREMIUM)**
 
-The merge request status widget shows the **Merge** button and whether or not a merge request is ready to merge. If the merge request can't be merged, the reason for this is displayed.
+#### "A CI/CD pipeline must run and be successful before merge" message
 
-If the pipeline is still running, the **Merge** button is replaced with the **Merge when pipeline succeeds** button.
+This message is shown if the [Pipelines must succeed](../user/project/merge_requests/merge_when_pipeline_succeeds.md#only-allow-merge-requests-to-be-merged-if-the-pipeline-succeeds)
+setting is enabled in the project and a pipeline has not yet run successfully.
+This also applies if the pipeline has not been created yet, or if you are waiting
+for an external CI service. If you don't use pipelines for your project, then you
+should disable **Pipelines must succeed** so you can accept merge requests.
+
+## Pipeline warnings
+
+Pipeline configuration warnings are shown when you:
+
+- [Validate configuration with the CI Lint tool](yaml/README.md#validate-the-gitlab-ciyml).
+- [Manually run a pipeline](pipelines/index.md#run-a-pipeline-manually).
+
+### "Job may allow multiple pipelines to run for a single action" warning
+
+When you use [`rules`](yaml/README.md#rules) with a `when:` clause without an `if:`
+clause, multiple pipelines may run. Usually this occurs when you push a commit to
+a branch that has an open merge request associated with it.
+
+To [prevent duplicate pipelines](yaml/README.md#prevent-duplicate-pipelines), use
+[`workflow: rules`](yaml/README.md#workflowrules) or rewrite your rules to control
+which pipelines can run.
 
-If [**Merge Trains**](merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md) are enabled, the button is either **Add to merge train** or **Add to merge train when pipeline succeeds**. **(PREMIUM)**
+## How to get help
 
-### "A CI/CD pipeline must run and be successful before merge"
+If you are unable to resolve pipeline issues, you can get help from:
 
-This message is shown if the [Pipelines must succeed](../user/project/merge_requests/merge_when_pipeline_succeeds.md#only-allow-merge-requests-to-be-merged-if-the-pipeline-succeeds) setting is enabled in the project and a pipeline has not yet run successfully. This also applies if the pipeline has not been created yet, or if you are waiting for an external CI service. If you don't use pipelines for your project, then you should disable **Pipelines must succeed** so you can accept merge requests.
+- The [GitLab community forum](https://forum.gitlab.com/)
+- GitLab [Support](https://about.gitlab.com/support/)

doc/user/project/repository/reducing_the_repo_size_using_git.md

@@ -35,7 +35,7 @@ other internal references (refs) that are automatically created by GitLab. These
 
 - `refs/merge-requests/*` for merge requests.
 - `refs/pipelines/*` for
-  [pipelines](../../../ci/pipelines/index.md#troubleshooting-fatal-reference-is-not-a-tree).
+  [pipelines](../../../ci/troubleshooting.md#fatal-reference-is-not-a-tree-error).
 - `refs/environments/*` for environments.
 
 Git doesn't usually download these refs to make cloning and fetch faster, but we can use the `--mirror` option to