github

No long description provided.

Installation

dagger install github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df

Entrypoint

Return Type

Releases !

Arguments

Name	Type	Default Value	Description
client	Client !	-	No description provided
repository	String !	-	No description provided

Example

Function Releases.Constructor is not accessible from the github module

Function Releases.Constructor is not accessible from the github module

Function Releases.Constructor is not accessible from the github module

Function Releases.Constructor is not accessible from the github module

Entrypoint

Return Type

Release !

Arguments

Name	Type	Default Value	Description
url	String !	-	No description provided
htmlUrl	String !	-	No description provided
tarballUrl	String !	-	No description provided
zipballUrl	String !	-	No description provided
tagName	String !	-	No description provided
name	String !	-	No description provided
body	String !	-	No description provided
draft	Boolean !	-	No description provided
prerelease	Boolean !	-	No description provided
immutable	Boolean !	-	No description provided
assets	[ReleaseAsset ! ] !	-	No description provided

Example

Function Release.Constructor is not accessible from the github module

Function Release.Constructor is not accessible from the github module

Function Release.Constructor is not accessible from the github module

Function Release.Constructor is not accessible from the github module

Entrypoint

Return Type

Commit !

Arguments

Name	Type	Default Value	Description
sha	String !	-	No description provided

Example

Function Commit.Constructor is not accessible from the github module

Function Commit.Constructor is not accessible from the github module

Function Commit.Constructor is not accessible from the github module

Function Commit.Constructor is not accessible from the github module

Entrypoint

Return Type

ReleaseNotFound !

Arguments

Name	Type	Default Value	Description
repository	String !	-	No description provided
version	String !	-	No description provided
message	String	-	No description provided

Example

Function ReleaseNotFound.Constructor is not accessible from the github module

Function ReleaseNotFound.Constructor is not accessible from the github module

Function ReleaseNotFound.Constructor is not accessible from the github module

Function ReleaseNotFound.Constructor is not accessible from the github module

Entrypoint

Return Type

ReleaseAssetNotFound !

Arguments

Name	Type	Default Value	Description
name	String !	-	No description provided
release	Release !	-	No description provided
message	String	-	No description provided

Example

Function ReleaseAssetNotFound.Constructor is not accessible from the github module

Function ReleaseAssetNotFound.Constructor is not accessible from the github module

Function ReleaseAssetNotFound.Constructor is not accessible from the github module

Function ReleaseAssetNotFound.Constructor is not accessible from the github module

Entrypoint

Return Type

Github !

Arguments

Name	Type	Default Value	Description
repository	String	-	GitHub repository in one of the following formats: - `owner/repo` - `https://github.com/owner/repo[.git\|...]` - `git@github.com:owner/repo.git`
token	Secret	-	GitHub token

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \

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

@function
def example() -> dagger.Github:
	return (
		dag.github()
	)

@func()
example(): Github {
	return dag
		.github()
}

Entrypoint

Return Type

RepositoryNotFound !

Arguments

Name	Type	Default Value	Description
repository	String !	-	No description provided
message	String	-	No description provided

Example

Function RepositoryNotFound.Constructor is not accessible from the github module

Function RepositoryNotFound.Constructor is not accessible from the github module

Function RepositoryNotFound.Constructor is not accessible from the github module

Function RepositoryNotFound.Constructor is not accessible from the github module

Entrypoint

Return Type

ReleaseAsset !

Arguments

Name	Type	Default Value	Description
name	String !	-	No description provided
label	String	-	No description provided
contentType	String !	-	No description provided
size	Integer !	-	No description provided
digest	String	-	No description provided
downloadUrl	String !	-	No description provided

Example

Function ReleaseAsset.Constructor is not accessible from the github module

Function ReleaseAsset.Constructor is not accessible from the github module

Function ReleaseAsset.Constructor is not accessible from the github module

Function ReleaseAsset.Constructor is not accessible from the github module

Entrypoint

Return Type

Archive !

Example

Function Archive.Constructor is not accessible from the github module

Function Archive.Constructor is not accessible from the github module

