gitlab-cli

GitLab CLI is a command-line tool that allows you to interact with the GitLab API.
See https://gitlab.com/gitlab-org/cli for more information.
This module also contains the (deprecated) GitLab Release CLI.
See https://gitlab.com/gitlab-org/release-cli for more information.

Installation

dagger install github.com/vbehar/daggerverse/gitlab-cli@v0.9.0

Entrypoint

Return Type

GitlabCli !

Arguments

Name	Type	Default Value	Description
privateToken	Secret	-	private (personal) token to use for authentication with GitLab.
jobToken	Secret	-	(CI) job token to use for authentication with GitLab. Defined as CI_JOB_TOKEN in the GitLab CI environment.
host	String	-	host of the GitLab instance.
repo	String	-	default gitlab repository for commands accepting the --repo flag.
group	String	-	default gitlab group for commands accepting the --group flag.
releaseCliVersion	String	"v0.18.0"	version of the GitLab Release CLI tool to use. https://gitlab.com/gitlab-org/release-cli

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \

func (m *myModule) example() *dagger.GitlabCli  {
	return dag.
			GitlabCli()
}

@function
def example() -> dagger.GitlabCli:
	return (
		dag.gitlab_cli()
	)

@func()
example(): GitlabCli {
	return dag
		.gitlabCli()
}

Types

GitlabCli 🔗

GitlabCli is a Dagger Module to interact with the GitLab CLI.

privateToken() 🔗

Return Type

Secret !

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \
 private-token

func (m *myModule) example() *dagger.Secret  {
	return dag.
			GitlabCli().
			PrivateToken()
}

@function
def example() -> dagger.Secret:
	return (
		dag.gitlab_cli()
		.private_token()
	)

@func()
example(): Secret {
	return dag
		.gitlabCli()
		.privateToken()
}

jobToken() 🔗

Return Type

Secret !

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \
 job-token

func (m *myModule) example() *dagger.Secret  {
	return dag.
			GitlabCli().
			JobToken()
}

@function
def example() -> dagger.Secret:
	return (
		dag.gitlab_cli()
		.job_token()
	)

@func()
example(): Secret {
	return dag
		.gitlabCli()
		.jobToken()
}

host() 🔗

Return Type

String !

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \
 host

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GitlabCli().
			Host(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gitlab_cli()
		.host()
	)

@func()
async example(): Promise<string> {
	return dag
		.gitlabCli()
		.host()
}

repo() 🔗

Return Type

String !

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \
 repo

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GitlabCli().
			Repo(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gitlab_cli()
		.repo()
	)

@func()
async example(): Promise<string> {
	return dag
		.gitlabCli()
		.repo()
}

group() 🔗

Return Type

String !

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \
 group

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GitlabCli().
			Group(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gitlab_cli()
		.group()
	)

@func()
async example(): Promise<string> {
	return dag
		.gitlabCli()
		.group()
}

releaseCliVersion() 🔗

Return Type

String !

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \
 release-cli-version

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GitlabCli().
			ReleaseCliVersion(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gitlab_cli()
		.release_cli_version()
	)

@func()
async example(): Promise<string> {
	return dag
		.gitlabCli()
		.releaseCliVersion()
}

container() 🔗

Container returns a container with the GitLab CLI installed.

Return Type

Container !

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \
 container

func (m *myModule) example() *dagger.Container  {
	return dag.
			GitlabCli().
			Container()
}

@function
def example() -> dagger.Container:
	return (
		dag.gitlab_cli()
		.container()
	)

@func()
example(): Container {
	return dag
		.gitlabCli()
		.container()
}

run() 🔗

Run runs the glab CLI with the given arguments.

Return Type

String !

Arguments

Name	Type	Default Value	Description
args	[String ! ]	-	arguments to pass to the glab CLI
ctr	Container	-	container to use for the command, instead of the default container you can use this to customize the container

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \
 run

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GitlabCli().
			Run(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gitlab_cli()
		.run()
	)

@func()
async example(): Promise<string> {
	return dag
		.gitlabCli()
		.run()
}

release() 🔗

Release allows you to interact with GitLab Releases.

Return Type

GitlabCliRelease !

Arguments

