git-chglog
Git-Changelog is a command-line tool that allows you to generate a changelog from a git repository.See https://github.com/git-chglog/git-chglog for more information.
Installation
dagger install github.com/vbehar/daggerverse/git-chglog@v0.6.0
Entrypoint
Return Type
GitChglog !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
imageRepository | String | "quay.io/git-chglog/git-chglog" | image repository of git-chglog. |
imageTag | String | "0.15.4@sha256:c791b1e8264387690cce4ce32e18b4f59ca3ffd8d55cb4093dc6de74529493f4" | image tag of git-chglog. See https://github.com/git-chglog/git-chglog/releases for available versions. Run `crane digest quay.io/git-chglog/git-chglog:0.15.4` to get the digest. |
chglogDir | Directory | - | directory containing the chglog config and template. See https://github.com/git-chglog/git-chglog/#configuration and https://github.com/git-chglog/git-chglog/#templates If empty, a default config and template will be used. |
Example
dagger -m github.com/vbehar/daggerverse/git-chglog@3a7ca43cc082808e5d7e228e65ffdbd66f2a2438 call \
func (m *myModule) example() *GitChglog {
return dag.
GitChglog()
}
@function
def example() -> dag.GitChglog:
return (
dag.git_chglog()
)
@func()
example(): GitChglog {
return dag
.gitChglog()
}
Types
GitChglog 🔗
GitChglog is a Dagger Module to interact with the git-chglog CLI.
imageRepository() 🔗
Return Type
String !
Example
dagger -m github.com/vbehar/daggerverse/git-chglog@3a7ca43cc082808e5d7e228e65ffdbd66f2a2438 call \
image-repository
func (m *myModule) example(ctx context.Context) string {
return dag.
GitChglog().
ImageRepository(ctx)
}
@function
async def example() -> str:
return await (
dag.git_chglog()
.image_repository()
)
@func()
async example(): Promise<string> {
return dag
.gitChglog()
.imageRepository()
}
imageTag() 🔗
Return Type
String !
Example
dagger -m github.com/vbehar/daggerverse/git-chglog@3a7ca43cc082808e5d7e228e65ffdbd66f2a2438 call \
image-tag
func (m *myModule) example(ctx context.Context) string {
return dag.
GitChglog().
ImageTag(ctx)
}
@function
async def example() -> str:
return await (
dag.git_chglog()
.image_tag()
)
@func()
async example(): Promise<string> {
return dag
.gitChglog()
.imageTag()
}
chglogDir() 🔗
Return Type
Directory !
Example
dagger -m github.com/vbehar/daggerverse/git-chglog@3a7ca43cc082808e5d7e228e65ffdbd66f2a2438 call \
chglog-dir
func (m *myModule) example() *Directory {
return dag.
GitChglog().
ChglogDir()
}
@function
def example() -> dagger.Directory:
return (
dag.git_chglog()
.chglog_dir()
)
@func()
example(): Directory {
return dag
.gitChglog()
.chglogDir()
}
container() 🔗
Container returns a container with git-chglog installed and configured.
Return Type
Container !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
gitDirectory | Directory | - | git directory to include in the container. |
Example
dagger -m github.com/vbehar/daggerverse/git-chglog@3a7ca43cc082808e5d7e228e65ffdbd66f2a2438 call \
container
func (m *myModule) example() *Container {
return dag.
GitChglog().
Container()
}
@function
def example() -> dagger.Container:
return (
dag.git_chglog()
.container()
)
@func()
example(): Container {
return dag
.gitChglog()
.container()
}
changelog() 🔗
Changelog generates a changelog for the given git repository and version.
Return Type
File !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
gitDirectory | Directory ! | - | git directory |
version | String ! | - | version to generate the changelog for. See https://github.com/git-chglog/git-chglog/#cli-usage for the supported formats. |
ctr | Container | - | container to use for the command, instead of the default container you can use this to customize the container |
Example
dagger -m github.com/vbehar/daggerverse/git-chglog@3a7ca43cc082808e5d7e228e65ffdbd66f2a2438 call \
changelog --git-directory DIR_PATH --version string
func (m *myModule) example(gitDirectory *Directory, version string) *File {
return dag.
GitChglog().
Changelog(gitDirectory, version)
}
@function
def example(git_directory: dagger.Directory, version: str) -> dagger.File:
return (
dag.git_chglog()
.changelog(git_directory, version)
)
@func()
example(gitDirectory: Directory, version: string): File {
return dag
.gitChglog()
.changelog(gitDirectory, version)
}