sem-rel
Installation
Entrypoint
Types
SemRel
- withConfig()
- release()

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@2fa3c28694a9c90515f80413dab254f9ca918ea8

Entrypoint

Return Type

SemRel !

Arguments

Name	Type	Description
configFile	File	Path to the .releaserc.json file.
config	String	No description provided

Example

dagger -m github.com/mjb141/daggerverse/sem-rel@2fa3c28694a9c90515f80413dab254f9ca918ea8 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

Name	Type	Default Value	Description
file	File	null	[Required] The relative path to a .releaserc.json file.
branch	String	null	[Optional] The branch you want to add to the release configuration.

Example

dagger -m github.com/mjb141/daggerverse/sem-rel@2fa3c28694a9c90515f80413dab254f9ca918ea8 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

Name	Type	Default Value	Description
dir	Directory !	-	A directory.
provider	String !	-	No description provided
token	Secret !	-	A reference to a secret value, which can be handled more safely than the value itself.
checkIfCi	Boolean !	false	No description provided
dryRun	Boolean !	true	No description provided

Example

dagger -m github.com/mjb141/daggerverse/sem-rel@2fa3c28694a9c90515f80413dab254f9ca918ea8 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)
}