Name	Type	Default Value	Description
tagName	String !	-	name of the tag.
descriptionFile	File	-	a file from which to read the release description.
ctr	Container	-	container to use for the command, instead of the default container you can use this to customize the container

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \
 release --tag-name string

func (m *myModule) example(tagName string) *dagger.GitlabCliRelease  {
	return dag.
			GitlabCli().
			Release(tagName)
}

@function
def example(tag_name: str) -> dagger.GitlabCliRelease:
	return (
		dag.gitlab_cli()
		.release(tag_name)
	)

@func()
example(tagName: string): GitlabCliRelease {
	return dag
		.gitlabCli()
		.release(tagName)
}

GitlabCliRelease 🔗

Release allows you to interact with GitLab Releases.

tagName() 🔗

Return Type

String !

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \
 release --tag-name string \
 tag-name

func (m *myModule) example(ctx context.Context, tagName string) string  {
	return dag.
			GitlabCli().
			Release(tagName).
			TagName(ctx)
}

@function
async def example(tag_name: str) -> str:
	return await (
		dag.gitlab_cli()
		.release(tag_name)
		.tag_name()
	)

@func()
async example(tagName: string): Promise<string> {
	return dag
		.gitlabCli()
		.release(tagName)
		.tagName()
}

descriptionFile() 🔗

Return Type

File !

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \
 release --tag-name string \
 description-file

func (m *myModule) example(tagName string) *dagger.File  {
	return dag.
			GitlabCli().
			Release(tagName).
			DescriptionFile()
}

@function
def example(tag_name: str) -> dagger.File:
	return (
		dag.gitlab_cli()
		.release(tag_name)
		.description_file()
	)

@func()
example(tagName: string): File {
	return dag
		.gitlabCli()
		.release(tagName)
		.descriptionFile()
}

ctr() 🔗

Return Type

Container !

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \
 release --tag-name string \
 ctr

func (m *myModule) example(tagName string) *dagger.Container  {
	return dag.
			GitlabCli().
			Release(tagName).
			Ctr()
}

@function
def example(tag_name: str) -> dagger.Container:
	return (
		dag.gitlab_cli()
		.release(tag_name)
		.ctr()
	)

@func()
example(tagName: string): Container {
	return dag
		.gitlabCli()
		.release(tagName)
		.ctr()
}

container() 🔗

Container returns a container ready to be used for managing releases.

Return Type

Container !

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \
 release --tag-name string \
 container

func (m *myModule) example(tagName string) *dagger.Container  {
	return dag.
			GitlabCli().
			Release(tagName).
			Container()
}

@function
def example(tag_name: str) -> dagger.Container:
	return (
		dag.gitlab_cli()
		.release(tag_name)
		.container()
	)

@func()
example(tagName: string): Container {
	return dag
		.gitlabCli()
		.release(tagName)
		.container()
}

create() 🔗

CreateRelease creates a new release for the given tag. If the tag doesn’t exist, it will be created - if you also provide a gitRef.

Return Type

String !

Arguments

Name	Type	Default Value	Description
gitRef	String	-	if the tag should be created, it will be created from this ref. can be a commit or a branch.

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \
 release --tag-name string \
 create

func (m *myModule) example(ctx context.Context, tagName string) string  {
	return dag.
			GitlabCli().
			Release(tagName).
			Create(ctx)
}

@function
async def example(tag_name: str) -> str:
	return await (
		dag.gitlab_cli()
		.release(tag_name)
		.create()
	)

@func()
async example(tagName: string): Promise<string> {
	return dag
		.gitlabCli()
		.release(tagName)
		.create()
}

update() 🔗

UpdateRelease updates an existing release for the given tag.

Return Type

String !

Example

dagger -m github.com/vbehar/daggerverse/gitlab-cli@527dd8483a56a2f9cc0ce9eb08b6663ddfb360f7 call \
 release --tag-name string \
 update

func (m *myModule) example(ctx context.Context, tagName string) string  {
	return dag.
			GitlabCli().
			Release(tagName).
			Update(ctx)
}

@function
async def example(tag_name: str) -> str:
	return await (
		dag.gitlab_cli()
		.release(tag_name)
		.update()
	)

@func()
async example(tagName: string): Promise<string> {
	return dag
		.gitlabCli()
		.release(tagName)
		.update()
}