GitLab - rules keyword

Today we are going to learn more about the rules keyword in GitLab. Normally, when you want to spawn your job on a specific branch or only in merge requests you can just use the only/except keywords. But, sometimes it is not enough. For example, what if you want to spawn a job always on develop branch and run it automatically, but in merge requests you want to run it manually? You cannot (easily) do that with the only/except keywords.

Excerpt from GitLab documentation about the rules keyword:

The rules keyword can be used to include or exclude jobs in pipelines. 
Rules are evaluated in order until the first match. When matched, the job is either included or excluded from the pipeline, depending on the configuration. If included, the job also has certain attributes added to it. 
rules replaces only/except and can’t be used in conjunction with it. If you attempt to use both keywords in the same job, the linter returns a key may not be used with rules error.

There are two very important things about this keyword:

  • either you use rules or only/except, you cannot use both of them
  • you can add two attributes to the rules keyword:
    • when
    • allow_failure

So, the rules keyword allows us to build more sophisticated pipelines. We are going to build a pipeline with the only/except keywords and then we will build a pipeline with the rules keyword.

Let's say that we want to run linters in merge requests only, build images automatically on develop, staging and master branches, and additionally, we also want to build an image in merge requests, but manually:

Hmm... I do not see the manual build job! Sadly, you cannot change the when keyword if you use the only/except keywords. So, let's resolve the problem with the rules keyword:

You can see two IFs and a default state (remember that rules are evaluated in order until the first match). In the first IF we check if a pipeline is in a merge request. If it is, then we change the value of when to manual. And, user can run this job manually. In the second IF we check if a branch name is develop, staging or master. If it is, we run the job always no matter what. The last step is a default state (you do not have to set up it). We just set up the value of when to never. That's all.

As you can see, your pipelines can be more sophisticated (not complicated!) with the rules keyword.

Here is also video!



Comments

Post a Comment

Popular posts from this blog

GitLab - extends keyword

Image
In the previous post I had written about the include keyword. Now, let's dive in the extends  keyword. What can you do with this? Here is the definition from GitLab documentation: extends defines entry names that a job that uses extends inherits from. It’s an alternative to using YAML anchors and is a little more flexible and readable. So, when is it useful? It is useful when you want to be DRY and keep your setup cleanly. Let's assume that you want to build a docker image and give developers possibility to deploy the image on dev , staging and prod environments. We are going to do that without the extends keyword, and after that we will think how we can do it better. Example without the extends  keyword: As you can see, there is a lot of code which repeats itself: stage, image, when  and script . We can remove a lot of code! So, let's do that. We are going to create a hidden job .deploy  (you will not see this job in a pipeline) and the rest of the jobs ...
Read more

Managing Secrets in GitLab / Git

Image
Let's say that you have to log in via ssh into an instance, and you work with GitLab, so you want to keep the private key in GitLab somewhere. Is it secure? Let's see! Custom environment variables You can use custom environment variables. Here you can read more about them (Developers cannot change them, only Maintainers and Owners can). There are two types of variables: Variable (the runner creates an environment variable that uses the key for the name and the value for the value) File (the runner creates an environment variable that uses the key for the name. For the value, the runner writes the variable value to a temporary file and uses this path) It seems that we can use File type for our purpose. We can set up it via API or UI . So, let's do that! Go to project's Settings > CI/CD . There will be Variables section (btw, you can specify variables also per group and even for all projects (in admin panel)). Click Add Variable button and add a variable: Key: ...
Read more

GitLab - trigger keyword

Image
 We are going to talk about the trigger keyword today. With this feature you can define a downstream pipeline trigger. So, you can trigger a pipeline in any project (you must have access to this project of course). There are two types of downstream pipelines: multi-project pipelines child pipelines  Let's omit child pipelines and have a look at multi-project pipelines. It is very easy to use. You just need to provide a path to the project and that's it. Remember that you only can trigger a pipeline, not a job ! You can also provide more information like environment variables. As always, I am going to provide some examples, so you will understand it better. The first example: you want to trigger a pipeline in another project after the deployment of your service/s. How to do that? Here we want to trigger this pipeline (project my/run-tests ). Let's say that we want to run some tests after each deployment: We need to add the job which will trigger this pipeline in my/run-...
Read more