changelog
A module to generate changelog
Installation
dagger install github.com/shykes/dagger/toolchains/changelog@7ec44c64b509793d2a722ebdfef94a77dbcdcefeEntrypoint
Return Type
Changelog !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| source | Directory | - | 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 \
generatefunc (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
| Name | Type | Default Value | Description |
|---|---|---|---|
| component | String ! | - | No description provided |
| version | String ! | - | No description provided |
Example
dagger -m github.com/shykes/dagger/toolchains/changelog@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
lookup-entry --component string --version stringfunc (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)
}