confluence-updater
Installation
Entrypoint
Types
ConfluenceUpdater

confluence-updater

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/kerwood/dagger-modules/confluence-updater@5b63a92dfd3337ba01b5498021274da44067bab1

Entrypoint

Return Type

ConfluenceUpdater !

Arguments

Name	Type	Default Value	Description
fqdn	String	-	No description provided
user	String	-	No description provided
token	Secret	-	No description provided
configPath	String	"./confluence-updater.yaml"	No description provided
labels	String	-	No description provided
srcDirectory	Directory	-	No description provided
logLevel	String	"info"	No description provided
cliVersion	String	"2.3.1"	No description provided

Example

dagger -m github.com/kerwood/dagger-modules/confluence-updater@5b63a92dfd3337ba01b5498021274da44067bab1 call \

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

@function
def example() -> dagger.ConfluenceUpdater:
	return (
		dag.confluence_updater()
	)

@func()
example(): ConfluenceUpdater {
	return dag
		.confluenceUpdater()
}

Types

ConfluenceUpdater 🔗

runUpdate() 🔗

Run Confluence Updater.

Return Type

String !

Example

dagger -m github.com/kerwood/dagger-modules/confluence-updater@5b63a92dfd3337ba01b5498021274da44067bab1 call \
 run-update

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

@function
async def example() -> str:
	return await (
		dag.confluence_updater()
		.run_update()
	)

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

withFqdn() 🔗

The fully qualified domain name of your Atlassian Cloud. [REQUIRED]

Return Type

ConfluenceUpdater !

Arguments

Name	Type	Default Value	Description
fqdn	String !	-	No description provided

Example

dagger -m github.com/kerwood/dagger-modules/confluence-updater@5b63a92dfd3337ba01b5498021274da44067bab1 call \
 with-fqdn --fqdn string

func (m *MyModule) Example(fqdn string) *dagger.ConfluenceUpdater  {
	return dag.
			ConfluenceUpdater().
			WithFqdn(fqdn)
}

@function
def example(fqdn: str) -> dagger.ConfluenceUpdater:
	return (
		dag.confluence_updater()
		.with_fqdn(fqdn)
	)

@func()
example(fqdn: string): ConfluenceUpdater {
	return dag
		.confluenceUpdater()
		.withFqdn(fqdn)
}

withUser() 🔗

Confluence user to login with. [REQUIRED]

Return Type

ConfluenceUpdater !

Arguments

Name	Type	Default Value	Description
user	String !	-	No description provided

Example

dagger -m github.com/kerwood/dagger-modules/confluence-updater@5b63a92dfd3337ba01b5498021274da44067bab1 call \
 with-user --user string

func (m *MyModule) Example(user string) *dagger.ConfluenceUpdater  {
	return dag.
			ConfluenceUpdater().
			WithUser(user)
}

@function
def example(user: str) -> dagger.ConfluenceUpdater:
	return (
		dag.confluence_updater()
		.with_user(user)
	)

@func()
example(user: string): ConfluenceUpdater {
	return dag
		.confluenceUpdater()
		.withUser(user)
}

withToken() 🔗

The token/secret to use. https://id.atlassian.com/manage-profile/security/api-tokens [REQUIRED]

Return Type

ConfluenceUpdater !

Arguments

Name	Type	Default Value	Description
token	Secret !	-	No description provided

Example

dagger -m github.com/kerwood/dagger-modules/confluence-updater@5b63a92dfd3337ba01b5498021274da44067bab1 call \
 with-token --token env:MYSECRET

func (m *MyModule) Example(token *dagger.Secret) *dagger.ConfluenceUpdater  {
	return dag.
			ConfluenceUpdater().
			WithToken(token)
}

@function
def example(token: dagger.Secret) -> dagger.ConfluenceUpdater:
	return (
		dag.confluence_updater()
		.with_token(token)
	)

@func()
example(token: Secret): ConfluenceUpdater {
	return dag
		.confluenceUpdater()
		.withToken(token)
}

withConfigPath() 🔗

Config file path. [default: ./confluence-updater]

Return Type

ConfluenceUpdater !

Arguments

Name	Type	Default Value	Description
configPath	String !	-	No description provided

