plone
Installation
Entrypoint
Types
Plone

plone

This module has been generated via dagger init and serves as a reference to
basic 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/gotcha/dagger_plone@6438bcb4c870131c0e05522bfe63d778d8dbd75f

Entrypoint

Return Type

Plone !

Example

dagger -m github.com/gotcha/dagger_plone@6438bcb4c870131c0e05522bfe63d778d8dbd75f call \

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

@function
def example() -> dagger.Plone:
	return (
		dag.plone()
	)

@func()
example(): Plone {
	return dag
		.plone()
}

Types

Plone 🔗

asService() 🔗

Run Plone as a service

Return Type

Service !

Arguments

Name	Type	Default Value	Description
baseImage	String !	"python:3.12"	No description provided
ploneVersion	String !	"6.1.1"	No description provided

Example

dagger -m github.com/gotcha/dagger_plone@6438bcb4c870131c0e05522bfe63d778d8dbd75f call \
 as-service --base-image string --plone-version string

func (m *MyModule) Example(baseImage string, ploneVersion string) *dagger.Service  {
	return dag.
			Plone().
			AsService(baseImage, ploneVersion)
}

@function
def example(base_image: str, plone_version: str) -> dagger.Service:
	return (
		dag.plone()
		.as_service(base_image, plone_version)
	)

@func()
example(baseImage: string, ploneVersion: string): Service {
	return dag
		.plone()
		.asService(baseImage, ploneVersion)
}

cypressDirectory() 🔗

Returns module as a directory source for cypress tests

Return Type

Directory !

Example

dagger -m github.com/gotcha/dagger_plone@6438bcb4c870131c0e05522bfe63d778d8dbd75f call \
 cypress-directory

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			Plone().
			CypressDirectory()
}

@function
def example() -> dagger.Directory:
	return (
		dag.plone()
		.cypress_directory()
	)

@func()
example(): Directory {
	return dag
		.plone()
		.cypressDirectory()
}

defaultBaseImage() 🔗

Returns the default base image used to build Plone

Return Type

String !

Example

dagger -m github.com/gotcha/dagger_plone@6438bcb4c870131c0e05522bfe63d778d8dbd75f call \
 default-base-image

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Plone().
			DefaultBaseImage(ctx)
}

@function
async def example() -> str:
	return await (
		dag.plone()
		.default_base_image()
	)

@func()
async example(): Promise<string> {
	return dag
		.plone()
		.defaultBaseImage()
}

runCypress() 🔗

Run cypress tests against Plone

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.

Example

dagger -m github.com/gotcha/dagger_plone@6438bcb4c870131c0e05522bfe63d778d8dbd75f call \
 run-cypress --source DIR_PATH

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			Plone().
			RunCypress(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.plone()
		.run_cypress(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.plone()
		.runCypress(source)
}

withBuildout() 🔗

Returns a container with buildout installed

Return Type

Container !

Arguments

Name	Type	Default Value	Description
python	Container !	-	An OCI-compatible container, also known as a Docker container.
buildoutVersion	String !	"4.1.9"	No description provided
setuptoolsVersion	String !	"80.2.0"	No description provided

Example

dagger -m github.com/gotcha/dagger_plone@6438bcb4c870131c0e05522bfe63d778d8dbd75f call \
 with-buildout --python IMAGE:TAG --buildout-version string --setuptools-version string

func (m *MyModule) Example(python *dagger.Container, buildoutVersion string, setuptoolsVersion string) *dagger.Container  {
	return dag.
			Plone().
			WithBuildout(python, buildoutVersion, setuptoolsVersion)
}

@function
def example(python: dagger.Container, buildout_version: str, setuptools_version: str) -> dagger.Container:
	return (
		dag.plone()
		.with_buildout(python, buildout_version, setuptools_version)
	)

@func()
example(python: Container, buildoutVersion: string, setuptoolsVersion: string): Container {
	return dag
		.plone()
		.withBuildout(python, buildoutVersion, setuptoolsVersion)
}

withPlone() 🔗

Install Plone into a container where buildout is installed.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
buildout	Container !	-	An OCI-compatible container, also known as a Docker container.
ploneVersion	String !	"6.0.15"	No description provided

Example

dagger -m github.com/gotcha/dagger_plone@6438bcb4c870131c0e05522bfe63d778d8dbd75f call \
 with-plone --buildout IMAGE:TAG --plone-version string

func (m *MyModule) Example(buildout *dagger.Container, ploneVersion string) *dagger.Container  {
	return dag.
			Plone().
			WithPlone(buildout, ploneVersion)
}

@function
def example(buildout: dagger.Container, plone_version: str) -> dagger.Container:
	return (
		dag.plone()
		.with_plone(buildout, plone_version)
	)

@func()
example(buildout: Container, ploneVersion: string): Container {
	return dag
		.plone()
		.withPlone(buildout, ploneVersion)
}