gitlab

Usage

To start adding registry items from a GitLab repository you can run the following command:

jsrepo add https://gitlab.com/<group>/<project>/<item-name>

The GitLab provider can parse GitLab URLs so that you can just copy and paste a link to a GitLab repository and it will just work:

jsrepo add https://gitlab.com/<group>/<project>/<item-name>
jsrepo add https://gitlab.com/<group>/<project>/-/tree/<ref>

The gitlab/ shorthand

You can also just use the gitlab/ shorthand in place of https://gitlab.com/.

jsrepo add gitlab/<group>/<project>/<item-name>
jsrepo add gitlab/<group>/<subgroup>/<project>/-/tree/<ref>

Custom base urls

By default the GitLab provider will use https://gitlab.com as the base url for the gitlab/ shorthand. You can configure this behavior by configuring gitlab in your jsrepo.config file:

import { defineConfig } from "jsrepo";
import { gitlab } from "jsrepo/providers";

export default defineConfig({
	providers: [gitlab({ baseUrl: "https://my-gitlab-instance.com" })], 
});

Alternatively you can use the gitlab:https://<url> shorthand to use a custom base url without having to touch your config file:

jsrepo add gitlab:https://my-gitlab-instance.com/<group>/<project>/<item-name>

This syntax tells the GitLab provider that it can resolve this URL as a GitLab repository.

Deploying your registry to GitLab

When deploying your registry to GitLab you will want to use the repository output type:

import { defineConfig } from "jsrepo";
import { repository } from "jsrepo/outputs"; 

export default defineConfig({
	registry: {
		// ...
		outputs: [repository()], 
	},
});

This will create a registry.json file that will contain everything users need to use your registry.

Authentication

To authenticate with GitLab you can run the following command:

jsrepo auth gitlab

You can logout of your account by running:

jsrepo auth gitlab --logout

Environment Variable

If you prefer to use an environment variable or are in an environment where you can't use the jsrepo auth command you can provide the token via the GITLAB_TOKEN environment variable.

GITLAB_TOKEN=... jsrepo add 

Options