git-releaser
Installation
Entrypoint
Types
GitReleaser
- dryRun()
- release()

git-releaser

No long description provided.

Installation

dagger install github.com/shykes/dagger/modules/git-releaser@7ec44c64b509793d2a722ebdfef94a77dbcdcefe

Entrypoint

Return Type

GitReleaser !

Arguments

Name	Type	Default Value	Description
alpineVersion	String	"3.22.1"	No description provided

Example

dagger -m github.com/shykes/dagger/modules/git-releaser@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \

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

@function
def example() -> dagger.GitReleaser:
	return (
		dag.git_releaser()
	)

@func()
example(): GitReleaser {
	return dag
		.gitReleaser()
}

Types

GitReleaser 🔗

dryRun() 🔗

Execute a dry-run release, to verify that a release is possible without actually completing it

Return Type

Void !

Arguments

Name	Type	Default Value	Description
sourceRepo	GitRepository !	-	No description provided
sourceTag	String !	-	No description provided
destRemote	String !	-	No description provided
destTag	String	-	No description provided
sourcePath	String	-	No description provided
callback	File	-	No description provided

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(ctx context.Context, sourceRepo *dagger.GitRepository, sourceTag string, destRemote string)   {
	return dag.
			GitReleaser().
			DryRun(ctx, sourceRepo, sourceTag, destRemote)
}

@function
async def example(source_repo: dagger.GitRepository, source_tag: str, dest_remote: str) -> None:
	return await (
		dag.git_releaser()
		.dry_run(source_repo, source_tag, dest_remote)
	)

@func()
async example(sourceRepo: GitRepository, sourceTag: string, destRemote: string): Promise<void> {
	return dag
		.gitReleaser()
		.dryRun(sourceRepo, sourceTag, destRemote)
}

release() 🔗

Execute a source release from a git repository

Return Type

Void !

Arguments

Name	Type	Default Value	Description
sourceRepo	GitRepository !	-	The git repository to release from
sourceTag	String !	-	Local tag to release from
destRemote	String !	-	Git remote to push the release to
destTag	String	-	Remote tag to release to
sourcePath	String	-	Optionally publish only a subdirectory
callback	File	-	Python script executed by git-filter-repo See https://github.com/newren/git-filter-repo/blob/main/Documentation/converting-from-filter-branch.md#cheat-sheet-additional-conversion-examples
githubToken	Secret	-	Github authentication token
dryRun	Boolean	-	Execute a dry run without actually releasing

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(ctx context.Context, sourceRepo *dagger.GitRepository, sourceTag string, destRemote string)   {
	return dag.
			GitReleaser().
			Release(ctx, sourceRepo, sourceTag, destRemote)
}

@function
async def example(source_repo: dagger.GitRepository, source_tag: str, dest_remote: str) -> None:
	return await (
		dag.git_releaser()
		.release(source_repo, source_tag, dest_remote)
	)

@func()
async example(sourceRepo: GitRepository, sourceTag: string, destRemote: string): Promise<void> {
	return dag
		.gitReleaser()
		.release(sourceRepo, sourceTag, destRemote)
}