Dagger
Search

forge

A generated module for Forge functions

Installation

dagger install github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083

Entrypoint

Return Type 
Forge
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \

func (m *MyModule) Example() *dagger.Forge  {
	return dag.
			Forge()
}
@function
def example() -> dagger.Forge:
	return (
		dag.forge()
	)
@func()
example(): Forge {
	return dag
		.forge()
}

Types

Forge 🔗

Forge is the struct that methods are defined on for forge's Dagger module.

use() 🔗

Use creates a container to execute a GitHub Action in.

Return Type 
PreAction !
Arguments
NameTypeDefault ValueDescription
actionString !-No description provided
repoDirectory -No description provided
workspaceDirectory -No description provided
with[String ! ] -No description provided
env[String ! ] -No description provided
debugBoolean -No description provided
tokenSecret -No description provided
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string
func (m *MyModule) Example(action string) *dagger.ForgePreAction  {
	return dag.
			Forge().
			Use(action)
}
@function
def example(action: str) -> dagger.ForgePreAction:
	return (
		dag.forge()
		.use(action)
	)
@func()
example(action: string): ForgePreAction {
	return dag
		.forge()
		.use(action)
}

cloudbuild() 🔗

Return Type 
Cloudbuild !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
workdirDirectory -No description provided
entrypoint[String ! ] -No description provided
args[String ! ] -No description provided
env[String ! ] -No description provided
gcloudConfigDirectory -No description provided
scriptFile -No description provided
substitutions[String ! ] -No description provided
dynamicSubstitutionsBoolean -No description provided
automapSubstitutionsBoolean -No description provided
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string
func (m *MyModule) Example(name string) *dagger.ForgeCloudbuild  {
	return dag.
			Forge().
			Cloudbuild(name)
}
@function
def example(name: str) -> dagger.ForgeCloudbuild:
	return (
		dag.forge()
		.cloudbuild(name)
	)
@func()
example(name: string): ForgeCloudbuild {
	return dag
		.forge()
		.cloudbuild(name)
}

resource() 🔗

Return Type 
Resource !
Arguments
NameTypeDefault ValueDescription
resourceString !-No description provided
pipelineFile -No description provided
workdirDirectory -No description provided
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 resource --resource string
func (m *MyModule) Example(resource string) *dagger.ForgeResource  {
	return dag.
			Forge().
			Resource(resource)
}
@function
def example(resource: str) -> dagger.ForgeResource:
	return (
		dag.forge()
		.resource(resource)
	)
@func()
example(resource: string): ForgeResource {
	return dag
		.forge()
		.resource(resource)
}

PreAction 🔗

PreAction has a container that's prepared to execute an action and the subpath to that action, but has not yet executed the pre-step.

action() 🔗

Return Type 
Action !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 action
func (m *MyModule) Example(action string) *dagger.ForgeAction  {
	return dag.
			Forge().
			Use(action).
			Action()
}
@function
def example(action: str) -> dagger.ForgeAction:
	return (
		dag.forge()
		.use(action)
		.action()
	)
@func()
example(action: string): ForgeAction {
	return dag
		.forge()
		.use(action)
		.action()
}

pre() 🔗

Pre executes the pre-step of the GitHub Action in the underlying container.

Return Type 
Action !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre
func (m *MyModule) Example(action string) *dagger.ForgeAction  {
	return dag.
			Forge().
			Use(action).
			Pre()
}
@function
def example(action: str) -> dagger.ForgeAction:
	return (
		dag.forge()
		.use(action)
		.pre()
	)
@func()
example(action: string): ForgeAction {
	return dag
		.forge()
		.use(action)
		.pre()
}

main() 🔗

Main executes the pre- and main steps of the GitHub Action in the underlying container.

Return Type 
PostAction !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main
func (m *MyModule) Example(action string) *dagger.ForgePostAction  {
	return dag.
			Forge().
			Use(action).
			Main()
}
@function
def example(action: str) -> dagger.ForgePostAction:
	return (
		dag.forge()
		.use(action)
		.main()
	)
@func()
example(action: string): ForgePostAction {
	return dag
		.forge()
		.use(action)
		.main()
}

post() 🔗

Post executes the pre-, main and post-steps of the GitHub Action in the underlying container.

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 post
func (m *MyModule) Example(action string) *dagger.Container  {
	return dag.
			Forge().
			Use(action).
			Post()
}
@function
def example(action: str) -> dagger.Container:
	return (
		dag.forge()
		.use(action)
		.post()
	)
@func()
example(action: string): Container {
	return dag
		.forge()
		.use(action)
		.post()
}

withInput() 🔗

Return Type 
PreAction !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
valueString !-No description provided
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 with-input --name string --value string
func (m *MyModule) Example(action string, name string, value string) *dagger.ForgePreAction  {
	return dag.
			Forge().
			Use(action).
			WithInput(name, value)
}
@function
def example(action: str, name: str, value: str) -> dagger.ForgePreAction:
	return (
		dag.forge()
		.use(action)
		.with_input(name, value)
	)
@func()
example(action: string, name: string, value: string): ForgePreAction {
	return dag
		.forge()
		.use(action)
		.withInput(name, value)
}

withEnv() 🔗

Return Type 
PreAction !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
valueString !-No description provided
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 with-env --name string --value string
func (m *MyModule) Example(action string, name string, value string) *dagger.ForgePreAction  {
	return dag.
			Forge().
			Use(action).
			WithEnv(name, value)
}
@function
def example(action: str, name: str, value: str) -> dagger.ForgePreAction:
	return (
		dag.forge()
		.use(action)
		.with_env(name, value)
	)
@func()
example(action: string, name: string, value: string): ForgePreAction {
	return dag
		.forge()
		.use(action)
		.withEnv(name, value)
}

withToken() 🔗

Return Type 
PreAction !
Arguments
NameTypeDefault ValueDescription
tokenSecret !-No description provided
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 with-token --token env:MYSECRET
func (m *MyModule) Example(action string, token *dagger.Secret) *dagger.ForgePreAction  {
	return dag.
			Forge().
			Use(action).
			WithToken(token)
}
@function
def example(action: str, token: dagger.Secret) -> dagger.ForgePreAction:
	return (
		dag.forge()
		.use(action)
		.with_token(token)
	)
