gh-reusable-pipelines
Installation
Entrypoint
Types
GhReusablePipelines

gh-reusable-pipelines

No long description provided.

Installation

dagger install github.com/mbround18/gh-reusable/packages/dagger-module@24668ab9ee47588ac88638e6fc16316091e184b2

Entrypoint

Return Type

GhReusablePipelines

Example

dagger -m github.com/mbround18/gh-reusable/packages/dagger-module@24668ab9ee47588ac88638e6fc16316091e184b2 call \

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

@function
def example() -> dagger.GhReusablePipelines:
	return (
		dag.gh_reusable_pipelines()
	)

@func()
example(): GhReusablePipelines {
	return dag
		.ghReusablePipelines()
}

Types

GhReusablePipelines 🔗

ci() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided

Example

dagger -m github.com/mbround18/gh-reusable/packages/dagger-module@24668ab9ee47588ac88638e6fc16316091e184b2 call \
 ci --source DIR_PATH

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			GhReusablePipelines().
			Ci(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.gh_reusable_pipelines()
		.ci(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.ghReusablePipelines()
		.ci(source)
}

rustBuildAndTest() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided
toolchain	String !	"stable"	No description provided
components	String !	"clippy rustfmt"	No description provided
target	String !	""	No description provided

Example

dagger -m github.com/mbround18/gh-reusable/packages/dagger-module@24668ab9ee47588ac88638e6fc16316091e184b2 call \
 rust-build-and-test --source DIR_PATH --toolchain string --components string --target string

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, toolchain string, components string, target string) string  {
	return dag.
			GhReusablePipelines().
			RustBuildAndTest(ctx, source, toolchain, components, target)
}

@function
async def example(source: dagger.Directory, toolchain: str, components: str, target: str) -> str:
	return await (
		dag.gh_reusable_pipelines()
		.rust_build_and_test(source, toolchain, components, target)
	)

@func()
async example(source: Directory, toolchain: string, components: string, target: string): Promise<string> {
	return dag
		.ghReusablePipelines()
		.rustBuildAndTest(source, toolchain, components, target)
}

audit() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided
semgrepConfig	String !	"auto"	No description provided
includeGitleaks	Boolean !	true	No description provided

Example

dagger -m github.com/mbround18/gh-reusable/packages/dagger-module@24668ab9ee47588ac88638e6fc16316091e184b2 call \
 audit --source DIR_PATH --semgrep-config string --include-gitleaks boolean

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, semgrepConfig string, includeGitleaks bool) string  {
	return dag.
			GhReusablePipelines().
			Audit(ctx, source, semgrepConfig, includeGitleaks)
}

@function
async def example(source: dagger.Directory, semgrep_config: str, include_gitleaks: bool) -> str:
	return await (
		dag.gh_reusable_pipelines()
		.audit(source, semgrep_config, include_gitleaks)
	)

@func()
async example(source: Directory, semgrepConfig: string, includeGitleaks: boolean): Promise<string> {
	return dag
		.ghReusablePipelines()
		.audit(source, semgrepConfig, includeGitleaks)
}

publishNpm() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided
registry	String !	"https://registry.npmjs.org"	No description provided
token	String !	""	No description provided
tag	String !	""	No description provided
version	String !	""	No description provided

Example

dagger -m github.com/mbround18/gh-reusable/packages/dagger-module@24668ab9ee47588ac88638e6fc16316091e184b2 call \
 publish-npm --source DIR_PATH --registry string --token string --tag string --version string

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, registry string, token string, tag string, version string) string  {
	return dag.
			GhReusablePipelines().
			PublishNpm(ctx, source, registry, token, tag, version)
}

@function
async def example(source: dagger.Directory, registry: str, token: str, tag: str, version: str) -> str:
	return await (
		dag.gh_reusable_pipelines()
		.publish_npm(source, registry, token, tag, version)
	)

@func()
async example(source: Directory, registry: string, token: string, tag: string, version: string): Promise<string> {
	return dag
		.ghReusablePipelines()
		.publishNpm(source, registry, token, tag, version)
}

publishPnpm() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided
registry	String !	"https://registry.npmjs.org"	No description provided
token	String !	""	No description provided
tag	String !	""	No description provided
version	String !	""	No description provided

