Dagger
Search

changelog

A module to generate changelog

Installation

dagger install github.com/shykes/dagger/toolchains/changelog@7ec44c64b509793d2a722ebdfef94a77dbcdcefe

Entrypoint

Return Type
Changelog !
Arguments
NameTypeDefault ValueDescription
sourceDirectory -No description provided
Example
dagger -m github.com/shykes/dagger/toolchains/changelog@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
func (m *MyModule) Example() *dagger.Changelog  {
	return dag.
			Changelog()
}
@function
def example() -> dagger.Changelog:
	return (
		dag.changelog()
	)
@func()
example(): Changelog {
	return dag
		.changelog()
}

Types

Changelog 🔗

generate() 🔗

Generate the changelog with ‘changie merge’. Only run this manually, at release time.

Return Type
Changeset !
Example
dagger -m github.com/shykes/dagger/toolchains/changelog@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 generate
func (m *MyModule) Example() *dagger.Changeset  {
	return dag.
			Changelog().
			Generate()
}
@function
def example() -> dagger.Changeset:
	return (
		dag.changelog()
		.generate()
	)
@func()
example(): Changeset {
	return dag
		.changelog()
		.generate()
}

lookupEntry() 🔗

Lookup the change notes file for the given component and version

Return Type
File !
Arguments
NameTypeDefault ValueDescription
componentString !-No description provided
versionString !-No description provided
Example
dagger -m github.com/shykes/dagger/toolchains/changelog@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 lookup-entry --component string --version string
func (m *MyModule) Example(component string, version string) *dagger.File  {
	return dag.
			Changelog().
			LookupEntry(component, version)
}
@function
def example(component: str, version: str) -> dagger.File:
	return (
		dag.changelog()
		.lookup_entry(component, version)
	)
@func()
example(component: string, version: string): File {
	return dag
		.changelog()
		.lookupEntry(component, version)
}