@func()
example(action: string, token: Secret): ForgePreAction {
	return dag
		.forge()
		.use(action)
		.withToken(token)
}

withDebug() 🔗

Return Type 
PreAction !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 with-debug
func (m *MyModule) Example(action string) *dagger.ForgePreAction  {
	return dag.
			Forge().
			Use(action).
			WithDebug()
}
@function
def example(action: str) -> dagger.ForgePreAction:
	return (
		dag.forge()
		.use(action)
		.with_debug()
	)
@func()
example(action: string): ForgePreAction {
	return dag
		.forge()
		.use(action)
		.withDebug()
}

container() 🔗

Container gives access to the underlying container.

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 container
func (m *MyModule) Example(action string) *dagger.Container  {
	return dag.
			Forge().
			Use(action).
			Container()
}
@function
def example(action: str) -> dagger.Container:
	return (
		dag.forge()
		.use(action)
		.container()
	)
@func()
example(action: string): Container {
	return dag
		.forge()
		.use(action)
		.container()
}

terminal() 🔗

Terminal is a convenient alias for Container().Terminal().

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 terminal
func (m *MyModule) Example(action string) *dagger.Container  {
	return dag.
			Forge().
			Use(action).
			Terminal()
}
@function
def example(action: str) -> dagger.Container:
	return (
		dag.forge()
		.use(action)
		.terminal()
	)
@func()
example(action: string): Container {
	return dag
		.forge()
		.use(action)
		.terminal()
}

stdout() 🔗

Stdout is a convenient alias for Container().Stdout().

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 stdout
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Stdout(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.stdout()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.stdout()
}

stderr() 🔗

Stderr is a convenient alias for Container().Stderr().

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 stderr
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Stderr(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.stderr()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.stderr()
}

combinedOutput() 🔗

CombinedOutput is a convenient alias for Container().CombinedOutput().

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 combined-output
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			CombinedOutput(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.combined_output()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.combinedOutput()
}

workspace() 🔗

Workspace returns the current state of the GITHUB_WORKSPACE directory.

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 workspace
func (m *MyModule) Example(action string) *dagger.Directory  {
	return dag.
			Forge().
			Use(action).
			Workspace()
}
@function
def example(action: str) -> dagger.Directory:
	return (
		dag.forge()
		.use(action)
		.workspace()
	)
@func()
example(action: string): Directory {
	return dag
		.forge()
		.use(action)
		.workspace()
}

toolcache() 🔗

Toolcache returns the current state of the RUNNER_TOOLCACHE directory.

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 toolcache
func (m *MyModule) Example(action string) *dagger.Directory  {
	return dag.
			Forge().
			Use(action).
			Toolcache()
}
@function
def example(action: str) -> dagger.Directory:
	return (
		dag.forge()
		.use(action)
		.toolcache()
	)
@func()
example(action: string): Directory {
	return dag
		.forge()
		.use(action)
		.toolcache()
}

home() 🔗

Home returns the current state of the HOME directory.

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 home
func (m *MyModule) Example(action string) *dagger.Directory  {
	return dag.
			Forge().
			Use(action).
			Home()
}
@function
def example(action: str) -> dagger.Directory:
	return (
		dag.forge()
		.use(action)
		.home()
	)
@func()
example(action: string): Directory {
	return dag
		.forge()
		.use(action)
		.home()
}

env() 🔗

Env returns the parsed key-value pairs that were saved to GITHUB_ENV.

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 env
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Env(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.env()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.env()
}

state() 🔗

State returns the parsed key-value pairs that were saved to GITHUB_STATE.

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 state
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			State(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.state()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.state()
}

output() 🔗

Output returns the parsed key-value pairs that were saved to GITHUB_OUTPUT.

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 output
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Output(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.output()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.output()
}

Cloudbuild 🔗

finalizedCloudbuild() 🔗

Return Type 
FinalizedCloudbuild !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 finalized-cloudbuild
func (m *MyModule) Example(name string) *dagger.ForgeFinalizedCloudbuild  {
	return dag.
			Forge().
			Cloudbuild(name).
			FinalizedCloudbuild()
}
@function
def example(name: str) -> dagger.ForgeFinalizedCloudbuild:
	return (
		dag.forge()
		.cloudbuild(name)
		.finalized_cloudbuild()
	)
@func()
example(name: string): ForgeFinalizedCloudbuild {
	return dag
		.forge()
		.cloudbuild(name)
		.finalizedCloudbuild()
}

run() 🔗

Run executes the cloudbuild.

Return Type 
FinalizedCloudbuild !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 run
func (m *MyModule) Example(name string) *dagger.ForgeFinalizedCloudbuild  {
	return dag.
			Forge().
			Cloudbuild(name).
			Run()
}
@function
def example(name: str) -> dagger.ForgeFinalizedCloudbuild:
	return (
		dag.forge()
		.cloudbuild(name)
		.run()
	)
@func()
example(name: string): ForgeFinalizedCloudbuild {
	return dag
		.forge()
		.cloudbuild(name)
		.run()
}

container() 🔗

Container gives access to the underlying container.

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 container
func (m *MyModule) Example(name string) *dagger.Container  {
	return dag.
			Forge().
			Cloudbuild(name).
			Container()
}
@function
def example(name: str) -> dagger.Container:
	return (
		dag.forge()
		.cloudbuild(name)
		.container()
	)
@func()
example(name: string): Container {
	return dag
		.forge()
		.cloudbuild(name)
		.container()
}

terminal() 🔗

Terminal is a convenient alias for Container().Terminal().

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 terminal
func (m *MyModule) Example(name string) *dagger.Container  {
	return dag.
			Forge().
			Cloudbuild(name).
			Terminal()
}
@function
def example(name: str) -> dagger.Container:
	return (
		dag.forge()
		.cloudbuild(name)
		.terminal()
	)
