Скачать или смотреть How to Properly Use GitLab CI/CD Variables When Triggered from Web UI

Learn how to effectively check for variable values in `GitLab CI/CD` while allowing pipelines to run manually using the web UI.
---
This video is based on the question https://stackoverflow.com/q/71406683/ asked by the user 'Santhosh' ( https://stackoverflow.com/u/2897115/ ) and on the answer https://stackoverflow.com/a/71413479/ provided by the user 'sytech' ( https://stackoverflow.com/u/5747944/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: gitlab CI/CD: How to check for variable but also allow to run when using web UI

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Understanding the Challenge: Conditional CI/CD in GitLab

When working with GitLab CI/CD, you might encounter situations where you want to impose certain conditions on your pipelines. A common requirement is to check the value of a variable before allowing a pipeline to run. However, you'll also want to maintain the flexibility to manually trigger pipelines from the web UI, bypassing these conditions when necessary.

In this post, we’ll guide you through how to achieve this by utilizing the rules keyword in your .gitlab-ci.yml file. This approach allows you to specify conditions under which your jobs will run, providing clarity and functionality to your CI/CD processes.

Implementing the Solution

To accomplish the goal of checking a variable only when the pipeline is not triggered from the web UI, you can modify your pipeline configuration with the following steps:

Step 1: Use rules for Conditional Job Execution

The rules keyword is a powerful feature in GitLab CI/CD. It allows you to define conditions that determine whether a job should run. For your scenario, you can set multiple rules that evaluate the pipeline source.

Example Configuration

Here's a sample configuration that demonstrates how to use rules effectively:

[[See Video to Reveal this Text or Code Snippet]]

Breakdown of the Configuration

First Rule: - if: '$CI_PIPELINE_SOURCE == "web"'
This rule ensures that if the pipeline is triggered from the web UI, this job will run without any further conditions regarding the variable.

Second Rule: - if: '$UPSTREAM_PROJECT == "A"'
This rule checks for the variable only if the pipeline is not triggered from the web UI. If the variable $UPSTREAM_PROJECT equals "A", then the job will execute.

Step 2: Testing Your Setup

Once you have implemented the rules above, it’s crucial to test the configuration to ensure it behaves as expected. Here are a few scenarios you should verify:

Scenario 1: Trigger the pipeline manually from the web UI. The job should execute without checking the variable.

Scenario 2: Trigger the pipeline via a commit or merge request. The job should check if $UPSTREAM_PROJECT is "A" before executing.

Conclusion

By leveraging the rules feature in GitLab CI/CD, you can effectively manage conditional job execution in your pipelines. This method allows you to maintain necessary checks while enabling manual override through the web UI.

For any continuous integration workflow, understanding and utilizing these features can lead to more intelligent and efficient automation processes.

Implement these tactics in your pipelines, and enjoy a smoother CI/CD experience!