Dagger
Search

daggerverse-cockpit

No long description provided.

Installation

dagger install github.com/quartz-technology/daggerverse/daggerverse-cockpit@v0.0.2

Entrypoint

Return Type 
DaggerverseCockpit
Example
func (m *myModule) example() *DaggerverseCockpit  {
	return dag.
			DaggerverseCockpit()
}
@function
def example() -> dag.DaggerverseCockpit:
	return (
		dag.daggerverse_cockpit()
	)
@func()
example(): DaggerverseCockpit {
	return dag
		.daggerverseCockpit()
}

Types

DaggerverseCockpit 🔗

publish() 🔗

Publish loop through all your directory that contains a dagger.json and publish them to the daggerverse.

Example usage: dagger call publish --repository=. --exclude="deprecated"

Return Type 
[String ! ] !
Arguments
NameTypeDefault ValueDescription
repositoryDirectory !-The repository that contains your dagger modules
exclude[String ! ] -Excluse some directories from publishing It's useful if you use this module from Dagger CLI.
dryRunBoolean -Only returns the path of the modules that shall be published
Example
dagger -m github.com/quartz-technology/daggerverse/daggerverse-cockpit@00f5931a9537bfaca73669e71fbde640aef22a0e call \
 publish --repository DIR_PATH
func (m *myModule) example(ctx context.Context, repository *Directory) []string  {
	return dag.
			DaggerverseCockpit().
			Publish(ctx, repository)
}
@function
async def example(repository: dagger.Directory) -> List[str]:
	return await (
		dag.daggerverse_cockpit()
		.publish(repository)
	)
@func()
async example(repository: Directory): Promise<string[]> {
	return dag
		.daggerverseCockpit()
		.publish(repository)
}

usageGenerator() 🔗

UsageGenerator generates a simple usage documentation for a module.

This function is still in developement, it’s a simple utility functions to simplify modules maintaing.

Use it as a starting point for your module README but please, do not consider it as a README generator.

Example usage: dagger call usage-generator –module=. -o USAGE.md

Return Type 
File !
Arguments
NameTypeDefault ValueDescription
moduleDirectory !-No description provided
Example
dagger -m github.com/quartz-technology/daggerverse/daggerverse-cockpit@00f5931a9537bfaca73669e71fbde640aef22a0e call \
 usage-generator --module DIR_PATH
func (m *myModule) example(module *Directory) *File  {
	return dag.
			DaggerverseCockpit().
			UsageGenerator(module)
}
@function
def example(module: dagger.Directory) -> dagger.File:
	return (
		dag.daggerverse_cockpit()
		.usage_generator(module)
	)
@func()
example(module: Directory): File {
	return dag
		.daggerverseCockpit()
		.usageGenerator(module)
}