assay
Installation
Entrypoint
Types
Assay

assay

Assay Dagger module.

Installation

dagger install github.com/hseshadr/assay@562a3d68b8b5203678fe32e705c44119b324fb0b

Entrypoint

Return Type

Assay !

Arguments

Name	Type	Default Value	Description
workspace	Workspace	-	A Dagger workspace detected from the current working directory.

Example

dagger -m github.com/hseshadr/assay@562a3d68b8b5203678fe32e705c44119b324fb0b call \

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

@function
def example() -> dagger.Assay:
	return (
		dag.assay()
	)

@func()
example(): Assay {
	return dag
		.assay()
}

Types

Assay 🔗

Run the same typed Assay graph locally and on GitHub.

source() 🔗

Return Type

Directory !

Example

dagger -m github.com/hseshadr/assay@562a3d68b8b5203678fe32e705c44119b324fb0b call \
 source

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			Assay().
			Source()
}

@function
def example() -> dagger.Directory:
	return (
		dag.assay()
		.source()
	)

@func()
example(): Directory {
	return dag
		.assay()
		.source()
}

artifacts() 🔗

Build the exact three-artifact release envelope without publishing.

Return Type

Directory !

Example

dagger -m github.com/hseshadr/assay@562a3d68b8b5203678fe32e705c44119b324fb0b call \
 artifacts

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			Assay().
			Artifacts()
}

@function
def example() -> dagger.Directory:
	return (
		dag.assay()
		.artifacts()
	)

@func()
example(): Directory {
	return dag
		.assay()
		.artifacts()
}

ci() 🔗

Run Assay’s canonical gate sequentially to bound runner memory.

Return Type

String !

Arguments

Name	Type	Default Value	Description
commitSha	String !	""	No description provided

Example

dagger -m github.com/hseshadr/assay@562a3d68b8b5203678fe32e705c44119b324fb0b call \
 ci --commit-sha string

func (m *MyModule) Example(ctx context.Context, commitSha string) string  {
	return dag.
			Assay().
			Ci(ctx, commitSha)
}

@function
async def example(commitsha: str) -> str:
	return await (
		dag.assay()
		.ci(commitsha)
	)

@func()
async example(commitSha: string): Promise<string> {
	return dag
		.assay()
		.ci(commitSha)
}

publishNpm() 🔗

Publish one source-free npm artifact with OIDC provenance.

Return Type

String !

Arguments

Name	Type	Default Value	Description
candidate	Directory !	-	A directory.
expectedSha	String !	-	No description provided
oidcUrl	Secret !	-	A reference to a secret value, which can be handled more safely than the value itself.
oidcToken	Secret !	-	A reference to a secret value, which can be handled more safely than the value itself.
githubContext	File !	-	A file.

Example

dagger -m github.com/hseshadr/assay@562a3d68b8b5203678fe32e705c44119b324fb0b call \
 publish-npm --candidate DIR_PATH --expected-sha string --oidc-url env:MYSECRET --oidc-token env:MYSECRET --github-context file:path

func (m *MyModule) Example(ctx context.Context, candidate *dagger.Directory, expectedSha string, oidcUrl *dagger.Secret, oidcToken *dagger.Secret, githubContext *dagger.File) string  {
	return dag.
			Assay().
			Publishnpm(ctx, candidate, expectedSha, oidcUrl, oidcToken, githubContext)
}

@function
async def example(candidate: dagger.Directory, expectedsha: str, oidcurl: dagger.Secret, oidctoken: dagger.Secret, githubcontext: dagger.File) -> str:
	return await (
		dag.assay()
		.publishnpm(candidate, expectedsha, oidcurl, oidctoken, githubcontext)
	)

@func()
async example(candidate: Directory, expectedSha: string, oidcUrl: Secret, oidcToken: Secret, githubContext: File): Promise<string> {
	return dag
		.assay()
		.publishNpm(candidate, expectedSha, oidcUrl, oidcToken, githubContext)
}

pypiRequired() 🔗

Validate a source-free candidate and report whether PyPI is missing it.

Return Type

Boolean !

Arguments

Name	Type	Default Value	Description
candidate	Directory !	-	A directory.
expectedSha	String !	-	No description provided

Example

dagger -m github.com/hseshadr/assay@562a3d68b8b5203678fe32e705c44119b324fb0b call \
 pypi-required --candidate DIR_PATH --expected-sha string

func (m *MyModule) Example(ctx context.Context, candidate *dagger.Directory, expectedSha string) bool  {
	return dag.
			Assay().
			Pypirequired(ctx, candidate, expectedSha)
}

@function
async def example(candidate: dagger.Directory, expectedsha: str) -> bool:
	return await (
		dag.assay()
		.pypirequired(candidate, expectedsha)
	)

@func()
async example(candidate: Directory, expectedSha: string): Promise<boolean> {
	return dag
		.assay()
		.pypiRequired(candidate, expectedSha)
}

python() 🔗

Run lint, format, strict typing, Grade A complexity, and tests.

Return Type

Container !

Example

dagger -m github.com/hseshadr/assay@562a3d68b8b5203678fe32e705c44119b324fb0b call \
 python

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			Assay().
			Python()
}

@function
def example() -> dagger.Container:
	return (
		dag.assay()
		.python()
	)

@func()
example(): Container {
	return dag
		.assay()
		.python()
}

releaseCandidate() 🔗

Build one exact, Dagger-proven dual-package candidate.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
tag	String !	-	No description provided
commitSha	String !	-	No description provided
githubToken	Secret !	-	A reference to a secret value, which can be handled more safely than the value itself.

Example

dagger -m github.com/hseshadr/assay@562a3d68b8b5203678fe32e705c44119b324fb0b call \
 release-candidate --tag string --commit-sha string --github-token env:MYSECRET

func (m *MyModule) Example(tag string, commitSha string, githubToken *dagger.Secret) *dagger.Directory  {
	return dag.
			Assay().
			Releasecandidate(tag, commitSha, githubToken)
}

@function
def example(tag: str, commitsha: str, githubtoken: dagger.Secret) -> dagger.Directory:
	return (
		dag.assay()
		.releasecandidate(tag, commitsha, githubtoken)
	)

@func()
example(tag: string, commitSha: string, githubToken: Secret): Directory {
	return dag
		.assay()
		.releaseCandidate(tag, commitSha, githubToken)
}

security() 🔗

Run dependency, workflow, shell, snapshot, and history security.

Return Type

String !

Arguments

Name	Type	Default Value	Description
commitSha	String !	""	No description provided

Example

dagger -m github.com/hseshadr/assay@562a3d68b8b5203678fe32e705c44119b324fb0b call \
 security --commit-sha string

func (m *MyModule) Example(ctx context.Context, commitSha string) string  {
	return dag.
			Assay().
			Security(ctx, commitSha)
}

@function
async def example(commitsha: str) -> str:
	return await (
		dag.assay()
		.security(commitsha)
	)

@func()
async example(commitSha: string): Promise<string> {
	return dag
		.assay()
		.security(commitSha)
}

typescript() 🔗

Run the complete TypeScript quality and package-build gate.

Return Type

Container !

Example

dagger -m github.com/hseshadr/assay@562a3d68b8b5203678fe32e705c44119b324fb0b call \
 typescript

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			Assay().
			Typescript()
}

@function
def example() -> dagger.Container:
	return (
		dag.assay()
		.typescript()
	)

@func()
example(): Container {
	return dag
		.assay()
		.typescript()
}