Function Archive.Constructor is not accessible from the github module

Function Archive.Constructor is not accessible from the github module

Entrypoint

Return Type

Client !

Arguments

Name	Type	Default Value	Description
token	Secret	-	No description provided

Example

Function Client.Constructor is not accessible from the github module

Function Client.Constructor is not accessible from the github module

Function Client.Constructor is not accessible from the github module

Function Client.Constructor is not accessible from the github module

Types

Releases 🔗

A GitHub release.

latest() 🔗

Get the latest, non-draft, non-prerelease release.

Return Type

Release !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 releases \
 latest

func (m *MyModule) Example() *dagger.GithubRelease  {
	return dag.
			Github().
			Releases().
			Latest()
}

@function
def example() -> dagger.GithubRelease:
	return (
		dag.github()
		.releases()
		.latest()
	)

@func()
example(): GithubRelease {
	return dag
		.github()
		.releases()
		.latest()
}

get() 🔗

Get a GitHub release by version.

Return Type

Release !

Arguments

Name	Type	Default Value	Description
version	String !	-	Release tag, or null (or empty) for latest, non-draft, non-prerelease release.

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 releases \
 get --version string

func (m *MyModule) Example(version string) *dagger.GithubRelease  {
	return dag.
			Github().
			Releases().
			Get(version)
}

@function
def example(version: str) -> dagger.GithubRelease:
	return (
		dag.github()
		.releases()
		.get(version)
	)

@func()
example(version: string): GithubRelease {
	return dag
		.github()
		.releases()
		.get(version)
}

Release 🔗

A GitHub release.

url() 🔗

Return Type

String !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 url

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Github().
			Release().
			Url(ctx)
}

@function
async def example() -> str:
	return await (
		dag.github()
		.release()
		.url()
	)

@func()
async example(): Promise<string> {
	return dag
		.github()
		.release()
		.url()
}

htmlUrl() 🔗

Return Type

String !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 html-url

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Github().
			Release().
			Htmlurl(ctx)
}

@function
async def example() -> str:
	return await (
		dag.github()
		.release()
		.htmlurl()
	)

@func()
async example(): Promise<string> {
	return dag
		.github()
		.release()
		.htmlUrl()
}

tarballUrl() 🔗

Return Type

String !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 tarball-url

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Github().
			Release().
			Tarballurl(ctx)
}

@function
async def example() -> str:
	return await (
		dag.github()
		.release()
		.tarballurl()
	)

@func()
async example(): Promise<string> {
	return dag
		.github()
		.release()
		.tarballUrl()
}

zipballUrl() 🔗

Return Type

String !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 zipball-url

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Github().
			Release().
			Zipballurl(ctx)
}

@function
async def example() -> str:
	return await (
		dag.github()
		.release()
		.zipballurl()
	)

@func()
async example(): Promise<string> {
	return dag
		.github()
		.release()
		.zipballUrl()
}

tagName() 🔗

Return Type

String !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 tag-name

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Github().
			Release().
			Tagname(ctx)
}

@function
async def example() -> str:
	return await (
		dag.github()
		.release()
		.tagname()
	)

@func()
async example(): Promise<string> {
	return dag
		.github()
		.release()
		.tagName()
}

name() 🔗

Return Type

String !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 name

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Github().
			Release().
			Name(ctx)
}

@function
async def example() -> str:
	return await (
		dag.github()
		.release()
		.name()
	)

@func()
async example(): Promise<string> {
	return dag
		.github()
		.release()
		.name()
}

body() 🔗

Return Type

String !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 body

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Github().
			Release().
			Body(ctx)
}

@function
async def example() -> str:
	return await (
		dag.github()
		.release()
		.body()
	)

@func()
async example(): Promise<string> {
	return dag
		.github()
		.release()
		.body()
}

draft() 🔗

Return Type

Boolean !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 draft

func (m *MyModule) Example(ctx context.Context) bool  {
	return dag.
			Github().
			Release().
			Draft(ctx)
}