@func()
example(name: string): Container {
	return dag
		.forge()
		.cloudbuild(name)
		.terminal()
}

stdout() 🔗

Stdout is a convenient alias for Container().Stdout().

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 stdout
func (m *MyModule) Example(ctx context.Context, name string) string  {
	return dag.
			Forge().
			Cloudbuild(name).
			Stdout(ctx)
}
@function
async def example(name: str) -> str:
	return await (
		dag.forge()
		.cloudbuild(name)
		.stdout()
	)
@func()
async example(name: string): Promise<string> {
	return dag
		.forge()
		.cloudbuild(name)
		.stdout()
}

stderr() 🔗

Stderr is a convenient alias for Container().Stderr().

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 stderr
func (m *MyModule) Example(ctx context.Context, name string) string  {
	return dag.
			Forge().
			Cloudbuild(name).
			Stderr(ctx)
}
@function
async def example(name: str) -> str:
	return await (
		dag.forge()
		.cloudbuild(name)
		.stderr()
	)
@func()
async example(name: string): Promise<string> {
	return dag
		.forge()
		.cloudbuild(name)
		.stderr()
}

combinedOutput() 🔗

CombinedOutput is a convenient alias for Container().CombinedOutput().

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 combined-output
func (m *MyModule) Example(ctx context.Context, name string) string  {
	return dag.
			Forge().
			Cloudbuild(name).
			CombinedOutput(ctx)
}
@function
async def example(name: str) -> str:
	return await (
		dag.forge()
		.cloudbuild(name)
		.combined_output()
	)
@func()
async example(name: string): Promise<string> {
	return dag
		.forge()
		.cloudbuild(name)
		.combinedOutput()
}

workspace() 🔗

Workspace returns the current state of the /workspace directory.

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 workspace
func (m *MyModule) Example(name string) *dagger.Directory  {
	return dag.
			Forge().
			Cloudbuild(name).
			Workspace()
}
@function
def example(name: str) -> dagger.Directory:
	return (
		dag.forge()
		.cloudbuild(name)
		.workspace()
	)
@func()
example(name: string): Directory {
	return dag
		.forge()
		.cloudbuild(name)
		.workspace()
}

workdir() 🔗

Workdir returns the current state of the working directory.

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 workdir
func (m *MyModule) Example(name string) *dagger.Directory  {
	return dag.
			Forge().
			Cloudbuild(name).
			Workdir()
}
@function
def example(name: str) -> dagger.Directory:
	return (
		dag.forge()
		.cloudbuild(name)
		.workdir()
	)
@func()
example(name: string): Directory {
	return dag
		.forge()
		.cloudbuild(name)
		.workdir()
}

Resource 🔗

finalizedResource() 🔗

Return Type 
FinalizedResource !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 resource --resource string \
 finalized-resource
func (m *MyModule) Example(resource string) *dagger.ForgeFinalizedResource  {
	return dag.
			Forge().
			Resource(resource).
			FinalizedResource()
}
@function
def example(resource: str) -> dagger.ForgeFinalizedResource:
	return (
		dag.forge()
		.resource(resource)
		.finalized_resource()
	)
@func()
example(resource: string): ForgeFinalizedResource {
	return dag
		.forge()
		.resource(resource)
		.finalizedResource()
}

source() 🔗

Return Type 
[String ! ] !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 resource --resource string \
 source
func (m *MyModule) Example(ctx context.Context, resource string) []string  {
	return dag.
			Forge().
			Resource(resource).
			Source(ctx)
}
@function
async def example(resource: str) -> List[str]:
	return await (
		dag.forge()
		.resource(resource)
		.source()
	)
@func()
async example(resource: string): Promise<string[]> {
	return dag
		.forge()
		.resource(resource)
		.source()
}

get() 🔗

Get runs the get step.

Return Type 
FinalizedResource !
Arguments
NameTypeDefault ValueDescription
version[String ! ] -No description provided
param[String ! ] -No description provided
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 resource --resource string \
 get
func (m *MyModule) Example(resource string) *dagger.ForgeFinalizedResource  {
	return dag.
			Forge().
			Resource(resource).
			Get()
}
@function
def example(resource: str) -> dagger.ForgeFinalizedResource:
	return (
		dag.forge()
		.resource(resource)
		.get()
	)
@func()
example(resource: string): ForgeFinalizedResource {
	return dag
		.forge()
		.resource(resource)
		.get()
}

check() 🔗

Check runs the check step.

Return Type 
FinalizedResource !
Arguments
NameTypeDefault ValueDescription
version[String ! ] -No description provided
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 resource --resource string \
 check
func (m *MyModule) Example(resource string) *dagger.ForgeFinalizedResource  {
	return dag.
			Forge().
			Resource(resource).
			Check()
}
@function
def example(resource: str) -> dagger.ForgeFinalizedResource:
	return (
		dag.forge()
		.resource(resource)
		.check()
	)
@func()
example(resource: string): ForgeFinalizedResource {
	return dag
		.forge()
		.resource(resource)
		.check()
}

put() 🔗

Put runs the put step.

Return Type 
FinalizedResource !
Arguments
NameTypeDefault ValueDescription
param[String ! ] -No description provided
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 resource --resource string \
 put
func (m *MyModule) Example(resource string) *dagger.ForgeFinalizedResource  {
	return dag.
			Forge().
			Resource(resource).
			Put()
}
@function
def example(resource: str) -> dagger.ForgeFinalizedResource:
	return (
		dag.forge()
		.resource(resource)
		.put()
	)
@func()
example(resource: string): ForgeFinalizedResource {
	return dag
		.forge()
		.resource(resource)
		.put()
}

container() 🔗

Container gives access to the underlying container.

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 resource --resource string \
 container
func (m *MyModule) Example(resource string) *dagger.Container  {
	return dag.
			Forge().
			Resource(resource).
			Container()
}
@function
def example(resource: str) -> dagger.Container:
	return (
		dag.forge()
		.resource(resource)
		.container()
	)
