DagCoco
Installation
Entrypoint
Types
DagCoco

DagCoco

No long description provided.

Installation

dagger install github.com/stackitcloud/dagger-cocogitto@87082ddf7f33a3acf1f6094e802474b6649e752f

Entrypoint

Return Type

DagCoco

Example

dagger -m github.com/stackitcloud/dagger-cocogitto@87082ddf7f33a3acf1f6094e802474b6649e752f call \

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

@function
def example() -> dagger.DagCoco:
	return (
		dag.dag_coco()
	)

@func()
example(): DagCoco {
	return dag
		.dagCoco()
}

Types

DagCoco 🔗

gitBase() 🔗

Initializing Git

Return Type

Container !

Arguments

Name	Type	Default Value	Description
user	String !	-	git config user
email	String !	-	git config email

Example

dagger -m github.com/stackitcloud/dagger-cocogitto@87082ddf7f33a3acf1f6094e802474b6649e752f call \
 git-base --user string --email string

func (m *MyModule) Example(user string, email string) *dagger.Container  {
	return dag.
			DagCoco().
			GitBase(user, email)
}

@function
def example(user: str, email: str) -> dagger.Container:
	return (
		dag.dag_coco()
		.git_base(user, email)
	)

@func()
example(user: string, email: string): Container {
	return dag
		.dagCoco()
		.gitBase(user, email)
}

cloneRepository() 🔗

Returns a container with the cloned repository in /repository

Return Type

Container !

Arguments

Name	Type	Default Value	Description
user	String !	-	git user interacting with the repo
email	String !	-	git user email
repositoryUrl	String !	-	repository url
gitToken	Secret !	-	secret git token

Example

dagger -m github.com/stackitcloud/dagger-cocogitto@87082ddf7f33a3acf1f6094e802474b6649e752f call \
 clone-repository --user string --email string --repository-url string --git-token env:MYSECRET

func (m *MyModule) Example(user string, email string, repositoryUrl string, gitToken *dagger.Secret) *dagger.Container  {
	return dag.
			DagCoco().
			CloneRepository(user, email, repositoryUrl, gitToken)
}

@function
def example(user: str, email: str, repository_url: str, git_token: dagger.Secret) -> dagger.Container:
	return (
		dag.dag_coco()
		.clone_repository(user, email, repository_url, git_token)
	)

@func()
example(user: string, email: string, repositoryUrl: string, gitToken: Secret): Container {
	return dag
		.dagCoco()
		.cloneRepository(user, email, repositoryUrl, gitToken)
}

base() 🔗

Base Function returning a rust latest container with cocogitto installed

Return Type

Container !

Arguments

Name	Type	Default Value	Description
repositoryUrl	String !	-	remote repository url
user	String !	-	user account name
email	String !	-	git email
gitToken	Secret !	-	user account git token

Example

dagger -m github.com/stackitcloud/dagger-cocogitto@87082ddf7f33a3acf1f6094e802474b6649e752f call \
 base --repository-url string --user string --email string --git-token env:MYSECRET

func (m *MyModule) Example(repositoryUrl string, user string, email string, gitToken *dagger.Secret) *dagger.Container  {
	return dag.
			DagCoco().
			Base(repositoryUrl, user, email, gitToken)
}

@function
def example(repository_url: str, user: str, email: str, git_token: dagger.Secret) -> dagger.Container:
	return (
		dag.dag_coco()
		.base(repository_url, user, email, git_token)
	)

@func()
example(repositoryUrl: string, user: string, email: string, gitToken: Secret): Container {
	return dag
		.dagCoco()
		.base(repositoryUrl, user, email, gitToken)
}

bump() 🔗

Bump version https://docs.cocogitto.io/guide/bump.html

Return Type

String !

Arguments

Name	Type	Default Value	Description
repositoryUrl	String !	-	remote repository URL
user	String !	-	remote username
email	String !	-	remote email
gitToken	Secret !	-	secret Git token
auto	Boolean	-	auto bump version
cogToml	File	-	cogToml file reference
dryRun	Boolean	-	should run dry
major	Boolean	-	increment major
minor	Boolean	-	increment minor
patch	Boolean	-	increment patch
preMeta	String	-	metadata before building
buildMeta	String	-	build metadata
version	String	-	set specfic version (prio over major,minor,patch)
skipCi	Boolean	-	Skip ci flag

Example

dagger -m github.com/stackitcloud/dagger-cocogitto@87082ddf7f33a3acf1f6094e802474b6649e752f call \
 bump --repository-url string --user string --email string --git-token env:MYSECRET

func (m *MyModule) Example(ctx context.Context, repositoryUrl string, user string, email string, gitToken *dagger.Secret) string  {
	return dag.
			DagCoco().
			Bump(ctx, repositoryUrl, user, email, gitToken)
}

