Dagger
Search

sem-rel

This module has been generated via dagger init and serves as a reference to
basic module structure as you get started with Dagger.

Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.

The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.

Installation

dagger install github.com/mjb141/daggerverse/sem-rel@26b5460a0842cbb06becb4f1c3289f42dc52dbf0

Entrypoint

Return Type
SemRel !
Arguments
NameTypeDescription
configFileFile Path to the .releaserc.json file.
configString No description provided
Example
dagger -m github.com/mjb141/daggerverse/sem-rel@26b5460a0842cbb06becb4f1c3289f42dc52dbf0 call \
func (m *myModule) example() *SemRel  {
	return dag.
			SemRel()
}
@function
def example() -> dag.SemRel:
	return (
		dag.sem_rel()
	)
@func()
example(): SemRel {
	return dag
		.semRel()
}

Types

SemRel 🔗

withConfig() 🔗

Modify the Semantic Release config file (.releaserc.json) for testing purposes.

Return Type
SemRel !
Arguments
NameTypeDefault ValueDescription
fileFile null[Required] The relative path to a .releaserc.json file.
branchString null[Optional] The branch you want to add to the release configuration.
Example
dagger -m github.com/mjb141/daggerverse/sem-rel@26b5460a0842cbb06becb4f1c3289f42dc52dbf0 call \
 with-config
func (m *myModule) example() *SemRel  {
	return dag.
			SemRel().
			WithConfig()
}
@function
def example() -> dag.SemRel:
	return (
		dag.sem_rel()
		.with_config()
	)
@func()
example(): SemRel {
	return dag
		.semRel()
		.withConfig()
}

release() 🔗

Returns a container that runs semantic-release on your branch.

Return Type
Container !
Arguments
NameTypeDefault ValueDescription
dirDirectory !-A directory.
providerString !-No description provided
tokenSecret !-A reference to a secret value, which can be handled more safely than the value itself.
checkIfCiBoolean !falseNo description provided
dryRunBoolean !trueNo description provided
Example
dagger -m github.com/mjb141/daggerverse/sem-rel@26b5460a0842cbb06becb4f1c3289f42dc52dbf0 call \
 release --dir DIR_PATH --provider string --token env:MYSECRET --check-if-ci boolean --dry-run boolean
func (m *myModule) example(dir *Directory, provider string, token *Secret, checkIfCi bool, dryRun bool) *Container  {
	return dag.
			SemRel().
			Release(dir, provider, token, checkIfCi, dryRun)
}
@function
def example(dir: dagger.Directory, provider: str, token: dagger.Secret, check_if_ci: bool, dry_run: bool) -> dagger.Container:
	return (
		dag.sem_rel()
		.release(dir, provider, token, check_if_ci, dry_run)
	)
@func()
example(dir: Directory, provider: string, token: Secret, checkIfCi: boolean, dryRun: boolean): Container {
	return dag
		.semRel()
		.release(dir, provider, token, checkIfCi, dryRun)
}