@function
async def example() -> bool:
	return await (
		dag.github()
		.release()
		.draft()
	)

@func()
async example(): Promise<boolean> {
	return dag
		.github()
		.release()
		.draft()
}

prerelease() 🔗

Return Type

Boolean !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 prerelease

func (m *MyModule) Example(ctx context.Context) bool  {
	return dag.
			Github().
			Release().
			Prerelease(ctx)
}

@function
async def example() -> bool:
	return await (
		dag.github()
		.release()
		.prerelease()
	)

@func()
async example(): Promise<boolean> {
	return dag
		.github()
		.release()
		.prerelease()
}

immutable() 🔗

Return Type

Boolean !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 immutable

func (m *MyModule) Example(ctx context.Context) bool  {
	return dag.
			Github().
			Release().
			Immutable(ctx)
}

@function
async def example() -> bool:
	return await (
		dag.github()
		.release()
		.immutable()
	)

@func()
async example(): Promise<boolean> {
	return dag
		.github()
		.release()
		.immutable()
}

assets() 🔗

Return Type

[ReleaseAsset ! ] !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 assets

func (m *MyModule) Example() []*dagger.GithubReleaseAsset  {
	return dag.
			Github().
			Release().
			Assets()
}

@function
def example() -> List[dagger.GithubReleaseAsset]:
	return (
		dag.github()
		.release()
		.assets()
	)

@func()
example(): GithubReleaseAsset[] {
	return dag
		.github()
		.release()
		.assets()
}

asset() 🔗

The asset with the given name, or an error if no such asset exists.

Return Type

ReleaseAsset !

Arguments

Name	Type	Default Value	Description
name	String !	-	No description provided

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 asset --name string

func (m *MyModule) Example(name string) *dagger.GithubReleaseAsset  {
	return dag.
			Github().
			Release().
			Asset(name)
}

@function
def example(name: str) -> dagger.GithubReleaseAsset:
	return (
		dag.github()
		.release()
		.asset(name)
	)

@func()
example(name: string): GithubReleaseAsset {
	return dag
		.github()
		.release()
		.asset(name)
}

Commit 🔗

sha() 🔗

Return Type

String !

Example

Function GithubCommit.sha is not accessible from the github module

Function GithubCommit.sha is not accessible from the github module

Function GithubCommit.sha is not accessible from the github module

Function GithubCommit.sha is not accessible from the github module

ReleaseNotFound 🔗

repository() 🔗

Return Type

String !

Example

Function GithubReleaseNotFound.repository is not accessible from the github module

Function GithubReleaseNotFound.repository is not accessible from the github module

Function GithubReleaseNotFound.repository is not accessible from the github module

Function GithubReleaseNotFound.repository is not accessible from the github module

version() 🔗

Return Type

String !

Example

Function GithubReleaseNotFound.version is not accessible from the github module

Function GithubReleaseNotFound.version is not accessible from the github module

Function GithubReleaseNotFound.version is not accessible from the github module

Function GithubReleaseNotFound.version is not accessible from the github module

message() 🔗

Return Type

String !

Example

Function GithubReleaseNotFound.message is not accessible from the github module

Function GithubReleaseNotFound.message is not accessible from the github module

Function GithubReleaseNotFound.message is not accessible from the github module

Function GithubReleaseNotFound.message is not accessible from the github module

ReleaseAssetNotFound 🔗

name() 🔗

Return Type

String !

Example

Function GithubReleaseAssetNotFound.name is not accessible from the github module

Function GithubReleaseAssetNotFound.name is not accessible from the github module

Function GithubReleaseAssetNotFound.name is not accessible from the github module

Function GithubReleaseAssetNotFound.name is not accessible from the github module

release() 🔗

Return Type

Release !

Example

Function GithubReleaseAssetNotFound.release is not accessible from the github module

Function GithubReleaseAssetNotFound.release is not accessible from the github module

Function GithubReleaseAssetNotFound.release is not accessible from the github module

Function GithubReleaseAssetNotFound.release is not accessible from the github module

message() 🔗

Return Type

String !

Example