@func()
example(resource: string): Container {
	return dag
		.forge()
		.resource(resource)
		.container()
}

terminal() 🔗

Terminal is a convenient alias for Container().Terminal().

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 resource --resource string \
 terminal
func (m *MyModule) Example(resource string) *dagger.Container  {
	return dag.
			Forge().
			Resource(resource).
			Terminal()
}
@function
def example(resource: str) -> dagger.Container:
	return (
		dag.forge()
		.resource(resource)
		.terminal()
	)
@func()
example(resource: string): Container {
	return dag
		.forge()
		.resource(resource)
		.terminal()
}

workdir() 🔗

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 resource --resource string \
 workdir
func (m *MyModule) Example(resource string) *dagger.Directory  {
	return dag.
			Forge().
			Resource(resource).
			Workdir()
}
@function
def example(resource: str) -> dagger.Directory:
	return (
		dag.forge()
		.resource(resource)
		.workdir()
	)
@func()
example(resource: string): Directory {
	return dag
		.forge()
		.resource(resource)
		.workdir()
}

Action 🔗

Action has a container that's prepared to execute an action and the subpath to that action, but has not yet executed the main step.

postAction() 🔗

Return Type 
PostAction !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 post-action
func (m *MyModule) Example(action string) *dagger.ForgePostAction  {
	return dag.
			Forge().
			Use(action).
			Pre().
			PostAction()
}
@function
def example(action: str) -> dagger.ForgePostAction:
	return (
		dag.forge()
		.use(action)
		.pre()
		.post_action()
	)
@func()
example(action: string): ForgePostAction {
	return dag
		.forge()
		.use(action)
		.pre()
		.postAction()
}

main() 🔗

Main executes the main step of the GitHub Action in the underlying container.

Return Type 
PostAction !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 main
func (m *MyModule) Example(action string) *dagger.ForgePostAction  {
	return dag.
			Forge().
			Use(action).
			Pre().
			Main()
}
@function
def example(action: str) -> dagger.ForgePostAction:
	return (
		dag.forge()
		.use(action)
		.pre()
		.main()
	)
@func()
example(action: string): ForgePostAction {
	return dag
		.forge()
		.use(action)
		.pre()
		.main()
}

post() 🔗

Post executes the main and post-steps of the GitHub Action in the underlying container.

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 post
func (m *MyModule) Example(action string) *dagger.Container  {
	return dag.
			Forge().
			Use(action).
			Pre().
			Post()
}
@function
def example(action: str) -> dagger.Container:
	return (
		dag.forge()
		.use(action)
		.pre()
		.post()
	)
@func()
example(action: string): Container {
	return dag
		.forge()
		.use(action)
		.pre()
		.post()
}

withInput() 🔗

Return Type 
Action !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
valueString !-No description provided
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 with-input --name string --value string
func (m *MyModule) Example(action string, name string, value string) *dagger.ForgeAction  {
	return dag.
			Forge().
			Use(action).
			Pre().
			WithInput(name, value)
}
@function
def example(action: str, name: str, value: str) -> dagger.ForgeAction:
	return (
		dag.forge()
		.use(action)
		.pre()
		.with_input(name, value)
	)
@func()
example(action: string, name: string, value: string): ForgeAction {
	return dag
		.forge()
		.use(action)
		.pre()
		.withInput(name, value)
}

withEnv() 🔗

Return Type 
Action !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
valueString !-No description provided
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 with-env --name string --value string
func (m *MyModule) Example(action string, name string, value string) *dagger.ForgeAction  {
	return dag.
			Forge().
			Use(action).
			Pre().
			WithEnv(name, value)
}
@function
def example(action: str, name: str, value: str) -> dagger.ForgeAction:
	return (
		dag.forge()
		.use(action)
		.pre()
		.with_env(name, value)
	)
@func()
example(action: string, name: string, value: string): ForgeAction {
	return dag
		.forge()
		.use(action)
		.pre()
		.withEnv(name, value)
}

withToken() 🔗

Return Type 
Action !
Arguments
NameTypeDefault ValueDescription
tokenSecret !-No description provided
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 with-token --token env:MYSECRET
func (m *MyModule) Example(action string, token *dagger.Secret) *dagger.ForgeAction  {
	return dag.
			Forge().
			Use(action).
			Pre().
			WithToken(token)
}
@function
def example(action: str, token: dagger.Secret) -> dagger.ForgeAction:
	return (
		dag.forge()
		.use(action)
		.pre()
		.with_token(token)
	)
@func()
example(action: string, token: Secret): ForgeAction {
	return dag
		.forge()
		.use(action)
		.pre()
		.withToken(token)
}

withDebug() 🔗

Return Type 
Action !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 with-debug
func (m *MyModule) Example(action string) *dagger.ForgeAction  {
	return dag.
			Forge().
			Use(action).
			Pre().
			WithDebug()
}
@function
def example(action: str) -> dagger.ForgeAction:
	return (
		dag.forge()
		.use(action)
		.pre()
		.with_debug()
	)
@func()
example(action: string): ForgeAction {
	return dag
		.forge()
		.use(action)
		.pre()
		.withDebug()
}

container() 🔗

Container gives access to the underlying container.

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 container
func (m *MyModule) Example(action string) *dagger.Container  {
	return dag.
			Forge().
			Use(action).
			Pre().
			Container()
}
@function
def example(action: str) -> dagger.Container:
	return (
		dag.forge()
		.use(action)
		.pre()
		.container()
	)
@func()
example(action: string): Container {
	return dag
		.forge()
		.use(action)
		.pre()
		.container()
}

terminal() 🔗

Terminal is a convenient alias for Container().Terminal().

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 terminal
func (m *MyModule) Example(action string) *dagger.Container  {
	return dag.
			Forge().
			Use(action).
			Pre().
			Terminal()
}
@function
def example(action: str) -> dagger.Container:
	return (
		dag.forge()
		.use(action)
		.pre()
		.terminal()
	)
@func()
example(action: string): Container {
	return dag
		.forge()
		.use(action)
		.pre()
		.terminal()
}

