semantic-release
Installation
Entrypoint
Types
SemanticRelease
- semanticrelease()

semantic-release

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/BCIT-LTC/daggerverse/semantic-release@6b55663bfe79bea4037657f0a50cb5a08a1959fe

Entrypoint

Return Type

SemanticRelease !

Arguments

Name	Type	Default Value	Description
githubToken	String	-	No description provided

Example

dagger -m github.com/BCIT-LTC/daggerverse/semantic-release@6b55663bfe79bea4037657f0a50cb5a08a1959fe call \

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

@function
def example() -> dagger.SemanticRelease:
	return (
		dag.semantic_release()
	)

@func()
example(): SemanticRelease {
	return dag
		.semanticRelease()
}

Types

SemanticRelease 🔗

This class encapsulates the functionality of semantic-release, providing a Dagger-based interface for automating software release workflows. It allows users to configure and run semantic-release in various environments, including CI/CD pipelines and local development setups. The class supports custom plugin injection, configuration, and environment detection, enabling seamless integration with existing workflows. Attributes: github_token (str): GitHub token for authentication in CI/CD environments. username (str): GitHub username for commit authoring. repository_url (str): URL of the GitHub repository. dry_run (bool): Flag to indicate if the release should be a dry run. debug (bool): Flag to enable debug mode. ci (bool): Flag to indicate if running in a CI environment. ci_provider (CiProvider): The CI provider being used (e.g., GitHub).

semanticrelease() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory	-	Source directory
githubToken	Secret	-	No description provided
username	String !	"local"	Github Username
repositoryUrl	String !	""	Repository URL
dryRun	Boolean !	false	Dry run mode
debug	Boolean !	false	Debug mode
ci	Boolean !	true	CI mode

Example

dagger -m github.com/BCIT-LTC/daggerverse/semantic-release@6b55663bfe79bea4037657f0a50cb5a08a1959fe call \
 semanticrelease --username string --repository-url string --dry-run boolean --debug boolean --ci boolean

func (m *MyModule) Example(ctx context.Context, username string, repositoryUrl string, dryRun bool, debug bool, ci bool) string  {
	return dag.
			SemanticRelease().
			Semanticrelease(ctxusername, repositoryUrl, dryRun, debug, ci)
}

@function
async def example(username: str, repository_url: str, dry_run: bool, debug: bool, ci: bool) -> str:
	return await (
		dag.semantic_release()
		.semanticrelease(username, repository_url, dry_run, debug, ci)
	)

@func()
async example(username: string, repositoryUrl: string, dryRun: boolean, debug: boolean, ci: boolean): Promise<string> {
	return dag
		.semanticRelease()
		.semanticrelease(username, repositoryUrl, dryRun, debug, ci)
}