Dagger
Search

dagger-docs

This module contains functions to build a static site containing the Dagger documentation, and then deploy the static site to Google Cloud Run

Installation

dagger install github.com/vikram-dagger/daggerverse/dagger-docs@v0.1.1

Entrypoint

Return Type 
DaggerDocs
Example
func (m *myModule) example() *DaggerDocs  {
	return dag.
			DaggerDocs()
}
@function
def example() -> dag.DaggerDocs:
	return (
		dag.dagger_docs()
	)
@func()
example(): DaggerDocs {
	return dag
		.daggerDocs()
}

Types

DaggerDocs

deploy()

Deploys a source Directory containing a static website to an existing Google Cloud Run service

example: dagger call deploy –source ./docs –project user-project –location us-central1 –repository user-repo –credential env:GOOGLE_CREDENTIAL

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-No description provided
projectString !-No description provided
locationString !-No description provided
repositoryString !-No description provided
credentialSecret !-No description provided
Example
dagger -m github.com/vikram-dagger/daggerverse/dagger-docs@12778c950e8e680982f0889b5712bbce29702a81 call \
 deploy --source DIR_PATH --project string --location string --repository string --credential env:MYSECRET
func (m *myModule) example(ctx context.Context, source *Directory, project string, location string, repository string, credential *Secret) string  {
	return dag.
			DaggerDocs().
			Deploy(ctx, source, project, location, repository, credential)
}
@function
async def example(source: dagger.Directory, project: str, location: str, repository: str, credential: dagger.Secret) -> str:
	return await (
		dag.dagger_docs()
		.deploy(source, project, location, repository, credential)
	)
@func()
async example(source: Directory, project: string, location: string, repository: string, credential: Secret): Promise<string> {
	return dag
		.daggerDocs()
		.deploy(source, project, location, repository, credential)
}

build()

Builds a static docs website from a source Directory and returns a Directory containing the build result

example: dagger call build –source ./docs

Return Type 
Directory !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-No description provided
Example
dagger -m github.com/vikram-dagger/daggerverse/dagger-docs@12778c950e8e680982f0889b5712bbce29702a81 call \
 build --source DIR_PATH
func (m *myModule) example(source *Directory) *Directory  {
	return dag.
			DaggerDocs().
			Build(source)
}
@function
def example(source: dagger.Directory) -> dagger.Directory:
	return (
		dag.dagger_docs()
		.build(source)
	)
@func()
example(source: Directory): Directory {
	return dag
		.daggerDocs()
		.build(source)
}