releaser
Installation
Entrypoint
Types
Releaser
- changeNotes()
- githubRelease()

releaser

A module that encodes the official release process of the Dagger Engine

Installation

dagger install github.com/helderco/dagger/releaser@170038cbfd041246a4c36ca67a405d77524d660f

Entrypoint

Return Type

Releaser !

Arguments

Name	Type	Default Value	Description
changeNotesDir	Directory	-	No description provided

Example

dagger -m github.com/helderco/dagger/releaser@170038cbfd041246a4c36ca67a405d77524d660f call \

func (m *myModule) example() *Releaser  {
	return dag.
			Releaser()
}

@function
def example() -> dag.Releaser:
	return (
		dag.releaser()
	)

@func()
example(): Releaser {
	return dag
		.releaser()
}

Types

Releaser 🔗

changeNotes() 🔗

Lookup the change notes file for the given component and version

Return Type

File !

Arguments

Name	Type	Default Value	Description
component	String !	-	The component to look up change notes for Example: "sdk/php"
version	String !	-	The version to look up change notes for

Example

dagger -m github.com/helderco/dagger/releaser@170038cbfd041246a4c36ca67a405d77524d660f call \
 change-notes --component string --version string

func (m *myModule) example(component string, version string) *File  {
	return dag.
			Releaser().
			ChangeNotes(component, version)
}

@function
def example(component: str, version: str) -> dagger.File:
	return (
		dag.releaser()
		.change_notes(component, version)
	)

@func()
example(component: string, version: string): File {
	return dag
		.releaser()
		.changeNotes(component, version)
}

githubRelease() 🔗

Publish a Github release

Return Type

Void !

Arguments

Name	Type	Default Value	Description
repository	String !	-	GitHub repository URL
tag	String !	-	Tag for the GitHub release eg. sdk/typescript/v0.14.0
target	String !	-	The target for the release eg. 🤷‍♂️ FIXME: what's the difference with 'tag'? Who knows, it wasn't documented - SH Nov 2024
notes	File	-	File containing release notes
token	Secret	-	GitHub token for authentication
dryRun	Boolean	-	Whether to perform a dry run without creating the release

Example

dagger -m github.com/helderco/dagger/releaser@170038cbfd041246a4c36ca67a405d77524d660f call \
 github-release --repository string --tag string --target string

func (m *myModule) example(ctx context.Context, repository string, tag string, target string)   {
	return dag.
			Releaser().
			GithubRelease(ctx, repository, tag, target)
}

@function
async def example(repository: str, tag: str, target: str) -> None:
	return await (
		dag.releaser()
		.github_release(repository, tag, target)
	)

@func()
async example(repository: string, tag: string, target: string): Promise<void> {
	return dag
		.releaser()
		.githubRelease(repository, tag, target)
}