GitLab Release Group, 21 Apr 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Create a Release using .gitlab-ci.yml Part 1

Description

Update: You can now use the release keyword directly in your .gitlab-ci.yml file
https://youtu.be/YtaqZMwx7sA

Walkthrough of how to Create a Release using GitLab's CI/CD configuration file .gitlab-ci.yml and GitLab's Release CLI tool

Release CLI - https://gitlab.com/gitlab-org/release-cli/-/tree/master/docs#gitlab-release-command-line-tool
Release CLI Issues - https://gitlab.com/gitlab-org/release-cli/-/issues
Sample project - https://gitlab.com/jaime/hello

A

Hello: everyone today, I'm gonna talk about you'd, love, release, command line tool or release CLI. This is an application written in go and it's able to interact with get elapsed, releases API through the command line and or using your CI CDs configuration file, and this will basically allow you to consume I release instruction in your CI configuration file and you will be able to release your project automatically.

A

This is, as I said, it is CLI tool, so you can actually run this from the command line and you can see what the options are for it. If you, if you use it via in the CI configuration file, it's gonna be fall to some configuration values. You think it laps predefined environmental variables, so you can take advantage of all that to actually create a release and you can get the information you need to actually create a release at the moment. This this CLI tool is only only supports, create and release.

A

We will, of course, try to add functionality in the future. You can go to the job, sorry to the projects, issues board and you can see what we're planning to work on and you're always welcome to add more more ideas in there. We will review them and work on them when we can um so to basically to create a release like the documentation says here, we're actually just calling the get labs. It really is API releases API.

A

So if we, if we open this, we can see that basically, these are the pieces that are required attributes that we need to actually create a release for this iteration. We try to keep it very, very simple, and at the moment all you mean all you can do is add a name, add a description and then the other two require fields.

A

It's a tag name because you're basically going to create a gift tag for release, and you need a reference so that the release the release API knows which committee has to use to create that to create a release. Now, if I go back to here, if you were to run the command line tool with like this and say, create help it'll tell you. Okay, these are the options and you can pass and they basically match to what I just said. Their releases API.

A

All the configuration flags will actually default to to get lab. Ci is pretty fine embarrassed if there are any so, for example, on on the CI a rate you don't need to specify the server URL or you don't need to specify things like. They chose the job token to authenticate with the with the API, because this values will actually come from from the CI environment.

A

Let's, let's get to let this go through an example, how you can actually use these two and get lucky I, so I've added here, you know just a sample step that you can actually add to your to your Zi file. So I have a very simple project here already.

A

You know it's just a simple command-line tool with that come online, a program that is actually just gonna. If I show you the CI steps, it's a go application as well, and we're gonna have a test and a build steps in this configuration.

A

But what we can do is actually just go ahead and add a release step in here so I'm just using the web IDE just for fun to show you how you can do it yourself, so I just copied this from this section, then using this tool and get like CI in the Willys CLI documentation.

A

And let's say we just wanna: let's just call it. Let's say we just want to create a release all right and that really CLI is available by a get docker image. So all you need to do is specify the image. The docker image that you want to use in this step also we're adding a release stage. So let's say, let's just add it here and say release, and we only want to do this if test and we'll pass, it's probably well.

A

Do you probably will have many more stages, so at this stage I'm saying I want to trigger it manually because I don't want to create that release automatically. Maybe you do and.

A

As a general recommendation, I've added this accept text because we created a release. We will create a tag and get lucky. I would actually pick up that tag and it's gonna read this PCI file and it's gonna try to run all the steps again when it picks up that tag.

A

So we don't want to recreate a release and just go into this kind of like loop when you keep creating releases so in here in the script, all we're gonna do is say: okay, we're, gonna, call, release, CLI and we're gonna say create want to create a new release and, let's just call it. Let's say this is going to be version 1.0.0 and.

A

As a description, we can actually just up here.

A

Feli and just for fun: let's just do this v 1.0.0 and I'm gonna take advantage of the fact that the CI knows the the reference. It knows what kameen to use well yeah welcome in reference to use, so this is gonna actually create the their release from this committee. Hash.

A

Another thing that we can do is maybe we can add an environment variable here to say, let's just say, extra.

A

A

And we are gonna commit this.

A

Okay, say and release age.

A

And I'm just gonna commit to master right now.

A

Throw away project that I'm just using to demonstrate this no I'm done if I go back to the project.

A

And I go back to pipelines.

A

I can see the steps running at the moment. Oh, we just need to wait for this.

A

And I mean time I would say you can just go back to this documentation, there's more information on how this Tool Works and why are the intended purposes of using this there's also the an open. This is the initial issue with all this conversation started and how we decided to make this work. So you're welcome to go through that and, like I said, if you, if you have more ideas or if you find any issues, please report this today to the issue board um and yeah, we'll try to work on on that.

A

So let's just wait for this bill to finish.

A

Okay, job succeeded, as you can see here, this release, step is its manual, so I can go and say run. Oh.

A

And I forgot to add the environment variable, so this will actually just create a release without that extra description and variable that I define. So alright, it's actually very quick.

A

As you can see, we just call these are exactly the same steps that we added to towards CI a step, and we can see we are trying to create a release. This is just log information and we can see the tag we define. The name is V, 0 1 would be 1, 0 0, and this Anu release you saying they release a li and then some more information right. So, if I actually go into my project releases, I should be able to see it. There really easy.

A

And here it is it's tag v100 and you can go ahead and download all these assets and yeah. That's. Does it really a lie for you? Thank you.

A