stdout() 🔗

Stdout is a convenient alias for Container().Stdout().

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 stdout
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Pre().
			Stdout(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.pre()
		.stdout()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.pre()
		.stdout()
}

stderr() 🔗

Stderr is a convenient alias for Container().Stderr().

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 stderr
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Pre().
			Stderr(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.pre()
		.stderr()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.pre()
		.stderr()
}

combinedOutput() 🔗

CombinedOutput is a convenient alias for Container().CombinedOutput().

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 combined-output
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Pre().
			CombinedOutput(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.pre()
		.combined_output()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.pre()
		.combinedOutput()
}

workspace() 🔗

Workspace returns the current state of the GITHUB_WORKSPACE directory.

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 workspace
func (m *MyModule) Example(action string) *dagger.Directory  {
	return dag.
			Forge().
			Use(action).
			Pre().
			Workspace()
}
@function
def example(action: str) -> dagger.Directory:
	return (
		dag.forge()
		.use(action)
		.pre()
		.workspace()
	)
@func()
example(action: string): Directory {
	return dag
		.forge()
		.use(action)
		.pre()
		.workspace()
}

toolcache() 🔗

Toolcache returns the current state of the RUNNER_TOOLCACHE directory.

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 toolcache
func (m *MyModule) Example(action string) *dagger.Directory  {
	return dag.
			Forge().
			Use(action).
			Pre().
			Toolcache()
}
@function
def example(action: str) -> dagger.Directory:
	return (
		dag.forge()
		.use(action)
		.pre()
		.toolcache()
	)
@func()
example(action: string): Directory {
	return dag
		.forge()
		.use(action)
		.pre()
		.toolcache()
}

action() 🔗

Action returns the current state of the GITHUB_ACTION_PATH directory.

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 action
func (m *MyModule) Example(action string) *dagger.Directory  {
	return dag.
			Forge().
			Use(action).
			Pre().
			Action()
}
@function
def example(action: str) -> dagger.Directory:
	return (
		dag.forge()
		.use(action)
		.pre()
		.action()
	)
@func()
example(action: string): Directory {
	return dag
		.forge()
		.use(action)
		.pre()
		.action()
}

home() 🔗

Home returns the current state of the HOME directory.

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 home
func (m *MyModule) Example(action string) *dagger.Directory  {
	return dag.
			Forge().
			Use(action).
			Pre().
			Home()
}
@function
def example(action: str) -> dagger.Directory:
	return (
		dag.forge()
		.use(action)
		.pre()
		.home()
	)
@func()
example(action: string): Directory {
	return dag
		.forge()
		.use(action)
		.pre()
		.home()
}

env() 🔗

Env returns the parsed key-value pairs that were saved to GITHUB_ENV.

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 env
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Pre().
			Env(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.pre()
		.env()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.pre()
		.env()
}

state() 🔗

State returns the parsed key-value pairs that were saved to GITHUB_STATE.

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 state
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Pre().
			State(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.pre()
		.state()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.pre()
		.state()
}

output() 🔗

Output returns the parsed key-value pairs that were saved to GITHUB_OUTPUT.

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 pre \
 output
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Pre().
			Output(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.pre()
		.output()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.pre()
		.output()
}

PostAction 🔗

PostAction has a container that's prepared to execute an action and the subpath to that action, but has not yet executed the post-step.

finalizedAction() 🔗

Return Type 
FinalizedAction !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 finalized-action
func (m *MyModule) Example(action string) *dagger.ForgeFinalizedAction  {
	return dag.
			Forge().
			Use(action).
			Main().
			FinalizedAction()
}
@function
def example(action: str) -> dagger.ForgeFinalizedAction:
	return (
		dag.forge()
		.use(action)
		.main()
		.finalized_action()
	)
@func()
example(action: string): ForgeFinalizedAction {
	return dag
		.forge()
		.use(action)
		.main()
		.finalizedAction()
}

metadata() 🔗

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 metadata
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Main().
			Metadata(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.main()
		.metadata()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.main()
		.metadata()
}

subpath() 🔗

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 subpath
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Main().
			Subpath(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.main()
		.subpath()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.main()
		.subpath()
}

inputs() 🔗

Return Type 
[String ! ] !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 inputs
func (m *MyModule) Example(ctx context.Context, action string) []string  {
	return dag.
			Forge().
			Use(action).
			Main().
			Inputs(ctx)
}
@function
async def example(action: str) -> List[str]:
	return await (
		dag.forge()
		.use(action)
		.main()
		.inputs()
	)
@func()
async example(action: string): Promise<string[]> {
	return dag
		.forge()
		.use(action)
		.main()
		.inputs()
}

post() 🔗

Post executes the post-step of the GitHub Action in the underlying container.

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 post
func (m *MyModule) Example(action string) *dagger.Container  {
	return dag.
			Forge().
			Use(action).
			Main().
			Post()
}
@function
def example(action: str) -> dagger.Container:
	return (
		dag.forge()
		.use(action)
		.main()
		.post()
	)
@func()
example(action: string): Container {
	return dag
		.forge()
		.use(action)
		.main()
		.post()
}

withInput() 🔗

Return Type 
PostAction !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
valueString !-No description provided
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 with-input --name string --value string
func (m *MyModule) Example(action string, name string, value string) *dagger.ForgePostAction  {
	return dag.
			Forge().
			Use(action).
			Main().
			WithInput(name, value)
}
@function
def example(action: str, name: str, value: str) -> dagger.ForgePostAction:
	return (
		dag.forge()
		.use(action)
		.main()
		.with_input(name, value)
	)
@func()
example(action: string, name: string, value: string): ForgePostAction {
	return dag
		.forge()
		.use(action)
		.main()
		.withInput(name, value)
}

withEnv() 🔗

Return Type 
PostAction !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
valueString !-No description provided
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 with-env --name string --value string
func (m *MyModule) Example(action string, name string, value string) *dagger.ForgePostAction  {
	return dag.
			Forge().
			Use(action).
			Main().
			WithEnv(name, value)
}
@function
def example(action: str, name: str, value: str) -> dagger.ForgePostAction:
	return (
		dag.forge()
		.use(action)
		.main()
		.with_env(name, value)
	)