Example

dagger -m github.com/mbround18/gh-reusable/packages/dagger-module@24668ab9ee47588ac88638e6fc16316091e184b2 call \
 publish-pnpm --source DIR_PATH --registry string --token string --tag string --version string

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, registry string, token string, tag string, version string) string  {
	return dag.
			GhReusablePipelines().
			PublishPnpm(ctx, source, registry, token, tag, version)
}

@function
async def example(source: dagger.Directory, registry: str, token: str, tag: str, version: str) -> str:
	return await (
		dag.gh_reusable_pipelines()
		.publish_pnpm(source, registry, token, tag, version)
	)

@func()
async example(source: Directory, registry: string, token: string, tag: string, version: string): Promise<string> {
	return dag
		.ghReusablePipelines()
		.publishPnpm(source, registry, token, tag, version)
}

publishYarn() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided
registry	String !	"https://registry.npmjs.org"	No description provided
token	String !	""	No description provided
tag	String !	""	No description provided
version	String !	""	No description provided

Example

dagger -m github.com/mbround18/gh-reusable/packages/dagger-module@24668ab9ee47588ac88638e6fc16316091e184b2 call \
 publish-yarn --source DIR_PATH --registry string --token string --tag string --version string

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, registry string, token string, tag string, version string) string  {
	return dag.
			GhReusablePipelines().
			PublishYarn(ctx, source, registry, token, tag, version)
}

@function
async def example(source: dagger.Directory, registry: str, token: str, tag: str, version: str) -> str:
	return await (
		dag.gh_reusable_pipelines()
		.publish_yarn(source, registry, token, tag, version)
	)

@func()
async example(source: Directory, registry: string, token: string, tag: string, version: string): Promise<string> {
	return dag
		.ghReusablePipelines()
		.publishYarn(source, registry, token, tag, version)
}

publishRustCrate() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided
token	String !	""	No description provided
version	String !	""	No description provided
registry	String !	"crates.io"	No description provided

Example

dagger -m github.com/mbround18/gh-reusable/packages/dagger-module@24668ab9ee47588ac88638e6fc16316091e184b2 call \
 publish-rust-crate --source DIR_PATH --token string --version string --registry string

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, token string, version string, registry string) string  {
	return dag.
			GhReusablePipelines().
			PublishRustCrate(ctx, source, token, version, registry)
}

@function
async def example(source: dagger.Directory, token: str, version: str, registry: str) -> str:
	return await (
		dag.gh_reusable_pipelines()
		.publish_rust_crate(source, token, version, registry)
	)

@func()
async example(source: Directory, token: string, version: string, registry: string): Promise<string> {
	return dag
		.ghReusablePipelines()
		.publishRustCrate(source, token, version, registry)
}

publishHelmChart() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided
chart	String !	"."	No description provided
registry	String !	"oci://registry-1.docker.io/helm-charts"	No description provided
username	String !	""	No description provided
password	String !	""	No description provided
version	String !	""	No description provided

Example

dagger -m github.com/mbround18/gh-reusable/packages/dagger-module@24668ab9ee47588ac88638e6fc16316091e184b2 call \
 publish-helm-chart --source DIR_PATH --chart string --registry string --username string --password string --version string

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, chart string, registry string, username string, password string, version string) string  {
	return dag.
			GhReusablePipelines().
			PublishHelmChart(ctx, source, chart, registry, username, password, version)
}

@function
async def example(source: dagger.Directory, chart: str, registry: str, username: str, password: str, version: str) -> str:
	return await (
		dag.gh_reusable_pipelines()
		.publish_helm_chart(source, chart, registry, username, password, version)
	)

@func()
async example(source: Directory, chart: string, registry: string, username: string, password: string, version: string): Promise<string> {
	return dag
		.ghReusablePipelines()
		.publishHelmChart(source, chart, registry, username, password, version)
}

