GitLab Package Group, 9 Jul 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: GitLab Composer Repository: Speed-run

Description

In this video we walk through how to create a project using the Composer Repository. We publish a package using the CLI and GitLab CI. And we view it in the user interface.

This follow-up issue will improve the UI: https://gitlab.com/gitlab-org/gitlab/-/issues/222469

A

Hello I'm Tim I'm, the p.m. for the package stage and today I want to do a quick walkthrough of a new feature. That's available now get lab comm and will be included for self managed instances in the 13.2 release, which is scheduled for July 22nd. So what we've added is a new package meant support for a new package manager format, we've added support for composer, which will help PHP developers to use the get lab project or group as a composer repository, so you can publish dependencies here.

A

Get that project you can install them using a group local end point: you can authenticate using your personal access token or your job token, and you can also view your dependencies and respective meta data using the package registry UI, although there's a caveat here that we'll see as we go through the demo.

A

Okay, so let's open up the documentation- and the first thing that we want to do is create a project and enable the feature. So, let's create a new project.

A

Let's call it composer, 101 I'm going to set the visibility level to public. This will give you access to all of the gold level features of get lab, which is really nice and I will initialize it with.

A

Okay, here's my my project, I'm, going to clone this locally or I guess do I have to yes. I do I'm gonna focus locally.

A

A

Okay, so we opened it and Adam. Let's see CD into.

A

Okay, so we only have our readme we'll just say this: okay.

A

So we now have this project and we're now synced locally. Maybe what we could do is just test that and say.

A

Okay, so we just updated our Redmayne and pushed it so now we're we're synched I could see. That's there. Let's follow along with the rest of the documentation. So now we have a project. The first step is to enable the composer repository so for that I could see that it's already enabled they could see packages and registries here and if I click on it, I could see that we have the option to publish packages. I mentioned earlier that there's a caveat about the UI.

A

The issue is that you don't see a dedicated tab for composer dependencies here, we'll be working that on that in milestones 13.3, but for now you still can publish and install dependencies no problem. If you wanted to turn this feature off, what you could do is go to settings in general, go to visibility and then there's an option here for you to turn off packages that will disable the feature. If you turn off packages and the container registry, it will actually remove that navigation item.

A

So, if you're not interested in using either, then you would turn both of those off I'm gonna turn to packages on. For now and the container industry as well.

A

Okay, so we have the feature enabled what comes next next up is creating a package project. Well, we already have a project, so I think what we actually want to do is skip this step and then we want to create a composer dice JSON file. So let's do this.

A

Okay and then inside the file, we want to add this code. I'll just copy this now. The note here is to replace a namespace with a unique namespace like your get lab username or a group name: okay, so let's open atom, open our composer dot, JSON file and we'll replace the namespace with T busy, which is my user name and save.

A

Okay, we already have a get. We do need to add the composer type JSON file, so it.

A

Will just commit these changes, we'll say we're really following along with the documentation. If I could remember how to insert clips okay, then, let's tag this which will create the reference to the dependency file. So good tag do we need to to get organized? We could just do git push.

A

Okay, so I could see that my changes were pushed and that it pushed this new V 1.0.0 tag. So, let's see, if I go back to my project, I.

A

Do not see it, that's, let me try doing just a regular which will actually push the files I only pushed the tag before that was the problem.

A

Okay, now I can see my composer file. I could see. This is what I added, but how do I confirm that the tags are there? Let's see if I go to the repository and I see tags I should see B 1.0.0.

A

Okay, so next up, we want to try to publish the package so to do this, we'll need a personal access token, with the scope set to API and then the project ID. Okay. So let's go and create a personal access token.

A

So to do that, I'm going to click on my avatar up here and then I'm going to click settings all this is a new window and then here we see access tokens will call the we're gonna name this one composer, 101 and we'll set the expiration date for the tenth, and here are the different options for this. We want to set it to API, which grants access to the package registry.

A

We do have an issue open that will add more granular permissions for the personal access token, so that you get what could have read package registry and write package registry, so you don't have to get a full API scope, but for now this is what we're limited to okay. So we create this token here it is I'm gonna delete this token after the demo, so should be safe and then I'll just paste it in here for now.

A

Okay, so looking at the documentation again, we have this curl command that we can copy and we'll adjust this inserting the variables so I see here. The the curl command includes the tag. Now. The tag we know is the 1.0.0.

A

The personal access token is the next variable we're going to fill in and then just replace that here and then we need the project ID to find the project I need you go to your project home, and it's right here underneath the project title.

A

And this should be okay, so let's try this to run this curl command.

A

A

Ad illegal format or missing URL I.

A

Think what happened was I had a break.

A

Okay, we gave it to one success, so if we go to back to the project and we scroll to the package registry, I could see that my package was created. Version 1.00 and I could see some basic information here, like name version and when it was created cool, that's great.

A

So the next thing that I wanted to show quick is: how could you do this okay and get started using get map CI CD, so one option here would be to say we have this quick navigation item for setting up CI and then we have, you can apply a template. So one nice thing about about composer is one of the community members.

A

Joe Chen, who was a big contributor to the composer repository in general, also created a composer template, and what this will do is automatically fill in your get lab environment variables like your commit tag and reference name and it will publish a package. So, let's see I I'm gonna, add this template say I get that CI 10.

A

Okay, so we just added a template or a pipeline template that should actually kick off a pipeline. So if I go to see ICD and pipelines, I could see it's running.

A

Let's click into the job and see what's happening.

A

Okay, job succeeded, so it looks like package created and see that there was a success code. So let's go back to the package rich for UI and I see a different option there that was published just 17 seconds ago. Okay, so what we just did is we got setup with composer. We published a package using the command-line NCI there's a couple of issues, as this is an empty see that are probably worth calling out.

A

You'll notice that this says manually published normally what happens when you publish a package using CI is you'll get to see which pipeline, which of which commit was responsible for them. That's an issue and then, like we mentioned, you also can cannot see, isolate just your composer dependencies here. So that's another issue, but we'll be working on those things in the coming milestones and there's always room for community contributions as well. So that's it. If you have any questions, you can always feel free to reach out to me at T rysiek get lab comm.

A

You can submit an issue or just comment in one of our existing issues. Looking forward to hearing your feedback and seeing seeing your usage thanks, everyone.