dagger-badge
Installation
Entrypoint
Types
DaggerBadge
- link()
- addToReadme()

dagger-badge

Create a shield.io badge for your dagger project.

Installation

dagger install github.com/pjmagee/dagger-badge@262fbd7bcd8c80b4862b05983ec5faf64fdcf6b3

Entrypoint

Return Type

DaggerBadge !

Arguments

Name	Type	Default Value	Description
segmentPrefix	String !	"![Dagger]"	No description provided
imgShieldLink	String !	"https://img.shields.io/badge/dynamic/json"	No description provided
rawUrl	String !	-	The URL to the JSON file containing the version information

Example

dagger -m github.com/pjmagee/dagger-badge@262fbd7bcd8c80b4862b05983ec5faf64fdcf6b3 call \
 --segment-prefix string --img-shield-link string --raw-url string

func (m *myModule) example(segmentPrefix string, imgShieldLink string, rawUrl string) *DaggerBadge  {
	return dag.
			DaggerBadge(segmentPrefix, imgShieldLink, rawUrl)
}

@function
def example(segment_prefix: str, img_shield_link: str, raw_url: str) -> dag.DaggerBadge:
	return (
		dag.dagger_badge(segment_prefix, img_shield_link, raw_url)
	)

@func()
example(segmentPrefix: string, imgShieldLink: string, rawUrl: string): DaggerBadge {
	return dag
		.daggerBadge(segmentPrefix, imgShieldLink, rawUrl)
}

Types

DaggerBadge 🔗

Create a shield.io badge for your dagger project.

link() 🔗

Create a shield.io badge for your dagger project.

Return Type

String !

Example

dagger -m github.com/pjmagee/dagger-badge@262fbd7bcd8c80b4862b05983ec5faf64fdcf6b3 call \
 --segment-prefix string --img-shield-link string --raw-url string link

func (m *myModule) example(ctx context.Context, segmentPrefix string, imgShieldLink string, rawUrl string) string  {
	return dag.
			DaggerBadge(segmentPrefix, imgShieldLink, rawUrl).
			Link(ctx)
}

@function
async def example(segment_prefix: str, img_shield_link: str, raw_url: str) -> str:
	return await (
		dag.dagger_badge(segment_prefix, img_shield_link, raw_url)
		.link()
	)

@func()
async example(segmentPrefix: string, imgShieldLink: string, rawUrl: string): Promise<string> {
	return dag
		.daggerBadge(segmentPrefix, imgShieldLink, rawUrl)
		.link()
}

addToReadme() 🔗

Add the badge to the provided README file.

Return Type

File !

Arguments

Name	Type	Default Value	Description
file	File !	-	A file.

Example

dagger -m github.com/pjmagee/dagger-badge@262fbd7bcd8c80b4862b05983ec5faf64fdcf6b3 call \
 --segment-prefix string --img-shield-link string --raw-url string add-to-readme --file file:path

func (m *myModule) example(segmentPrefix string, imgShieldLink string, rawUrl string, file *File) *File  {
	return dag.
			DaggerBadge(segmentPrefix, imgShieldLink, rawUrl).
			AddToReadme(file)
}

@function
def example(segment_prefix: str, img_shield_link: str, raw_url: str, file: dagger.File) -> dagger.File:
	return (
		dag.dagger_badge(segment_prefix, img_shield_link, raw_url)
		.add_to_readme(file)
	)

@func()
example(segmentPrefix: string, imgShieldLink: string, rawUrl: string, file: File): File {
	return dag
		.daggerBadge(segmentPrefix, imgShieldLink, rawUrl)
		.addToReadme(file)
}