Dagger
Search

release-please

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/kdihalas/dagger/release-please@9a0a4650b0db8e48b33140b4ca395de77002d6bf

Entrypoint

Return Type 
ReleasePlease !
Arguments
NameTypeDefault ValueDescription
tokenSecret !-The GitHub token to use for authentication with the GitHub API.
Example
dagger -m github.com/kdihalas/dagger/release-please@9a0a4650b0db8e48b33140b4ca395de77002d6bf call \
 --token env:MYSECRET
func (m *MyModule) Example(token *dagger.Secret) *dagger.ReleasePlease  {
	return dag.
			ReleasePlease(token)
}
@function
def example(token: dagger.Secret) -> dagger.ReleasePlease:
	return (
		dag.release_please(token)
	)
@func()
example(token: Secret): ReleasePlease {
	return dag
		.releasePlease(token)
}

Types

ReleasePlease 🔗

token() 🔗

Token is a secret containing the GitHub token to use for authentication with the GitHub API.

Return Type 
Secret !
Example
dagger -m github.com/kdihalas/dagger/release-please@9a0a4650b0db8e48b33140b4ca395de77002d6bf call \
 --token env:MYSECRET token
func (m *MyModule) Example(token *dagger.Secret) *dagger.Secret  {
	return dag.
			ReleasePlease(token).
			Token()
}
@function
def example(token: dagger.Secret) -> dagger.Secret:
	return (
		dag.release_please(token)
		.token()
	)
@func()
example(token: Secret): Secret {
	return dag
		.releasePlease(token)
		.token()
}

bootstrap() 🔗

Bootstrap runs the release-please bootstrap command to set up release-please in the repository.

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
repoUrlString !-repo-url is the URL of the GitHub repository to bootstrap release-please in, such as "github.com/owner/repo".
Example
dagger -m github.com/kdihalas/dagger/release-please@9a0a4650b0db8e48b33140b4ca395de77002d6bf call \
 --token env:MYSECRET bootstrap --repo-url string
func (m *MyModule) Example(ctx context.Context, token *dagger.Secret, repoUrl string) string  {
	return dag.
			ReleasePlease(token).
			Bootstrap(ctx, repoUrl)
}
@function
async def example(token: dagger.Secret, repo_url: str) -> str:
	return await (
		dag.release_please(token)
		.bootstrap(repo_url)
	)
@func()
async example(token: Secret, repoUrl: string): Promise<string> {
	return dag
		.releasePlease(token)
		.bootstrap(repoUrl)
}

container() 🔗

Container returns a Dagger container configured with the release-please tool installed. This container can be used to run release-please commands in a consistent environment.

Return Type 
Container !
Example
dagger -m github.com/kdihalas/dagger/release-please@9a0a4650b0db8e48b33140b4ca395de77002d6bf call \
 --token env:MYSECRET container
func (m *MyModule) Example(token *dagger.Secret) *dagger.Container  {
	return dag.
			ReleasePlease(token).
			Container()
}
@function
def example(token: dagger.Secret) -> dagger.Container:
	return (
		dag.release_please(token)
		.container()
	)
@func()
example(token: Secret): Container {
	return dag
		.releasePlease(token)
		.container()
}

githubRelease() 🔗

GithubRelease creates a GitHub release using the release-please tool and returns the URL of the created release.

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
releaseTypeString !-args are the arguments to pass to the release-please command. For example, you might include "--repo-url=github.com/owner/repo" and "--package-name=my-package". release-type is the type of release to create, such as "node" or "python". This will determine the format of the release notes and the versioning scheme used by release-please.
repoUrlString !-repo-url is the URL of the GitHub repository to create the release in, such as "github.com/owner/repo".
Example
dagger -m github.com/kdihalas/dagger/release-please@9a0a4650b0db8e48b33140b4ca395de77002d6bf call \
 --token env:MYSECRET github-release --release-type string --repo-url string
func (m *MyModule) Example(ctx context.Context, token *dagger.Secret, releaseType string, repoUrl string) string  {
	return dag.
			ReleasePlease(token).
			GithubRelease(ctx, releaseType, repoUrl)
}
@function
async def example(token: dagger.Secret, release_type: str, repo_url: str) -> str:
	return await (
		dag.release_please(token)
		.github_release(release_type, repo_url)
	)
@func()
async example(token: Secret, releaseType: string, repoUrl: string): Promise<string> {
	return dag
		.releasePlease(token)
		.githubRelease(releaseType, repoUrl)
}

releasePr() 🔗

ReleasePr creates a release pull request using the release-please tool and returns the URL of the created pull request.

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
releaseTypeString !-args are the arguments to pass to the release-please command. For example, you might include "--repo-url=github.com/owner/repo" and "--package-name=my-package". release-type is the type of release to create, such as "node" or "python". This will determine the format of the release notes and the versioning scheme used by release-please.
repoUrlString !-repo-url is the URL of the GitHub repository to create the release in, such as "github.com/owner/repo".
Example
dagger -m github.com/kdihalas/dagger/release-please@9a0a4650b0db8e48b33140b4ca395de77002d6bf call \
 --token env:MYSECRET release-pr --release-type string --repo-url string
func (m *MyModule) Example(ctx context.Context, token *dagger.Secret, releaseType string, repoUrl string) string  {
	return dag.
			ReleasePlease(token).
			ReleasePr(ctx, releaseType, repoUrl)
}
@function
async def example(token: dagger.Secret, release_type: str, repo_url: str) -> str:
	return await (
		dag.release_please(token)
		.release_pr(release_type, repo_url)
	)
@func()
async example(token: Secret, releaseType: string, repoUrl: string): Promise<string> {
	return dag
		.releasePlease(token)
		.releasePr(releaseType, repoUrl)
}

run() 🔗

Run executes the release-please commands to create a release pull request and a GitHub release, and returns the combined output of both operations.

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
releaseTypeString !-release-type is the type of release to create, such as "node" or "python". This will determine the format of the release notes and the versioning scheme used by release-please.
repoUrlString !-repo-url is the URL of the GitHub repository to create the release in, such as "github.com/owner/repo".
Example
dagger -m github.com/kdihalas/dagger/release-please@9a0a4650b0db8e48b33140b4ca395de77002d6bf call \
 --token env:MYSECRET run --release-type string --repo-url string
func (m *MyModule) Example(ctx context.Context, token *dagger.Secret, releaseType string, repoUrl string) string  {
	return dag.
			ReleasePlease(token).
			Run(ctx, releaseType, repoUrl)
}
@function
async def example(token: dagger.Secret, release_type: str, repo_url: str) -> str:
	return await (
		dag.release_please(token)
		.run(release_type, repo_url)
	)
@func()
async example(token: Secret, releaseType: string, repoUrl: string): Promise<string> {
	return dag
		.releasePlease(token)
		.run(releaseType, repoUrl)
}