@func()
example(action: string, name: string, value: string): ForgePostAction {
	return dag
		.forge()
		.use(action)
		.main()
		.withEnv(name, value)
}

withToken() 🔗

Return Type 
PostAction !
Arguments
NameTypeDefault ValueDescription
tokenSecret !-No description provided
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 with-token --token env:MYSECRET
func (m *MyModule) Example(action string, token *dagger.Secret) *dagger.ForgePostAction  {
	return dag.
			Forge().
			Use(action).
			Main().
			WithToken(token)
}
@function
def example(action: str, token: dagger.Secret) -> dagger.ForgePostAction:
	return (
		dag.forge()
		.use(action)
		.main()
		.with_token(token)
	)
@func()
example(action: string, token: Secret): ForgePostAction {
	return dag
		.forge()
		.use(action)
		.main()
		.withToken(token)
}

withDebug() 🔗

Return Type 
PostAction !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 with-debug
func (m *MyModule) Example(action string) *dagger.ForgePostAction  {
	return dag.
			Forge().
			Use(action).
			Main().
			WithDebug()
}
@function
def example(action: str) -> dagger.ForgePostAction:
	return (
		dag.forge()
		.use(action)
		.main()
		.with_debug()
	)
@func()
example(action: string): ForgePostAction {
	return dag
		.forge()
		.use(action)
		.main()
		.withDebug()
}

container() 🔗

Container gives access to the underlying container.

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 container
func (m *MyModule) Example(action string) *dagger.Container  {
	return dag.
			Forge().
			Use(action).
			Main().
			Container()
}
@function
def example(action: str) -> dagger.Container:
	return (
		dag.forge()
		.use(action)
		.main()
		.container()
	)
@func()
example(action: string): Container {
	return dag
		.forge()
		.use(action)
		.main()
		.container()
}

terminal() 🔗

Terminal is a convenient alias for Container().Terminal().

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 terminal
func (m *MyModule) Example(action string) *dagger.Container  {
	return dag.
			Forge().
			Use(action).
			Main().
			Terminal()
}
@function
def example(action: str) -> dagger.Container:
	return (
		dag.forge()
		.use(action)
		.main()
		.terminal()
	)
@func()
example(action: string): Container {
	return dag
		.forge()
		.use(action)
		.main()
		.terminal()
}

stdout() 🔗

Stdout is a convenient alias for Container().Stdout().

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 stdout
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Main().
			Stdout(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.main()
		.stdout()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.main()
		.stdout()
}

stderr() 🔗

Stderr is a convenient alias for Container().Stderr().

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 stderr
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Main().
			Stderr(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.main()
		.stderr()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.main()
		.stderr()
}

combinedOutput() 🔗

CombinedOutput is a convenient alias for Container().CombinedOutput().

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 combined-output
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Main().
			CombinedOutput(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.main()
		.combined_output()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.main()
		.combinedOutput()
}

workspace() 🔗

Workspace returns the current state of the GITHUB_WORKSPACE directory.

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 workspace
func (m *MyModule) Example(action string) *dagger.Directory  {
	return dag.
			Forge().
			Use(action).
			Main().
			Workspace()
}
@function
def example(action: str) -> dagger.Directory:
	return (
		dag.forge()
		.use(action)
		.main()
		.workspace()
	)
@func()
example(action: string): Directory {
	return dag
		.forge()
		.use(action)
		.main()
		.workspace()
}

toolcache() 🔗

Toolcache returns the current state of the RUNNER_TOOLCACHE directory.

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 toolcache
func (m *MyModule) Example(action string) *dagger.Directory  {
	return dag.
			Forge().
			Use(action).
			Main().
			Toolcache()
}
@function
def example(action: str) -> dagger.Directory:
	return (
		dag.forge()
		.use(action)
		.main()
		.toolcache()
	)
@func()
example(action: string): Directory {
	return dag
		.forge()
		.use(action)
		.main()
		.toolcache()
}

action() 🔗

Action returns the current state of the GITHUB_ACTION_PATH directory.

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 action
func (m *MyModule) Example(action string) *dagger.Directory  {
	return dag.
			Forge().
			Use(action).
			Main().
			Action()
}
@function
def example(action: str) -> dagger.Directory:
	return (
		dag.forge()
		.use(action)
		.main()
		.action()
	)
@func()
example(action: string): Directory {
	return dag
		.forge()
		.use(action)
		.main()
		.action()
}

home() 🔗

Home returns the current state of the HOME directory.

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 home
func (m *MyModule) Example(action string) *dagger.Directory  {
	return dag.
			Forge().
			Use(action).
			Main().
			Home()
}
@function
def example(action: str) -> dagger.Directory:
	return (
		dag.forge()
		.use(action)
		.main()
		.home()
	)
@func()
example(action: string): Directory {
	return dag
		.forge()
		.use(action)
		.main()
		.home()
}

env() 🔗

Env returns the parsed key-value pairs that were saved to GITHUB_ENV.

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 env
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Main().
			Env(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.main()
		.env()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.main()
		.env()
}

state() 🔗

State returns the parsed key-value pairs that were saved to GITHUB_STATE.

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 state
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Main().
			State(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.main()
		.state()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.main()
		.state()
}

output() 🔗

Output returns the parsed key-value pairs that were saved to GITHUB_OUTPUT.

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 use --action string \
 main \
 output
func (m *MyModule) Example(ctx context.Context, action string) string  {
	return dag.
			Forge().
			Use(action).
			Main().
			Output(ctx)
}
@function
async def example(action: str) -> str:
	return await (
		dag.forge()
		.use(action)
		.main()
		.output()
	)
@func()
async example(action: string): Promise<string> {
	return dag
		.forge()
		.use(action)
		.main()
		.output()
}

FinalizedCloudbuild 🔗

ctr() 🔗

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 run \
 ctr