Function GithubReleaseAssetNotFound.message is not accessible from the github module

Function GithubReleaseAssetNotFound.message is not accessible from the github module

Function GithubReleaseAssetNotFound.message is not accessible from the github module

Function GithubReleaseAssetNotFound.message is not accessible from the github module

Github 🔗

releases() 🔗

Interact with GitHub releases for the given repository.

Return Type

Releases !

Arguments

Name	Type	Default Value	Description
repository	String	-	No description provided

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 releases

func (m *MyModule) Example() *dagger.GithubReleases  {
	return dag.
			Github().
			Releases()
}

@function
def example() -> dagger.GithubReleases:
	return (
		dag.github()
		.releases()
	)

@func()
example(): GithubReleases {
	return dag
		.github()
		.releases()
}

release() 🔗

Get a GitHub release by version. Use null or an empty string for the latest release.

Return Type

Release !

Arguments

Name	Type	Default Value	Description
version	String	-	No description provided
repository	String	-	No description provided

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release

func (m *MyModule) Example() *dagger.GithubRelease  {
	return dag.
			Github().
			Release()
}

@function
def example() -> dagger.GithubRelease:
	return (
		dag.github()
		.release()
	)

@func()
example(): GithubRelease {
	return dag
		.github()
		.release()
}

commit() 🔗

Resolve a git ref (tag, branch or commit) to a commit SHA.

Return Type

String !

Arguments

Name	Type	Default Value	Description
ref	String !	-	No description provided
repository	String	-	No description provided

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 commit --ref string

func (m *MyModule) Example(ctx context.Context, ref string) string  {
	return dag.
			Github().
			Commit(ctx, ref)
}

@function
async def example(ref: str) -> str:
	return await (
		dag.github()
		.commit(ref)
	)

@func()
async example(ref: string): Promise<string> {
	return dag
		.github()
		.commit(ref)
}

RepositoryNotFound 🔗

repository() 🔗

Return Type

String !

Example

Function GithubRepositoryNotFound.repository is not accessible from the github module

Function GithubRepositoryNotFound.repository is not accessible from the github module

Function GithubRepositoryNotFound.repository is not accessible from the github module

Function GithubRepositoryNotFound.repository is not accessible from the github module

message() 🔗

Return Type

String !

Example

Function GithubRepositoryNotFound.message is not accessible from the github module

Function GithubRepositoryNotFound.message is not accessible from the github module

Function GithubRepositoryNotFound.message is not accessible from the github module

Function GithubRepositoryNotFound.message is not accessible from the github module

ReleaseAsset 🔗

A resolved GitHub release asset.

name() 🔗

Return Type

String !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 asset --name string \
 name

func (m *MyModule) Example(ctx context.Context, name string) string  {
	return dag.
			Github().
			Release().
			Asset(name).
			Name(ctx)
}

@function
async def example(name: str) -> str:
	return await (
		dag.github()
		.release()
		.asset(name)
		.name()
	)

@func()
async example(name: string): Promise<string> {
	return dag
		.github()
		.release()
		.asset(name)
		.name()
}

label() 🔗

Return Type

String

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 asset --name string \
 label

func (m *MyModule) Example(ctx context.Context, name string) string  {
	return dag.
			Github().
			Release().
			Asset(name).
			Label(ctx)
}

@function
async def example(name: str) -> str:
	return await (
		dag.github()
		.release()
		.asset(name)
		.label()
	)

@func()
async example(name: string): Promise<string> {
	return dag
		.github()
		.release()
		.asset(name)
		.label()
}

contentType() 🔗

Return Type

String !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 asset --name string \
 content-type

func (m *MyModule) Example(ctx context.Context, name string) string  {
	return dag.
			Github().
			Release().
			Asset(name).
			Contenttype(ctx)
}

@function
async def example(name: str) -> str:
	return await (
		dag.github()
		.release()
		.asset(name)
		.contenttype()
	)

@func()
async example(name: string): Promise<string> {
	return dag
		.github()
		.release()
		.asset(name)
		.contentType()
}

