Dagger
Search

check-doc-version

documentation exists for the version specified in the release-please manifest.
This is used to ensure that we do not release a new version of the plugin
without having the corresponding documentation ready.

Installation

dagger install github.com/cloudnative-pg/plugin-barman-cloud/dagger/check-doc-version@b45cddfc193c7e5ba1ab050c951031c86a244141

Entrypoint

Return Type 
CheckDocVersion
Example
dagger -m github.com/cloudnative-pg/plugin-barman-cloud/dagger/check-doc-version@b45cddfc193c7e5ba1ab050c951031c86a244141 call \

func (m *MyModule) Example() *dagger.CheckDocVersion  {
	return dag.
			CheckDocVersion()
}
@function
def example() -> dagger.CheckDocVersion:
	return (
		dag.check_doc_version()
	)
@func()
example(): CheckDocVersion {
	return dag
		.checkDocVersion()
}

Types

CheckDocVersion 🔗

hasVersionDocumentation() 🔗

HasVersionDocumentation checks if a version of the documentation exists for the version in the release-please manifest.

Return Type 
Boolean !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
Example
dagger -m github.com/cloudnative-pg/plugin-barman-cloud/dagger/check-doc-version@b45cddfc193c7e5ba1ab050c951031c86a244141 call \
 has-version-documentation --src DIR_PATH
func (m *MyModule) Example(ctx context.Context, src *dagger.Directory) bool  {
	return dag.
			CheckDocVersion().
			HasVersionDocumentation(ctx, src)
}
@function
async def example(src: dagger.Directory) -> bool:
	return await (
		dag.check_doc_version()
		.has_version_documentation(src)
	)
@func()
async example(src: Directory): Promise<boolean> {
	return dag
		.checkDocVersion()
		.hasVersionDocumentation(src)
}