Example

dagger -m github.com/kerwood/dagger-modules/confluence-updater@5b63a92dfd3337ba01b5498021274da44067bab1 call \
 with-config-path --config-path string

func (m *MyModule) Example(configPath string) *dagger.ConfluenceUpdater  {
	return dag.
			ConfluenceUpdater().
			WithConfigPath(configPath)
}

@function
def example(config_path: str) -> dagger.ConfluenceUpdater:
	return (
		dag.confluence_updater()
		.with_config_path(config_path)
	)

@func()
example(configPath: string): ConfluenceUpdater {
	return dag
		.confluenceUpdater()
		.withConfigPath(configPath)
}

withLabel() 🔗

Set label, can be used multiple times.

Return Type

ConfluenceUpdater !

Arguments

Name	Type	Default Value	Description
label	String !	-	No description provided

Example

dagger -m github.com/kerwood/dagger-modules/confluence-updater@5b63a92dfd3337ba01b5498021274da44067bab1 call \
 with-label --label string

func (m *MyModule) Example(label string) *dagger.ConfluenceUpdater  {
	return dag.
			ConfluenceUpdater().
			WithLabel(label)
}

@function
def example(label: str) -> dagger.ConfluenceUpdater:
	return (
		dag.confluence_updater()
		.with_label(label)
	)

@func()
example(label: string): ConfluenceUpdater {
	return dag
		.confluenceUpdater()
		.withLabel(label)
}

withLogLevel() 🔗

Log Level. [default: info] [possible values: trace, debug, info, warn, error]

Return Type

ConfluenceUpdater !

Arguments

Name	Type	Default Value	Description
logLevel	String !	-	No description provided

Example

dagger -m github.com/kerwood/dagger-modules/confluence-updater@5b63a92dfd3337ba01b5498021274da44067bab1 call \
 with-log-level --log-level string

func (m *MyModule) Example(logLevel string) *dagger.ConfluenceUpdater  {
	return dag.
			ConfluenceUpdater().
			WithLogLevel(logLevel)
}

@function
def example(log_level: str) -> dagger.ConfluenceUpdater:
	return (
		dag.confluence_updater()
		.with_log_level(log_level)
	)

@func()
example(logLevel: string): ConfluenceUpdater {
	return dag
		.confluenceUpdater()
		.withLogLevel(logLevel)
}

withSourceDirectory() 🔗

Source directory [default: root directory of repository]

Return Type

ConfluenceUpdater !

Arguments

Name	Type	Default Value	Description
srcDirectory	Directory !	-	No description provided

Example

dagger -m github.com/kerwood/dagger-modules/confluence-updater@5b63a92dfd3337ba01b5498021274da44067bab1 call \
 with-source-directory --src-directory DIR_PATH

func (m *MyModule) Example(srcDirectory *dagger.Directory) *dagger.ConfluenceUpdater  {
	return dag.
			ConfluenceUpdater().
			WithSourceDirectory(srcDirectory)
}

@function
def example(src_directory: dagger.Directory) -> dagger.ConfluenceUpdater:
	return (
		dag.confluence_updater()
		.with_source_directory(src_directory)
	)

@func()
example(srcDirectory: Directory): ConfluenceUpdater {
	return dag
		.confluenceUpdater()
		.withSourceDirectory(srcDirectory)
}

withCliVersion() 🔗

Set the version of the confluence-updater cli to use.

Return Type

ConfluenceUpdater !

Arguments

Name	Type	Default Value	Description
version	String !	-	No description provided

Example

dagger -m github.com/kerwood/dagger-modules/confluence-updater@5b63a92dfd3337ba01b5498021274da44067bab1 call \
 with-cli-version --version string

func (m *MyModule) Example(version string) *dagger.ConfluenceUpdater  {
	return dag.
			ConfluenceUpdater().
			WithCliVersion(version)
}

@function
def example(version: str) -> dagger.ConfluenceUpdater:
	return (
		dag.confluence_updater()
		.with_cli_version(version)
	)

@func()
example(version: string): ConfluenceUpdater {
	return dag
		.confluenceUpdater()
		.withCliVersion(version)
}