@function
async def example(repository_url: str, user: str, email: str, git_token: dagger.Secret) -> str:
	return await (
		dag.dag_coco()
		.bump(repository_url, user, email, git_token)
	)

@func()
async example(repositoryUrl: string, user: string, email: string, gitToken: Secret): Promise<string> {
	return dag
		.dagCoco()
		.bump(repositoryUrl, user, email, gitToken)
}

changelog() 🔗

Generate a changelog automatically https://docs.cocogitto.io/guide/changelog.html

Return Type

String !

Arguments

Name	Type	Default Value	Description
repositoryUrl	String !	-	remote repo address
user	String !	-	remote user account
email	String !	-	remote email account
gitToken	Secret !	-	secret git token
version	String !	-	No description provided
at	String	-	changelog between 1.00 and at
template	String	-	changelog template: default, full_hash, remote
remote	String	-	remote domain: e.g. google.com
owner	String	-	user account / organization
repository	String	-	repository name

Example

dagger -m github.com/stackitcloud/dagger-cocogitto@87082ddf7f33a3acf1f6094e802474b6649e752f call \
 changelog --repository-url string --user string --email string --git-token env:MYSECRET --version string

func (m *MyModule) Example(ctx context.Context, repositoryUrl string, user string, email string, gitToken *dagger.Secret, version string) string  {
	return dag.
			DagCoco().
			Changelog(ctx, repositoryUrl, user, email, gitToken, version)
}

@function
async def example(repository_url: str, user: str, email: str, git_token: dagger.Secret, version: str) -> str:
	return await (
		dag.dag_coco()
		.changelog(repository_url, user, email, git_token, version)
	)

@func()
async example(repositoryUrl: string, user: string, email: string, gitToken: Secret, version: string): Promise<string> {
	return dag
		.dagCoco()
		.changelog(repositoryUrl, user, email, gitToken, version)
}

check() 🔗

Check commit history against conventional commits spec https://docs.cocogitto.io/guide/check.html

Return Type

String !

Arguments

Name	Type	Default Value	Description
repositoryUrl	String !	-	remote repository url
user	String !	-	user account
email	String !	-	git email
gitToken	Secret !	-	remote git token secret
cogToml	File	-	No description provided

Example

dagger -m github.com/stackitcloud/dagger-cocogitto@87082ddf7f33a3acf1f6094e802474b6649e752f call \
 check --repository-url string --user string --email string --git-token env:MYSECRET

func (m *MyModule) Example(ctx context.Context, repositoryUrl string, user string, email string, gitToken *dagger.Secret) string  {
	return dag.
			DagCoco().
			Check(ctx, repositoryUrl, user, email, gitToken)
}

@function
async def example(repository_url: str, user: str, email: str, git_token: dagger.Secret) -> str:
	return await (
		dag.dag_coco()
		.check(repository_url, user, email, git_token)
	)

@func()
async example(repositoryUrl: string, user: string, email: string, gitToken: Secret): Promise<string> {
	return dag
		.dagCoco()
		.check(repositoryUrl, user, email, gitToken)
}

commit() 🔗

Create a new conventional commit using coco https://docs.cocogitto.io/guide/commit.html

Return Type

String !

Arguments

Name	Type	Default Value	Description
repositoryUrl	String !	-	remote repo url
user	String !	-	user account
email	String !	-	git email
gitToken	Secret !	-	repository secret token
cogToml	File	-	Cocogitto config file
commitType	String	-	tyoe of commit
commitMessage	String	-	commit message
breakingChange	Boolean	-	is it a breaking change

Example

dagger -m github.com/stackitcloud/dagger-cocogitto@87082ddf7f33a3acf1f6094e802474b6649e752f call \
 commit --repository-url string --user string --email string --git-token env:MYSECRET

func (m *MyModule) Example(ctx context.Context, repositoryUrl string, user string, email string, gitToken *dagger.Secret) string  {
	return dag.
			DagCoco().
			Commit(ctx, repositoryUrl, user, email, gitToken)
}

@function
async def example(repository_url: str, user: str, email: str, git_token: dagger.Secret) -> str:
	return await (
		dag.dag_coco()
		.commit(repository_url, user, email, git_token)
	)

@func()
async example(repositoryUrl: string, user: string, email: string, gitToken: Secret): Promise<string> {
	return dag
		.dagCoco()
		.commit(repositoryUrl, user, email, gitToken)
}

getVersion() 🔗

Get the current version https://docs.cocogitto.io/guide/misc.html

Return Type

String !

Arguments

Name	Type	Default Value	Description
repositoryUrl	String !	-	remote repo URL
user	String !	-	username
email	String !	-	git email
gitToken	Secret !	-	secret git token
fallback	String	-	fallback version
pack	String	-	define package name
silence	Boolean	-	Only get version

Example

