jx-release-version
Installation
Entrypoint
Types
JxReleaseVersion

jx-release-version

jx-release-version is a CLI tool that helps you to release new versions of your projects.
See https://github.com/jenkins-x-plugins/jx-release-version for more information.

Installation

dagger install github.com/vbehar/daggerverse/jx-release-version@v0.14.11

Entrypoint

Return Type

JxReleaseVersion !

Arguments

Name	Type	Default Value	Description
imageRepository	String	"ghcr.io/jenkins-x/jx-release-version"	image repository of jx-release-version.
imageTag	String	"2.7.10@sha256:c4e729c8e4300a760daaf26aa269aba67e26d5bad9471a8c8053d8b84040497d"	image tag of jx-release-version. See https://github.com/jenkins-x-plugins/jx-release-version/releases for available tags. Run `crane digest ghcr.io/jenkins-x/jx-release-version:2.7.10` to get the digest.
logLevel	String	"info"	log level to use for the command.

Example

dagger -m github.com/vbehar/daggerverse/jx-release-version@ad0eb60ec0423bc9d7b2692fa876bc7926242f3a call \

func (m *MyModule) Example() *dagger.JxReleaseVersion  {
	return dag.
			JxReleaseVersion()
}

@function
def example() -> dagger.JxReleaseVersion:
	return (
		dag.jx_release_version()
	)

@func()
example(): JxReleaseVersion {
	return dag
		.jxReleaseVersion()
}

Types

JxReleaseVersion 🔗

JxReleaseVersion is a Dagger Module to interact with the jx-release-version CLI.

imageRepository() 🔗

Return Type

String !

Example

dagger -m github.com/vbehar/daggerverse/jx-release-version@ad0eb60ec0423bc9d7b2692fa876bc7926242f3a call \
 image-repository

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			JxReleaseVersion().
			ImageRepository(ctx)
}

@function
async def example() -> str:
	return await (
		dag.jx_release_version()
		.image_repository()
	)

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

imageTag() 🔗

Return Type

String !

Example

dagger -m github.com/vbehar/daggerverse/jx-release-version@ad0eb60ec0423bc9d7b2692fa876bc7926242f3a call \
 image-tag

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			JxReleaseVersion().
			ImageTag(ctx)
}

@function
async def example() -> str:
	return await (
		dag.jx_release_version()
		.image_tag()
	)

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

logLevel() 🔗

Return Type

String !

Example

dagger -m github.com/vbehar/daggerverse/jx-release-version@ad0eb60ec0423bc9d7b2692fa876bc7926242f3a call \
 log-level

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			JxReleaseVersion().
			LogLevel(ctx)
}

@function
async def example() -> str:
	return await (
		dag.jx_release_version()
		.log_level()
	)

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

container() 🔗

Container returns a container with jx-release-version installed.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
gitDirectory	Directory	-	git directory to include in the container.

Example

dagger -m github.com/vbehar/daggerverse/jx-release-version@ad0eb60ec0423bc9d7b2692fa876bc7926242f3a call \
 container

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			JxReleaseVersion().
			Container()
}

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

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

nextVersion() 🔗

NextVersion returns the next version of the given git repository.

Return Type

String !

Arguments

Name	Type	Default Value	Description
gitDirectory	Directory !	-	git directory to include in the container.
fetchTags	Boolean	false	If true, fetch tags from the remote repository before detecting the previous version.
previousVersionStrategy	String	"auto"	strategy to use to read the previous version. See https://github.com/jenkins-x-plugins/jx-release-version for doc.
nextVersionStrategy	String	"auto"	strategy to use to calculate the next version. See https://github.com/jenkins-x-plugins/jx-release-version for doc.
outputFormat	String	"{{.Major}}.{{.Minor}}.{{.Patch}}"	output format of the next version. See https://github.com/jenkins-x-plugins/jx-release-version for doc.

Example

dagger -m github.com/vbehar/daggerverse/jx-release-version@ad0eb60ec0423bc9d7b2692fa876bc7926242f3a call \
 next-version --git-directory DIR_PATH

func (m *MyModule) Example(ctx context.Context, gitDirectory *dagger.Directory) string  {
	return dag.
			JxReleaseVersion().
			NextVersion(ctx, gitDirectory)
}

@function
async def example(git_directory: dagger.Directory) -> str:
	return await (
		dag.jx_release_version()
		.next_version(git_directory)
	)

@func()
async example(gitDirectory: Directory): Promise<string> {
	return dag
		.jxReleaseVersion()
		.nextVersion(gitDirectory)
}

tag() 🔗

Tag tags the current commit with the next version - and pushes the tag to the remote repository. It returns the next version.

Return Type

String !

Arguments

Name	Type	Default Value	Description
gitDirectory	Directory !	-	git directory to include in the container.
fetchTags	Boolean	false	If true, fetch tags from the remote repository before detecting the previous version.
previousVersionStrategy	String	"auto"	strategy to use to read the previous version. See https://github.com/jenkins-x-plugins/jx-release-version for doc.
nextVersionStrategy	String	"auto"	strategy to use to calculate the next version. See https://github.com/jenkins-x-plugins/jx-release-version for doc.
outputFormat	String	"{{.Major}}.{{.Minor}}.{{.Patch}}"	output format of the next version. See https://github.com/jenkins-x-plugins/jx-release-version for doc.
tagPrefix	String	"v"	prefix for the new tag - prefixed before the output.
gitToken	Secret !	-	git token to use for authentication when pushing the tag to the remote.
gitUser	String	"jx-release-version"	name of the author/committer used to create the tag.
gitEmail	String	"jx-release-version@jenkins-x.io"	email of the author/committer used to create the tag.
pushTag	Boolean	true	if true, push the tag to the remote.

Example

dagger -m github.com/vbehar/daggerverse/jx-release-version@ad0eb60ec0423bc9d7b2692fa876bc7926242f3a call \
 tag --git-directory DIR_PATH --git-token env:MYSECRET

func (m *MyModule) Example(ctx context.Context, gitDirectory *dagger.Directory, gitToken *dagger.Secret) string  {
	return dag.
			JxReleaseVersion().
			Tag(ctx, gitDirectory, gitToken)
}

@function
async def example(git_directory: dagger.Directory, git_token: dagger.Secret) -> str:
	return await (
		dag.jx_release_version()
		.tag(git_directory, git_token)
	)

@func()
async example(gitDirectory: Directory, gitToken: Secret): Promise<string> {
	return dag
		.jxReleaseVersion()
		.tag(gitDirectory, gitToken)
}