Dagger
Search

pipeline-manager

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/pipeline-manager@4fc1b3bc804edd5573648d9c67b9620d732d2582

Entrypoint

Return Type 
PipelineManager !
Example
dagger -m github.com/BCIT-LTC/daggerverse/pipeline-manager@4fc1b3bc804edd5573648d9c67b9620d732d2582 call \

func (m *MyModule) Example() *dagger.PipelineManager  {
	return dag.
			PipelineManager()
}
@function
def example() -> dagger.PipelineManager:
	return (
		dag.pipeline_manager()
	)
@func()
example(): PipelineManager {
	return dag
		.pipelineManager()
}

Types

PipelineManager 🔗

checkCi() 🔗

Check if the environment is CI or local

Return Type 
Void !
Example
dagger -m github.com/BCIT-LTC/daggerverse/pipeline-manager@4fc1b3bc804edd5573648d9c67b9620d732d2582 call \
 check-ci
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			PipelineManager().
			CheckCi(ctx)
}
@function
async def example() -> None:
	return await (
		dag.pipeline_manager()
		.check_ci()
	)
@func()
async example(): Promise<void> {
	return dag
		.pipelineManager()
		.checkCi()
}

checkIfReview() 🔗

Determine if running on a review branch or main branch

Return Type 
String !
Example
dagger -m github.com/BCIT-LTC/daggerverse/pipeline-manager@4fc1b3bc804edd5573648d9c67b9620d732d2582 call \
 check-if-review
func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			PipelineManager().
			CheckIfReview(ctx)
}
@function
async def example() -> str:
	return await (
		dag.pipeline_manager()
		.check_if_review()
	)
@func()
async example(): Promise<string> {
	return dag
		.pipelineManager()
		.checkIfReview()
}

run() 🔗

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
sourceDirectory -Source directory
githubTokenSecret -No description provided
usernameString -No description provided
branchString -No description provided
commitHashString -No description provided
Example
dagger -m github.com/BCIT-LTC/daggerverse/pipeline-manager@4fc1b3bc804edd5573648d9c67b9620d732d2582 call \
 run
func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			PipelineManager().
			Run(ctx)
}
@function
async def example() -> str:
	return await (
		dag.pipeline_manager()
		.run()
	)
@func()
async example(): Promise<string> {
	return dag
		.pipelineManager()
		.run()
}

runSemanticRelease() 🔗

Run semantic release if the environment is either latest or stable

Return Type 
String !
Example
dagger -m github.com/BCIT-LTC/daggerverse/pipeline-manager@4fc1b3bc804edd5573648d9c67b9620d732d2582 call \
 run-semantic-release
func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			PipelineManager().
			RunSemanticRelease(ctx)
}
@function
async def example() -> str:
	return await (
		dag.pipeline_manager()
		.run_semantic_release()
	)
@func()
async example(): Promise<string> {
	return dag
		.pipelineManager()
		.runSemanticRelease()
}

unitTests() 🔗

Run unit tests by calling the test function in the source directory. This function is a placeholder and should be replaced with actual test logic.

Return Type 
Void !
Example
dagger -m github.com/BCIT-LTC/daggerverse/pipeline-manager@4fc1b3bc804edd5573648d9c67b9620d732d2582 call \
 unit-tests
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			PipelineManager().
			UnitTests(ctx)
}
@function
async def example() -> None:
	return await (
		dag.pipeline_manager()
		.unit_tests()
	)
@func()
async example(): Promise<void> {
	return dag
		.pipelineManager()
		.unitTests()
}