dagger -m github.com/stackitcloud/dagger-cocogitto@87082ddf7f33a3acf1f6094e802474b6649e752f call \
 get-version --repository-url string --user string --email string --git-token env:MYSECRET

func (m *MyModule) Example(ctx context.Context, repositoryUrl string, user string, email string, gitToken *dagger.Secret) string  {
	return dag.
			DagCoco().
			GetVersion(ctx, repositoryUrl, user, email, gitToken)
}

@function
async def example(repository_url: str, user: str, email: str, git_token: dagger.Secret) -> str:
	return await (
		dag.dag_coco()
		.get_version(repository_url, user, email, git_token)
	)

@func()
async example(repositoryUrl: string, user: string, email: string, gitToken: Secret): Promise<string> {
	return dag
		.dagCoco()
		.getVersion(repositoryUrl, user, email, gitToken)
}

installHooks() 🔗

Install a single or all hooks https://docs.cocogitto.io/guide/git_hooks.html

Return Type

String !

Arguments

Name	Type	Default Value	Description
repositoryUrl	String !	-	remote repo URL
user	String !	-	username
email	String !	-	git email
gitToken	Secret !	-	git secret token
commits	String	-	semver, commit, range commit xxx..xxy

Example

dagger -m github.com/stackitcloud/dagger-cocogitto@87082ddf7f33a3acf1f6094e802474b6649e752f call \
 install-hooks --repository-url string --user string --email string --git-token env:MYSECRET

func (m *MyModule) Example(ctx context.Context, repositoryUrl string, user string, email string, gitToken *dagger.Secret) string  {
	return dag.
			DagCoco().
			InstallHooks(ctx, repositoryUrl, user, email, gitToken)
}

@function
async def example(repository_url: str, user: str, email: str, git_token: dagger.Secret) -> str:
	return await (
		dag.dag_coco()
		.install_hooks(repository_url, user, email, git_token)
	)

@func()
async example(repositoryUrl: string, user: string, email: string, gitToken: Secret): Promise<string> {
	return dag
		.dagCoco()
		.installHooks(repositoryUrl, user, email, gitToken)
}

log() 🔗

Get cocogitto log (like custom git log) https://docs.cocogitto.io/guide/log.html

Return Type

String !

Arguments

Name	Type	Default Value	Description
repositoryUrl	String !	-	repository remote address
user	String !	-	username
email	String !	-	git email
gitToken	Secret !	-	git token
authors	[String ! ]	-	filter authors
commitType	String	-	define commit type: e.g. feat
scope	String	-	scope of commit
noError	Boolean	-	no error enforce
breakingOnly	Boolean	-	filter breaking changes only

Example

dagger -m github.com/stackitcloud/dagger-cocogitto@87082ddf7f33a3acf1f6094e802474b6649e752f call \
 log --repository-url string --user string --email string --git-token env:MYSECRET

func (m *MyModule) Example(ctx context.Context, repositoryUrl string, user string, email string, gitToken *dagger.Secret) string  {
	return dag.
			DagCoco().
			Log(ctx, repositoryUrl, user, email, gitToken)
}

@function
async def example(repository_url: str, user: str, email: str, git_token: dagger.Secret) -> str:
	return await (
		dag.dag_coco()
		.log(repository_url, user, email, git_token)
	)

@func()
async example(repositoryUrl: string, user: string, email: string, gitToken: Secret): Promise<string> {
	return dag
		.dagCoco()
		.log(repositoryUrl, user, email, gitToken)
}

verify() 🔗

Checks input string against conventional commits specification, error if not a conv commit https://docs.cocogitto.io/guide/verify.html

Return Type

String !

Arguments

Name	Type	Default Value	Description
repositoryUrl	String !	-	repository url
user	String !	-	username
email	String !	-	git email
gitToken	Secret !	-	git token secret
commitMsg	String !	-	message to check

Example

dagger -m github.com/stackitcloud/dagger-cocogitto@87082ddf7f33a3acf1f6094e802474b6649e752f call \
 verify --repository-url string --user string --email string --git-token env:MYSECRET --commit-msg string

func (m *MyModule) Example(ctx context.Context, repositoryUrl string, user string, email string, gitToken *dagger.Secret, commitMsg string) string  {
	return dag.
			DagCoco().
			Verify(ctx, repositoryUrl, user, email, gitToken, commitMsg)
}

@function
async def example(repository_url: str, user: str, email: str, git_token: dagger.Secret, commit_msg: str) -> str:
	return await (
		dag.dag_coco()
		.verify(repository_url, user, email, git_token, commit_msg)
	)

@func()
async example(repositoryUrl: string, user: string, email: string, gitToken: Secret, commitMsg: string): Promise<string> {
	return dag
		.dagCoco()
		.verify(repositoryUrl, user, email, gitToken, commitMsg)
}