func (m *MyModule) Example(name string) *dagger.Container  {
	return dag.
			Forge().
			Cloudbuild(name).
			Run().
			Ctr()
}
@function
def example(name: str) -> dagger.Container:
	return (
		dag.forge()
		.cloudbuild(name)
		.run()
		.ctr()
	)
@func()
example(name: string): Container {
	return dag
		.forge()
		.cloudbuild(name)
		.run()
		.ctr()
}

container() 🔗

Container gives access to the underlying container.

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 run \
 container
func (m *MyModule) Example(name string) *dagger.Container  {
	return dag.
			Forge().
			Cloudbuild(name).
			Run().
			Container()
}
@function
def example(name: str) -> dagger.Container:
	return (
		dag.forge()
		.cloudbuild(name)
		.run()
		.container()
	)
@func()
example(name: string): Container {
	return dag
		.forge()
		.cloudbuild(name)
		.run()
		.container()
}

terminal() 🔗

Terminal is a convenient alias for Container().Terminal().

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 run \
 terminal
func (m *MyModule) Example(name string) *dagger.Container  {
	return dag.
			Forge().
			Cloudbuild(name).
			Run().
			Terminal()
}
@function
def example(name: str) -> dagger.Container:
	return (
		dag.forge()
		.cloudbuild(name)
		.run()
		.terminal()
	)
@func()
example(name: string): Container {
	return dag
		.forge()
		.cloudbuild(name)
		.run()
		.terminal()
}

stdout() 🔗

Stdout is a convenient alias for Container().Stdout().

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 run \
 stdout
func (m *MyModule) Example(ctx context.Context, name string) string  {
	return dag.
			Forge().
			Cloudbuild(name).
			Run().
			Stdout(ctx)
}
@function
async def example(name: str) -> str:
	return await (
		dag.forge()
		.cloudbuild(name)
		.run()
		.stdout()
	)
@func()
async example(name: string): Promise<string> {
	return dag
		.forge()
		.cloudbuild(name)
		.run()
		.stdout()
}

stderr() 🔗

Stderr is a convenient alias for Container().Stderr().

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 run \
 stderr
func (m *MyModule) Example(ctx context.Context, name string) string  {
	return dag.
			Forge().
			Cloudbuild(name).
			Run().
			Stderr(ctx)
}
@function
async def example(name: str) -> str:
	return await (
		dag.forge()
		.cloudbuild(name)
		.run()
		.stderr()
	)
@func()
async example(name: string): Promise<string> {
	return dag
		.forge()
		.cloudbuild(name)
		.run()
		.stderr()
}

combinedOutput() 🔗

CombinedOutput is a convenient alias for Container().CombinedOutput().

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 run \
 combined-output
func (m *MyModule) Example(ctx context.Context, name string) string  {
	return dag.
			Forge().
			Cloudbuild(name).
			Run().
			CombinedOutput(ctx)
}
@function
async def example(name: str) -> str:
	return await (
		dag.forge()
		.cloudbuild(name)
		.run()
		.combined_output()
	)
@func()
async example(name: string): Promise<string> {
	return dag
		.forge()
		.cloudbuild(name)
		.run()
		.combinedOutput()
}

workspace() 🔗

Workspace returns the current state of the /workspace directory.

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 run \
 workspace
func (m *MyModule) Example(name string) *dagger.Directory  {
	return dag.
			Forge().
			Cloudbuild(name).
			Run().
			Workspace()
}
@function
def example(name: str) -> dagger.Directory:
	return (
		dag.forge()
		.cloudbuild(name)
		.run()
		.workspace()
	)
@func()
example(name: string): Directory {
	return dag
		.forge()
		.cloudbuild(name)
		.run()
		.workspace()
}

workdir() 🔗

Workdir returns the current state of the working directory.

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 cloudbuild --name string \
 run \
 workdir
func (m *MyModule) Example(name string) *dagger.Directory  {
	return dag.
			Forge().
			Cloudbuild(name).
			Run().
			Workdir()
}
@function
def example(name: str) -> dagger.Directory:
	return (
		dag.forge()
		.cloudbuild(name)
		.run()
		.workdir()
	)
@func()
example(name: string): Directory {
	return dag
		.forge()
		.cloudbuild(name)
		.run()
		.workdir()
}

FinalizedResource 🔗

ctr() 🔗

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 resource --resource string \
 put \
 ctr
func (m *MyModule) Example(resource string) *dagger.Container  {
	return dag.
			Forge().
			Resource(resource).
			Put().
			Ctr()
}
@function
def example(resource: str) -> dagger.Container:
	return (
		dag.forge()
		.resource(resource)
		.put()
		.ctr()
	)
@func()
example(resource: string): Container {
	return dag
		.forge()
		.resource(resource)
		.put()
		.ctr()
}

name() 🔗

Return Type 
String !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 resource --resource string \
 put \
 name
func (m *MyModule) Example(ctx context.Context, resource string) string  {
	return dag.
			Forge().
			Resource(resource).
			Put().
			Name(ctx)
}
@function
async def example(resource: str) -> str:
	return await (
		dag.forge()
		.resource(resource)
		.put()
		.name()
	)
@func()
async example(resource: string): Promise<string> {
	return dag
		.forge()
		.resource(resource)
		.put()
		.name()
}

container() 🔗

Container gives access to the underlying container.

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 resource --resource string \
 put \
 container
func (m *MyModule) Example(resource string) *dagger.Container  {
	return dag.
			Forge().
			Resource(resource).
			Put().
			Container()
}
@function
def example(resource: str) -> dagger.Container:
	return (
		dag.forge()
		.resource(resource)
		.put()
		.container()
	)
@func()
example(resource: string): Container {
	return dag
		.forge()
		.resource(resource)
		.put()
		.container()
}

terminal() 🔗

Terminal is a convenient alias for Container().Terminal().

Return Type 
Container !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 resource --resource string \
 put \
 terminal