size() 🔗

Return Type

Integer !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 asset --name string \
 size

func (m *MyModule) Example(ctx context.Context, name string) int  {
	return dag.
			Github().
			Release().
			Asset(name).
			Size(ctx)
}

@function
async def example(name: str) -> int:
	return await (
		dag.github()
		.release()
		.asset(name)
		.size()
	)

@func()
async example(name: string): Promise<number> {
	return dag
		.github()
		.release()
		.asset(name)
		.size()
}

digest() 🔗

Return Type

String

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 asset --name string \
 digest

func (m *MyModule) Example(ctx context.Context, name string) string  {
	return dag.
			Github().
			Release().
			Asset(name).
			Digest(ctx)
}

@function
async def example(name: str) -> str:
	return await (
		dag.github()
		.release()
		.asset(name)
		.digest()
	)

@func()
async example(name: string): Promise<string> {
	return dag
		.github()
		.release()
		.asset(name)
		.digest()
}

downloadUrl() 🔗

Return Type

String !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 asset --name string \
 download-url

func (m *MyModule) Example(ctx context.Context, name string) string  {
	return dag.
			Github().
			Release().
			Asset(name).
			Downloadurl(ctx)
}

@function
async def example(name: str) -> str:
	return await (
		dag.github()
		.release()
		.asset(name)
		.downloadurl()
	)

@func()
async example(name: string): Promise<string> {
	return dag
		.github()
		.release()
		.asset(name)
		.downloadUrl()
}

file() 🔗

Downloaded asset file with GitHub’s asset digest enforced by Dagger.

Return Type

File !

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 asset --name string \
 file

func (m *MyModule) Example(name string) *dagger.File  {
	return dag.
			Github().
			Release().
			Asset(name).
			File()
}

@function
def example(name: str) -> dagger.File:
	return (
		dag.github()
		.release()
		.asset(name)
		.file()
	)

@func()
example(name: string): File {
	return dag
		.github()
		.release()
		.asset(name)
		.file()
}

extracted() 🔗

Downloaded and extracted asset file.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
stripParent	Boolean	-	If stripParent is true, the parent directory will be stripped from the extracted file.
stripComponents	Integer	-	Number of components to strip from the extracted file.

Example

dagger -m github.com/mhmxs/daggerverse/github@ba2b09540a0351012161fb13386babfdacc081df call \
 release \
 asset --name string \
 extracted

func (m *MyModule) Example(name string) *dagger.Directory  {
	return dag.
			Github().
			Release().
			Asset(name).
			Extracted()
}

@function
def example(name: str) -> dagger.Directory:
	return (
		dag.github()
		.release()
		.asset(name)
		.extracted()
	)

@func()
example(name: string): Directory {
	return dag
		.github()
		.release()
		.asset(name)
		.extracted()
}

Archive 🔗

Client 🔗

baseUrl() 🔗

Return Type

String !

Example

Function GithubClient.baseUrl is not accessible from the github module

Function GithubClient.baseUrl is not accessible from the github module

Function GithubClient.baseUrl is not accessible from the github module

Function GithubClient.baseUrl is not accessible from the github module

appendPath() 🔗

Return Type

Client !

Arguments

Name	Type	Default Value	Description
path	String !	-	No description provided

Example

Function GithubClient.appendPath is not accessible from the github module

Function GithubClient.appendPath is not accessible from the github module

Function GithubClient.appendPath is not accessible from the github module

Function GithubClient.appendPath is not accessible from the github module

http() 🔗

Return Type

File !

Arguments

Name	Type	Default Value	Description
url	String !	-	No description provided

Example

Function GithubClient.http is not accessible from the github module

Function GithubClient.http is not accessible from the github module

Function GithubClient.http is not accessible from the github module

Function GithubClient.http is not accessible from the github module

get() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
url	String !	-	No description provided

Example

Function GithubClient.get is not accessible from the github module

Function GithubClient.get is not accessible from the github module

Function GithubClient.get is not accessible from the github module

Function GithubClient.get is not accessible from the github module