cloudflare-pages
This module has been generated via dagger init and serves as a reference tobasic module structure as you get started with Dagger.
Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.
The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.
Installation
dagger install github.com/hseshadr/ci/modules/cloudflare-pages@2f4e5e67573be2c7a157871f40da48e187f30285Entrypoint
Return Type
CloudflarePages ! Example
dagger -m github.com/hseshadr/ci/modules/cloudflare-pages@2f4e5e67573be2c7a157871f40da48e187f30285 call \
func (m *MyModule) Example() *dagger.CloudflarePages {
return dag.
Cloudflarepages()
}@function
def example() -> dagger.CloudflarePages:
return (
dag.cloudflare_pages()
)@func()
example(): CloudflarePages {
return dag
.cloudflarePages()
}Types
CloudflarePagesDeploymentEvidence 🔗
Non-secret Cloudflare deployment proof safe for downstream policy.
provider() 🔗
Return Type
String ! Example
dagger -m github.com/hseshadr/ci/modules/cloudflare-pages@2f4e5e67573be2c7a157871f40da48e187f30285 call \
verify --envelope DIR_PATH --github-token env:MYSECRET --cloudflare-api-token env:MYSECRET --cloudflare-account-id env:MYSECRET --workflow-run-id string --run-attempt integer --repository string --project string --production-branch string --live-domain string --deploy-root string --domains string1 --domains string2 --consumer-identity string --producing-identity string --allowed-roots string1 --allowed-roots string2 \
providerfunc (m *MyModule) Example(ctx context.Context, envelope *dagger.Directory, githubToken *dagger.Secret, cloudflareApiToken *dagger.Secret, cloudflareAccountId *dagger.Secret, workflowRunId string, runAttempt int, repository string, project string, productionBranch string, liveDomain string, deployRoot string, domains []string, consumerIdentity string, producingIdentity string, allowedRoots []string) string {
return dag.
Cloudflarepages().
Verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots).
Provider(ctx)
}@function
async def example(envelope: dagger.Directory, githubtoken: dagger.Secret, cloudflareapitoken: dagger.Secret, cloudflareaccountid: dagger.Secret, workflowrunid: str, runattempt: int, repository: str, project: str, productionbranch: str, livedomain: str, deployroot: str, domains: List[str], consumeridentity: str, producingidentity: str, allowedroots: List[str]) -> str:
return await (
dag.cloudflare_pages()
.verify(envelope, githubtoken, cloudflareapitoken, cloudflareaccountid, workflowrunid, runattempt, repository, project, productionbranch, livedomain, deployroot, domains, consumeridentity, producingidentity, allowedroots)
.provider()
)@func()
async example(envelope: Directory, githubToken: Secret, cloudflareApiToken: Secret, cloudflareAccountId: Secret, workflowRunId: string, runAttempt: number, repository: string, project: string, productionBranch: string, liveDomain: string, deployRoot: string, domains: string[], consumerIdentity: string, producingIdentity: string, allowedRoots: string[]): Promise<string> {
return dag
.cloudflarePages()
.verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
.provider()
}deploymentId() 🔗
Return Type
String ! Example
dagger -m github.com/hseshadr/ci/modules/cloudflare-pages@2f4e5e67573be2c7a157871f40da48e187f30285 call \
verify --envelope DIR_PATH --github-token env:MYSECRET --cloudflare-api-token env:MYSECRET --cloudflare-account-id env:MYSECRET --workflow-run-id string --run-attempt integer --repository string --project string --production-branch string --live-domain string --deploy-root string --domains string1 --domains string2 --consumer-identity string --producing-identity string --allowed-roots string1 --allowed-roots string2 \
deployment-idfunc (m *MyModule) Example(ctx context.Context, envelope *dagger.Directory, githubToken *dagger.Secret, cloudflareApiToken *dagger.Secret, cloudflareAccountId *dagger.Secret, workflowRunId string, runAttempt int, repository string, project string, productionBranch string, liveDomain string, deployRoot string, domains []string, consumerIdentity string, producingIdentity string, allowedRoots []string) string {
return dag.
Cloudflarepages().
Verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots).
Deploymentid(ctx)
}@function
async def example(envelope: dagger.Directory, githubtoken: dagger.Secret, cloudflareapitoken: dagger.Secret, cloudflareaccountid: dagger.Secret, workflowrunid: str, runattempt: int, repository: str, project: str, productionbranch: str, livedomain: str, deployroot: str, domains: List[str], consumeridentity: str, producingidentity: str, allowedroots: List[str]) -> str:
return await (
dag.cloudflare_pages()
.verify(envelope, githubtoken, cloudflareapitoken, cloudflareaccountid, workflowrunid, runattempt, repository, project, productionbranch, livedomain, deployroot, domains, consumeridentity, producingidentity, allowedroots)
.deploymentid()
)@func()
async example(envelope: Directory, githubToken: Secret, cloudflareApiToken: Secret, cloudflareAccountId: Secret, workflowRunId: string, runAttempt: number, repository: string, project: string, productionBranch: string, liveDomain: string, deployRoot: string, domains: string[], consumerIdentity: string, producingIdentity: string, allowedRoots: string[]): Promise<string> {
return dag
.cloudflarePages()
.verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
.deploymentId()
}deploymentUrl() 🔗
Return Type
String ! Example
dagger -m github.com/hseshadr/ci/modules/cloudflare-pages@2f4e5e67573be2c7a157871f40da48e187f30285 call \
verify --envelope DIR_PATH --github-token env:MYSECRET --cloudflare-api-token env:MYSECRET --cloudflare-account-id env:MYSECRET --workflow-run-id string --run-attempt integer --repository string --project string --production-branch string --live-domain string --deploy-root string --domains string1 --domains string2 --consumer-identity string --producing-identity string --allowed-roots string1 --allowed-roots string2 \
deployment-urlfunc (m *MyModule) Example(ctx context.Context, envelope *dagger.Directory, githubToken *dagger.Secret, cloudflareApiToken *dagger.Secret, cloudflareAccountId *dagger.Secret, workflowRunId string, runAttempt int, repository string, project string, productionBranch string, liveDomain string, deployRoot string, domains []string, consumerIdentity string, producingIdentity string, allowedRoots []string) string {
return dag.
Cloudflarepages().
Verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots).
Deploymenturl(ctx)
}@function
async def example(envelope: dagger.Directory, githubtoken: dagger.Secret, cloudflareapitoken: dagger.Secret, cloudflareaccountid: dagger.Secret, workflowrunid: str, runattempt: int, repository: str, project: str, productionbranch: str, livedomain: str, deployroot: str, domains: List[str], consumeridentity: str, producingidentity: str, allowedroots: List[str]) -> str:
return await (
dag.cloudflare_pages()
.verify(envelope, githubtoken, cloudflareapitoken, cloudflareaccountid, workflowrunid, runattempt, repository, project, productionbranch, livedomain, deployroot, domains, consumeridentity, producingidentity, allowedroots)
.deploymenturl()
)@func()
async example(envelope: Directory, githubToken: Secret, cloudflareApiToken: Secret, cloudflareAccountId: Secret, workflowRunId: string, runAttempt: number, repository: string, project: string, productionBranch: string, liveDomain: string, deployRoot: string, domains: string[], consumerIdentity: string, producingIdentity: string, allowedRoots: string[]): Promise<string> {
return dag
.cloudflarePages()
.verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
.deploymentUrl()
}projectId() 🔗
Return Type
String ! Example
dagger -m github.com/hseshadr/ci/modules/cloudflare-pages@2f4e5e67573be2c7a157871f40da48e187f30285 call \
verify --envelope DIR_PATH --github-token env:MYSECRET --cloudflare-api-token env:MYSECRET --cloudflare-account-id env:MYSECRET --workflow-run-id string --run-attempt integer --repository string --project string --production-branch string --live-domain string --deploy-root string --domains string1 --domains string2 --consumer-identity string --producing-identity string --allowed-roots string1 --allowed-roots string2 \
project-idfunc (m *MyModule) Example(ctx context.Context, envelope *dagger.Directory, githubToken *dagger.Secret, cloudflareApiToken *dagger.Secret, cloudflareAccountId *dagger.Secret, workflowRunId string, runAttempt int, repository string, project string, productionBranch string, liveDomain string, deployRoot string, domains []string, consumerIdentity string, producingIdentity string, allowedRoots []string) string {
return dag.
Cloudflarepages().
Verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots).
Projectid(ctx)
}@function
async def example(envelope: dagger.Directory, githubtoken: dagger.Secret, cloudflareapitoken: dagger.Secret, cloudflareaccountid: dagger.Secret, workflowrunid: str, runattempt: int, repository: str, project: str, productionbranch: str, livedomain: str, deployroot: str, domains: List[str], consumeridentity: str, producingidentity: str, allowedroots: List[str]) -> str:
return await (
dag.cloudflare_pages()
.verify(envelope, githubtoken, cloudflareapitoken, cloudflareaccountid, workflowrunid, runattempt, repository, project, productionbranch, livedomain, deployroot, domains, consumeridentity, producingidentity, allowedroots)
.projectid()
)@func()
async example(envelope: Directory, githubToken: Secret, cloudflareApiToken: Secret, cloudflareAccountId: Secret, workflowRunId: string, runAttempt: number, repository: string, project: string, productionBranch: string, liveDomain: string, deployRoot: string, domains: string[], consumerIdentity: string, producingIdentity: string, allowedRoots: string[]): Promise<string> {
return dag
.cloudflarePages()
.verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
.projectId()
}project() 🔗
Return Type
String ! Example
dagger -m github.com/hseshadr/ci/modules/cloudflare-pages@2f4e5e67573be2c7a157871f40da48e187f30285 call \
verify --envelope DIR_PATH --github-token env:MYSECRET --cloudflare-api-token env:MYSECRET --cloudflare-account-id env:MYSECRET --workflow-run-id string --run-attempt integer --repository string --project string --production-branch string --live-domain string --deploy-root string --domains string1 --domains string2 --consumer-identity string --producing-identity string --allowed-roots string1 --allowed-roots string2 \
projectfunc (m *MyModule) Example(ctx context.Context, envelope *dagger.Directory, githubToken *dagger.Secret, cloudflareApiToken *dagger.Secret, cloudflareAccountId *dagger.Secret, workflowRunId string, runAttempt int, repository string, project string, productionBranch string, liveDomain string, deployRoot string, domains []string, consumerIdentity string, producingIdentity string, allowedRoots []string) string {
return dag.
Cloudflarepages().
Verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots).
Project(ctx)
}@function
async def example(envelope: dagger.Directory, githubtoken: dagger.Secret, cloudflareapitoken: dagger.Secret, cloudflareaccountid: dagger.Secret, workflowrunid: str, runattempt: int, repository: str, project: str, productionbranch: str, livedomain: str, deployroot: str, domains: List[str], consumeridentity: str, producingidentity: str, allowedroots: List[str]) -> str:
return await (
dag.cloudflare_pages()
.verify(envelope, githubtoken, cloudflareapitoken, cloudflareaccountid, workflowrunid, runattempt, repository, project, productionbranch, livedomain, deployroot, domains, consumeridentity, producingidentity, allowedroots)
.project()
)@func()
async example(envelope: Directory, githubToken: Secret, cloudflareApiToken: Secret, cloudflareAccountId: Secret, workflowRunId: string, runAttempt: number, repository: string, project: string, productionBranch: string, liveDomain: string, deployRoot: string, domains: string[], consumerIdentity: string, producingIdentity: string, allowedRoots: string[]): Promise<string> {
return dag
.cloudflarePages()
.verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
.project()
}repository() 🔗
Return Type
String ! Example
dagger -m github.com/hseshadr/ci/modules/cloudflare-pages@2f4e5e67573be2c7a157871f40da48e187f30285 call \
verify --envelope DIR_PATH --github-token env:MYSECRET --cloudflare-api-token env:MYSECRET --cloudflare-account-id env:MYSECRET --workflow-run-id string --run-attempt integer --repository string --project string --production-branch string --live-domain string --deploy-root string --domains string1 --domains string2 --consumer-identity string --producing-identity string --allowed-roots string1 --allowed-roots string2 \
repositoryfunc (m *MyModule) Example(ctx context.Context, envelope *dagger.Directory, githubToken *dagger.Secret, cloudflareApiToken *dagger.Secret, cloudflareAccountId *dagger.Secret, workflowRunId string, runAttempt int, repository string, project string, productionBranch string, liveDomain string, deployRoot string, domains []string, consumerIdentity string, producingIdentity string, allowedRoots []string) string {
return dag.
Cloudflarepages().
Verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots).
Repository(ctx)
}@function
async def example(envelope: dagger.Directory, githubtoken: dagger.Secret, cloudflareapitoken: dagger.Secret, cloudflareaccountid: dagger.Secret, workflowrunid: str, runattempt: int, repository: str, project: str, productionbranch: str, livedomain: str, deployroot: str, domains: List[str], consumeridentity: str, producingidentity: str, allowedroots: List[str]) -> str:
return await (
dag.cloudflare_pages()
.verify(envelope, githubtoken, cloudflareapitoken, cloudflareaccountid, workflowrunid, runattempt, repository, project, productionbranch, livedomain, deployroot, domains, consumeridentity, producingidentity, allowedroots)
.repository()
)@func()
async example(envelope: Directory, githubToken: Secret, cloudflareApiToken: Secret, cloudflareAccountId: Secret, workflowRunId: string, runAttempt: number, repository: string, project: string, productionBranch: string, liveDomain: string, deployRoot: string, domains: string[], consumerIdentity: string, producingIdentity: string, allowedRoots: string[]): Promise<string> {
return dag
.cloudflarePages()
.verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
.repository()
}branch() 🔗
Return Type
String ! Example
dagger -m github.com/hseshadr/ci/modules/cloudflare-pages@2f4e5e67573be2c7a157871f40da48e187f30285 call \
verify --envelope DIR_PATH --github-token env:MYSECRET --cloudflare-api-token env:MYSECRET --cloudflare-account-id env:MYSECRET --workflow-run-id string --run-attempt integer --repository string --project string --production-branch string --live-domain string --deploy-root string --domains string1 --domains string2 --consumer-identity string --producing-identity string --allowed-roots string1 --allowed-roots string2 \
branchfunc (m *MyModule) Example(ctx context.Context, envelope *dagger.Directory, githubToken *dagger.Secret, cloudflareApiToken *dagger.Secret, cloudflareAccountId *dagger.Secret, workflowRunId string, runAttempt int, repository string, project string, productionBranch string, liveDomain string, deployRoot string, domains []string, consumerIdentity string, producingIdentity string, allowedRoots []string) string {
return dag.
Cloudflarepages().
Verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots).
Branch(ctx)
}@function
async def example(envelope: dagger.Directory, githubtoken: dagger.Secret, cloudflareapitoken: dagger.Secret, cloudflareaccountid: dagger.Secret, workflowrunid: str, runattempt: int, repository: str, project: str, productionbranch: str, livedomain: str, deployroot: str, domains: List[str], consumeridentity: str, producingidentity: str, allowedroots: List[str]) -> str:
return await (
dag.cloudflare_pages()
.verify(envelope, githubtoken, cloudflareapitoken, cloudflareaccountid, workflowrunid, runattempt, repository, project, productionbranch, livedomain, deployroot, domains, consumeridentity, producingidentity, allowedroots)
.branch()
)@func()
async example(envelope: Directory, githubToken: Secret, cloudflareApiToken: Secret, cloudflareAccountId: Secret, workflowRunId: string, runAttempt: number, repository: string, project: string, productionBranch: string, liveDomain: string, deployRoot: string, domains: string[], consumerIdentity: string, producingIdentity: string, allowedRoots: string[]): Promise<string> {
return dag
.cloudflarePages()
.verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
.branch()
}sourceSha() 🔗
Return Type
String ! Example
dagger -m github.com/hseshadr/ci/modules/cloudflare-pages@2f4e5e67573be2c7a157871f40da48e187f30285 call \
verify --envelope DIR_PATH --github-token env:MYSECRET --cloudflare-api-token env:MYSECRET --cloudflare-account-id env:MYSECRET --workflow-run-id string --run-attempt integer --repository string --project string --production-branch string --live-domain string --deploy-root string --domains string1 --domains string2 --consumer-identity string --producing-identity string --allowed-roots string1 --allowed-roots string2 \
source-shafunc (m *MyModule) Example(ctx context.Context, envelope *dagger.Directory, githubToken *dagger.Secret, cloudflareApiToken *dagger.Secret, cloudflareAccountId *dagger.Secret, workflowRunId string, runAttempt int, repository string, project string, productionBranch string, liveDomain string, deployRoot string, domains []string, consumerIdentity string, producingIdentity string, allowedRoots []string) string {
return dag.
Cloudflarepages().
Verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots).
Sourcesha(ctx)
}@function
async def example(envelope: dagger.Directory, githubtoken: dagger.Secret, cloudflareapitoken: dagger.Secret, cloudflareaccountid: dagger.Secret, workflowrunid: str, runattempt: int, repository: str, project: str, productionbranch: str, livedomain: str, deployroot: str, domains: List[str], consumeridentity: str, producingidentity: str, allowedroots: List[str]) -> str:
return await (
dag.cloudflare_pages()
.verify(envelope, githubtoken, cloudflareapitoken, cloudflareaccountid, workflowrunid, runattempt, repository, project, productionbranch, livedomain, deployroot, domains, consumeridentity, producingidentity, allowedroots)
.sourcesha()
)@func()
async example(envelope: Directory, githubToken: Secret, cloudflareApiToken: Secret, cloudflareAccountId: Secret, workflowRunId: string, runAttempt: number, repository: string, project: string, productionBranch: string, liveDomain: string, deployRoot: string, domains: string[], consumerIdentity: string, producingIdentity: string, allowedRoots: string[]): Promise<string> {
return dag
.cloudflarePages()
.verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
.sourceSha()
}workflowRunId() 🔗
Return Type
String ! Example
dagger -m github.com/hseshadr/ci/modules/cloudflare-pages@2f4e5e67573be2c7a157871f40da48e187f30285 call \
verify --envelope DIR_PATH --github-token env:MYSECRET --cloudflare-api-token env:MYSECRET --cloudflare-account-id env:MYSECRET --workflow-run-id string --run-attempt integer --repository string --project string --production-branch string --live-domain string --deploy-root string --domains string1 --domains string2 --consumer-identity string --producing-identity string --allowed-roots string1 --allowed-roots string2 \
workflow-run-idfunc (m *MyModule) Example(ctx context.Context, envelope *dagger.Directory, githubToken *dagger.Secret, cloudflareApiToken *dagger.Secret, cloudflareAccountId *dagger.Secret, workflowRunId string, runAttempt int, repository string, project string, productionBranch string, liveDomain string, deployRoot string, domains []string, consumerIdentity string, producingIdentity string, allowedRoots []string) string {
return dag.
Cloudflarepages().
Verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots).
Workflowrunid(ctx)
}@function
async def example(envelope: dagger.Directory, githubtoken: dagger.Secret, cloudflareapitoken: dagger.Secret, cloudflareaccountid: dagger.Secret, workflowrunid: str, runattempt: int, repository: str, project: str, productionbranch: str, livedomain: str, deployroot: str, domains: List[str], consumeridentity: str, producingidentity: str, allowedroots: List[str]) -> str:
return await (
dag.cloudflare_pages()
.verify(envelope, githubtoken, cloudflareapitoken, cloudflareaccountid, workflowrunid, runattempt, repository, project, productionbranch, livedomain, deployroot, domains, consumeridentity, producingidentity, allowedroots)
.workflowrunid()
)@func()
async example(envelope: Directory, githubToken: Secret, cloudflareApiToken: Secret, cloudflareAccountId: Secret, workflowRunId: string, runAttempt: number, repository: string, project: string, productionBranch: string, liveDomain: string, deployRoot: string, domains: string[], consumerIdentity: string, producingIdentity: string, allowedRoots: string[]): Promise<string> {
return dag
.cloudflarePages()
.verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
.workflowRunId()
}runAttempt() 🔗
Return Type
Integer ! Example
dagger -m github.com/hseshadr/ci/modules/cloudflare-pages@2f4e5e67573be2c7a157871f40da48e187f30285 call \
verify --envelope DIR_PATH --github-token env:MYSECRET --cloudflare-api-token env:MYSECRET --cloudflare-account-id env:MYSECRET --workflow-run-id string --run-attempt integer --repository string --project string --production-branch string --live-domain string --deploy-root string --domains string1 --domains string2 --consumer-identity string --producing-identity string --allowed-roots string1 --allowed-roots string2 \
run-attemptfunc (m *MyModule) Example(ctx context.Context, envelope *dagger.Directory, githubToken *dagger.Secret, cloudflareApiToken *dagger.Secret, cloudflareAccountId *dagger.Secret, workflowRunId string, runAttempt int, repository string, project string, productionBranch string, liveDomain string, deployRoot string, domains []string, consumerIdentity string, producingIdentity string, allowedRoots []string) int {
return dag.
Cloudflarepages().
Verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots).
Runattempt(ctx)
}@function
async def example(envelope: dagger.Directory, githubtoken: dagger.Secret, cloudflareapitoken: dagger.Secret, cloudflareaccountid: dagger.Secret, workflowrunid: str, runattempt: int, repository: str, project: str, productionbranch: str, livedomain: str, deployroot: str, domains: List[str], consumeridentity: str, producingidentity: str, allowedroots: List[str]) -> int:
return await (
dag.cloudflare_pages()
.verify(envelope, githubtoken, cloudflareapitoken, cloudflareaccountid, workflowrunid, runattempt, repository, project, productionbranch, livedomain, deployroot, domains, consumeridentity, producingidentity, allowedroots)
.runattempt()
)@func()
async example(envelope: Directory, githubToken: Secret, cloudflareApiToken: Secret, cloudflareAccountId: Secret, workflowRunId: string, runAttempt: number, repository: string, project: string, productionBranch: string, liveDomain: string, deployRoot: string, domains: string[], consumerIdentity: string, producingIdentity: string, allowedRoots: string[]): Promise<number> {
return dag
.cloudflarePages()
.verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
.runAttempt()
}CloudflarePages 🔗
Deploy only foundation-verified artifacts to one bound Pages target.
deploy() 🔗
Direct-upload one verified artifact and return exact deployment evidence.
Return Type
CloudflarePagesDeploymentEvidence !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| envelope | Directory ! | - | A directory. |
| githubToken | Secret ! | - | A reference to a secret value, which can be handled more safely than the value itself. |
| cloudflareApiToken | Secret ! | - | A reference to a secret value, which can be handled more safely than the value itself. |
| cloudflareAccountId | Secret ! | - | A reference to a secret value, which can be handled more safely than the value itself. |
| workflowRunId | String ! | - | No description provided |
| runAttempt | Integer ! | - | No description provided |
| repository | String ! | - | No description provided |
| project | String ! | - | No description provided |
| productionBranch | String ! | - | No description provided |
| liveDomain | String ! | - | No description provided |
| deployRoot | String ! | - | No description provided |
| domains | [String ! ] ! | - | No description provided |
| consumerIdentity | String ! | - | No description provided |
| producingIdentity | String ! | - | No description provided |
| allowedRoots | [String ! ] ! | - | No description provided |
Example
dagger -m github.com/hseshadr/ci/modules/cloudflare-pages@2f4e5e67573be2c7a157871f40da48e187f30285 call \
deploy --envelope DIR_PATH --github-token env:MYSECRET --cloudflare-api-token env:MYSECRET --cloudflare-account-id env:MYSECRET --workflow-run-id string --run-attempt integer --repository string --project string --production-branch string --live-domain string --deploy-root string --domains string1 --domains string2 --consumer-identity string --producing-identity string --allowed-roots string1 --allowed-roots string2func (m *MyModule) Example(envelope *dagger.Directory, githubToken *dagger.Secret, cloudflareApiToken *dagger.Secret, cloudflareAccountId *dagger.Secret, workflowRunId string, runAttempt int, repository string, project string, productionBranch string, liveDomain string, deployRoot string, domains []string, consumerIdentity string, producingIdentity string, allowedRoots []string) *dagger.CloudflarePagesDeploymentEvidence {
return dag.
Cloudflarepages().
Deploy(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
}@function
def example(envelope: dagger.Directory, githubtoken: dagger.Secret, cloudflareapitoken: dagger.Secret, cloudflareaccountid: dagger.Secret, workflowrunid: str, runattempt: int, repository: str, project: str, productionbranch: str, livedomain: str, deployroot: str, domains: List[str], consumeridentity: str, producingidentity: str, allowedroots: List[str]) -> dagger.CloudflarePagesDeploymentEvidence:
return (
dag.cloudflare_pages()
.deploy(envelope, githubtoken, cloudflareapitoken, cloudflareaccountid, workflowrunid, runattempt, repository, project, productionbranch, livedomain, deployroot, domains, consumeridentity, producingidentity, allowedroots)
)@func()
example(envelope: Directory, githubToken: Secret, cloudflareApiToken: Secret, cloudflareAccountId: Secret, workflowRunId: string, runAttempt: number, repository: string, project: string, productionBranch: string, liveDomain: string, deployRoot: string, domains: string[], consumerIdentity: string, producingIdentity: string, allowedRoots: string[]): CloudflarePagesDeploymentEvidence {
return dag
.cloudflarePages()
.deploy(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
}preflight() 🔗
Verify the envelope and run read-only project, deployment, and CLI checks.
Return Type
String !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| envelope | Directory ! | - | A directory. |
| githubToken | Secret ! | - | A reference to a secret value, which can be handled more safely than the value itself. |
| cloudflareApiToken | Secret ! | - | A reference to a secret value, which can be handled more safely than the value itself. |
| cloudflareAccountId | Secret ! | - | A reference to a secret value, which can be handled more safely than the value itself. |
| workflowRunId | String ! | - | No description provided |
| runAttempt | Integer ! | - | No description provided |
| repository | String ! | - | No description provided |
| project | String ! | - | No description provided |
| productionBranch | String ! | - | No description provided |
| liveDomain | String ! | - | No description provided |
| deployRoot | String ! | - | No description provided |
| domains | [String ! ] ! | - | No description provided |
| consumerIdentity | String ! | - | No description provided |
| producingIdentity | String ! | - | No description provided |
| allowedRoots | [String ! ] ! | - | No description provided |
Example
dagger -m github.com/hseshadr/ci/modules/cloudflare-pages@2f4e5e67573be2c7a157871f40da48e187f30285 call \
preflight --envelope DIR_PATH --github-token env:MYSECRET --cloudflare-api-token env:MYSECRET --cloudflare-account-id env:MYSECRET --workflow-run-id string --run-attempt integer --repository string --project string --production-branch string --live-domain string --deploy-root string --domains string1 --domains string2 --consumer-identity string --producing-identity string --allowed-roots string1 --allowed-roots string2func (m *MyModule) Example(ctx context.Context, envelope *dagger.Directory, githubToken *dagger.Secret, cloudflareApiToken *dagger.Secret, cloudflareAccountId *dagger.Secret, workflowRunId string, runAttempt int, repository string, project string, productionBranch string, liveDomain string, deployRoot string, domains []string, consumerIdentity string, producingIdentity string, allowedRoots []string) string {
return dag.
Cloudflarepages().
Preflight(ctx, envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
}@function
async def example(envelope: dagger.Directory, githubtoken: dagger.Secret, cloudflareapitoken: dagger.Secret, cloudflareaccountid: dagger.Secret, workflowrunid: str, runattempt: int, repository: str, project: str, productionbranch: str, livedomain: str, deployroot: str, domains: List[str], consumeridentity: str, producingidentity: str, allowedroots: List[str]) -> str:
return await (
dag.cloudflare_pages()
.preflight(envelope, githubtoken, cloudflareapitoken, cloudflareaccountid, workflowrunid, runattempt, repository, project, productionbranch, livedomain, deployroot, domains, consumeridentity, producingidentity, allowedroots)
)@func()
async example(envelope: Directory, githubToken: Secret, cloudflareApiToken: Secret, cloudflareAccountId: Secret, workflowRunId: string, runAttempt: number, repository: string, project: string, productionBranch: string, liveDomain: string, deployRoot: string, domains: string[], consumerIdentity: string, producingIdentity: string, allowedRoots: string[]): Promise<string> {
return dag
.cloudflarePages()
.preflight(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
}verify() 🔗
Converge read-only production evidence for an exact source attempt.
Return Type
CloudflarePagesDeploymentEvidence !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| envelope | Directory ! | - | A directory. |
| githubToken | Secret ! | - | A reference to a secret value, which can be handled more safely than the value itself. |
| cloudflareApiToken | Secret ! | - | A reference to a secret value, which can be handled more safely than the value itself. |
| cloudflareAccountId | Secret ! | - | A reference to a secret value, which can be handled more safely than the value itself. |
| workflowRunId | String ! | - | No description provided |
| runAttempt | Integer ! | - | No description provided |
| repository | String ! | - | No description provided |
| project | String ! | - | No description provided |
| productionBranch | String ! | - | No description provided |
| liveDomain | String ! | - | No description provided |
| deployRoot | String ! | - | No description provided |
| domains | [String ! ] ! | - | No description provided |
| consumerIdentity | String ! | - | No description provided |
| producingIdentity | String ! | - | No description provided |
| allowedRoots | [String ! ] ! | - | No description provided |
Example
dagger -m github.com/hseshadr/ci/modules/cloudflare-pages@2f4e5e67573be2c7a157871f40da48e187f30285 call \
verify --envelope DIR_PATH --github-token env:MYSECRET --cloudflare-api-token env:MYSECRET --cloudflare-account-id env:MYSECRET --workflow-run-id string --run-attempt integer --repository string --project string --production-branch string --live-domain string --deploy-root string --domains string1 --domains string2 --consumer-identity string --producing-identity string --allowed-roots string1 --allowed-roots string2func (m *MyModule) Example(envelope *dagger.Directory, githubToken *dagger.Secret, cloudflareApiToken *dagger.Secret, cloudflareAccountId *dagger.Secret, workflowRunId string, runAttempt int, repository string, project string, productionBranch string, liveDomain string, deployRoot string, domains []string, consumerIdentity string, producingIdentity string, allowedRoots []string) *dagger.CloudflarePagesDeploymentEvidence {
return dag.
Cloudflarepages().
Verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
}@function
def example(envelope: dagger.Directory, githubtoken: dagger.Secret, cloudflareapitoken: dagger.Secret, cloudflareaccountid: dagger.Secret, workflowrunid: str, runattempt: int, repository: str, project: str, productionbranch: str, livedomain: str, deployroot: str, domains: List[str], consumeridentity: str, producingidentity: str, allowedroots: List[str]) -> dagger.CloudflarePagesDeploymentEvidence:
return (
dag.cloudflare_pages()
.verify(envelope, githubtoken, cloudflareapitoken, cloudflareaccountid, workflowrunid, runattempt, repository, project, productionbranch, livedomain, deployroot, domains, consumeridentity, producingidentity, allowedroots)
)@func()
example(envelope: Directory, githubToken: Secret, cloudflareApiToken: Secret, cloudflareAccountId: Secret, workflowRunId: string, runAttempt: number, repository: string, project: string, productionBranch: string, liveDomain: string, deployRoot: string, domains: string[], consumerIdentity: string, producingIdentity: string, allowedRoots: string[]): CloudflarePagesDeploymentEvidence {
return dag
.cloudflarePages()
.verify(envelope, githubToken, cloudflareApiToken, cloudflareAccountId, workflowRunId, runAttempt, repository, project, productionBranch, liveDomain, deployRoot, domains, consumerIdentity, producingIdentity, allowedRoots)
}