dockerRelease() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided
image	String !	-	No description provided
context	String !	"."	No description provided
dockerfile	String !	"./Dockerfile"	No description provided
target	String !	""	No description provided
platforms	String !	"linux/amd64"	No description provided
tagsCsv	String !	""	No description provided
registriesCsv	String !	"docker.io"	No description provided
semverPrefix	String !	""	No description provided
semverIncrement	String !	"patch"	No description provided
prependTarget	Boolean !	false	No description provided
canaryLabel	String !	"canary"	No description provided
dockerhubUsername	String !	"mbround18"	No description provided
ghcrUsername	String !	"mbround18"	No description provided
forcePush	Boolean !	false	No description provided
dockerToken	String !	""	No description provided
ghcrToken	String !	""	No description provided
eventName	String !	""	No description provided
ref	String !	""	No description provided
refName	String !	""	No description provided
headRef	String !	""	No description provided
defaultBranch	String !	"main"	No description provided
sha	String !	""	No description provided
runUrl	String !	""	No description provided
runNumber	String !	""	No description provided
prLabelsCsv	String !	""	No description provided

Example

dagger -m github.com/mbround18/gh-reusable/packages/dagger-module@24668ab9ee47588ac88638e6fc16316091e184b2 call \
 docker-release --source DIR_PATH --image string --context string --dockerfile string --target string --platforms string --tags-csv string --registries-csv string --semver-prefix string --semver-increment string --prepend-target boolean --canary-label string --dockerhub-username string --ghcr-username string --force-push boolean --docker-token string --ghcr-token string --event-name string --ref string --ref-name string --head-ref string --default-branch string --sha string --run-url string --run-number string --pr-labels-csv string

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, image string, context string, dockerfile string, target string, platforms string, tagsCsv string, registriesCsv string, semverPrefix string, semverIncrement string, prependTarget bool, canaryLabel string, dockerhubUsername string, ghcrUsername string, forcePush bool, dockerToken string, ghcrToken string, eventName string, ref string, refName string, headRef string, defaultBranch string, sha string, runUrl string, runNumber string, prLabelsCsv string) string  {
	return dag.
			GhReusablePipelines().
			DockerRelease(ctx, source, image, context, dockerfile, target, platforms, tagsCsv, registriesCsv, semverPrefix, semverIncrement, prependTarget, canaryLabel, dockerhubUsername, ghcrUsername, forcePush, dockerToken, ghcrToken, eventName, ref, refName, headRef, defaultBranch, sha, runUrl, runNumber, prLabelsCsv)
}

@function
async def example(source: dagger.Directory, image: str, context: str, dockerfile: str, target: str, platforms: str, tags_csv: str, registries_csv: str, semver_prefix: str, semver_increment: str, prepend_target: bool, canary_label: str, dockerhub_username: str, ghcr_username: str, force_push: bool, docker_token: str, ghcr_token: str, event_name: str, ref: str, ref_name: str, head_ref: str, default_branch: str, sha: str, run_url: str, run_number: str, pr_labels_csv: str) -> str:
	return await (
		dag.gh_reusable_pipelines()
		.docker_release(source, image, context, dockerfile, target, platforms, tags_csv, registries_csv, semver_prefix, semver_increment, prepend_target, canary_label, dockerhub_username, ghcr_username, force_push, docker_token, ghcr_token, event_name, ref, ref_name, head_ref, default_branch, sha, run_url, run_number, pr_labels_csv)
	)

@func()
async example(source: Directory, image: string, context: string, dockerfile: string, target: string, platforms: string, tagsCsv: string, registriesCsv: string, semverPrefix: string, semverIncrement: string, prependTarget: boolean, canaryLabel: string, dockerhubUsername: string, ghcrUsername: string, forcePush: boolean, dockerToken: string, ghcrToken: string, eventName: string, ref: string, refName: string, headRef: string, defaultBranch: string, sha: string, runUrl: string, runNumber: string, prLabelsCsv: string): Promise<string> {
	return dag
		.ghReusablePipelines()
		.dockerRelease(source, image, context, dockerfile, target, platforms, tagsCsv, registriesCsv, semverPrefix, semverIncrement, prependTarget, canaryLabel, dockerhubUsername, ghcrUsername, forcePush, dockerToken, ghcrToken, eventName, ref, refName, headRef, defaultBranch, sha, runUrl, runNumber, prLabelsCsv)
}