func (m *MyModule) Example(resource string) *dagger.Container  {
	return dag.
			Forge().
			Resource(resource).
			Put().
			Terminal()
}
@function
def example(resource: str) -> dagger.Container:
	return (
		dag.forge()
		.resource(resource)
		.put()
		.terminal()
	)
@func()
example(resource: string): Container {
	return dag
		.forge()
		.resource(resource)
		.put()
		.terminal()
}

workdir() 🔗

Return Type 
Directory !
Example
dagger -m github.com/frantjc/forge@e183e43bfee89fe6a6d3a01bf4d4a30a7e7bf083 call \
 resource --resource string \
 put \
 workdir
func (m *MyModule) Example(resource string) *dagger.Directory  {
	return dag.
			Forge().
			Resource(resource).
			Put().
			Workdir()
}
@function
def example(resource: str) -> dagger.Directory:
	return (
		dag.forge()
		.resource(resource)
		.put()
		.workdir()
	)
@func()
example(resource: string): Directory {
	return dag
		.forge()
		.resource(resource)
		.put()
		.workdir()
}

FinalizedAction 🔗

FinalizedAction has a container that's prepared to execute an action and has executed that action.

ctr() 🔗

Return Type 
Container !
Example
Function ForgeFinalizedAction.ctr is not accessible from the forge module
Function ForgeFinalizedAction.ctr is not accessible from the forge module
Function ForgeFinalizedAction.ctr is not accessible from the forge module
Function ForgeFinalizedAction.ctr is not accessible from the forge module

container() 🔗

Container gives access to the underlying container.

Return Type 
Container !
Example
Function ForgeFinalizedAction.container is not accessible from the forge module
Function ForgeFinalizedAction.container is not accessible from the forge module
Function ForgeFinalizedAction.container is not accessible from the forge module
Function ForgeFinalizedAction.container is not accessible from the forge module

terminal() 🔗

Terminal is a convenient alias for Container().Terminal().

Return Type 
Container !
Example
Function ForgeFinalizedAction.terminal is not accessible from the forge module
Function ForgeFinalizedAction.terminal is not accessible from the forge module
Function ForgeFinalizedAction.terminal is not accessible from the forge module
Function ForgeFinalizedAction.terminal is not accessible from the forge module

stdout() 🔗

Stdout is a convenient alias for Container().Stdout().

Return Type 
String !
Example
Function ForgeFinalizedAction.stdout is not accessible from the forge module
Function ForgeFinalizedAction.stdout is not accessible from the forge module
Function ForgeFinalizedAction.stdout is not accessible from the forge module
Function ForgeFinalizedAction.stdout is not accessible from the forge module

stderr() 🔗

Stderr is a convenient alias for Container().Stderr().

Return Type 
String !
Example
Function ForgeFinalizedAction.stderr is not accessible from the forge module
Function ForgeFinalizedAction.stderr is not accessible from the forge module
Function ForgeFinalizedAction.stderr is not accessible from the forge module
Function ForgeFinalizedAction.stderr is not accessible from the forge module

combinedOutput() 🔗

CombinedOutput is a convenient alias for Container().CombinedOutput().

Return Type 
String !
Example
Function ForgeFinalizedAction.combinedOutput is not accessible from the forge module
Function ForgeFinalizedAction.combinedOutput is not accessible from the forge module
Function ForgeFinalizedAction.combinedOutput is not accessible from the forge module
Function ForgeFinalizedAction.combinedOutput is not accessible from the forge module

workspace() 🔗

Workspace returns the current state of the GITHUB_WORKSPACE directory.

Return Type 
Directory !
Example
Function ForgeFinalizedAction.workspace is not accessible from the forge module
Function ForgeFinalizedAction.workspace is not accessible from the forge module
Function ForgeFinalizedAction.workspace is not accessible from the forge module
Function ForgeFinalizedAction.workspace is not accessible from the forge module

toolcache() 🔗

Toolcache returns the current state of the RUNNER_TOOLCACHE directory.

Return Type 
Directory !
Example
Function ForgeFinalizedAction.toolcache is not accessible from the forge module
Function ForgeFinalizedAction.toolcache is not accessible from the forge module
Function ForgeFinalizedAction.toolcache is not accessible from the forge module
Function ForgeFinalizedAction.toolcache is not accessible from the forge module

action() 🔗

Action returns the current state of the GITHUB_ACTION_PATH directory.

Return Type 
Directory !
Example
Function ForgeFinalizedAction.action is not accessible from the forge module
Function ForgeFinalizedAction.action is not accessible from the forge module
Function ForgeFinalizedAction.action is not accessible from the forge module
Function ForgeFinalizedAction.action is not accessible from the forge module

home() 🔗

Home returns the current state of the HOME directory.

Return Type 
Directory !
Example
Function ForgeFinalizedAction.home is not accessible from the forge module
Function ForgeFinalizedAction.home is not accessible from the forge module
Function ForgeFinalizedAction.home is not accessible from the forge module
Function ForgeFinalizedAction.home is not accessible from the forge module

env() 🔗

Env returns the parsed key-value pairs that were saved to GITHUB_ENV.

Return Type 
String !
Example
Function ForgeFinalizedAction.env is not accessible from the forge module
Function ForgeFinalizedAction.env is not accessible from the forge module
Function ForgeFinalizedAction.env is not accessible from the forge module
Function ForgeFinalizedAction.env is not accessible from the forge module

state() 🔗

State returns the parsed key-value pairs that were saved to GITHUB_STATE.

Return Type 
String !
Example
Function ForgeFinalizedAction.state is not accessible from the forge module
Function ForgeFinalizedAction.state is not accessible from the forge module
Function ForgeFinalizedAction.state is not accessible from the forge module
Function ForgeFinalizedAction.state is not accessible from the forge module

output() 🔗

Output returns the parsed key-value pairs that were saved to GITHUB_OUTPUT.

Return Type 
String !
Example
Function ForgeFinalizedAction.output is not accessible from the forge module
Function ForgeFinalizedAction.output is not accessible from the forge module
Function ForgeFinalizedAction.output is not accessible from the forge module
Function ForgeFinalizedAction.output is not accessible from the forge module