version
In general, it attempts to follow go's psedudoversioning:https://go.dev/doc/modules/version-numbers
Installation
dagger install github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1eeEntrypoint
Return Type
Version !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| inputs | Directory | - | A directory containing all the inputs of the artifact to be versioned. An input is any file that changes the artifact if it changes. This directory is used to compute a digest. If any input changes, the digest changes. - To avoid false positives, only include actual inputs - To avoid false negatives, include *all* inputs |
| gitDir | Directory | - | No description provided |
| changes | Directory | - | .changes file used to extract version information |
Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
func (m *MyModule) Example() *dagger.Version {
return dag.
Version()
}@function
def example() -> dagger.Version:
return (
dag.version()
)@func()
example(): Version {
return dag
.version()
}Types
Version 🔗
gitDir() 🔗
Return Type
Directory ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
git-dirfunc (m *MyModule) Example() *dagger.Directory {
return dag.
Version().
GitDir()
}@function
def example() -> dagger.Directory:
return (
dag.version()
.git_dir()
)@func()
example(): Directory {
return dag
.version()
.gitDir()
}inputs() 🔗
Return Type
Directory ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
inputsfunc (m *MyModule) Example() *dagger.Directory {
return dag.
Version().
Inputs()
}@function
def example() -> dagger.Directory:
return (
dag.version()
.inputs()
)@func()
example(): Directory {
return dag
.version()
.inputs()
}changes() 🔗
Return Type
Directory ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
changesfunc (m *MyModule) Example() *dagger.Directory {
return dag.
Version().
Changes()
}@function
def example() -> dagger.Directory:
return (
dag.version()
.changes()
)@func()
example(): Directory {
return dag
.version()
.changes()
}version() 🔗
Generate a version string from the current context
Return Type
String ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
versionfunc (m *MyModule) Example(ctx context.Context) string {
return dag.
Version().
Version(ctx)
}@function
async def example() -> str:
return await (
dag.version()
.version()
)@func()
async example(): Promise<string> {
return dag
.version()
.version()
}imageTag() 🔗
Return the tag to use when auto-downloading the engine image from the CLI
Return Type
String ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
image-tagfunc (m *MyModule) Example(ctx context.Context) string {
return dag.
Version().
ImageTag(ctx)
}@function
async def example() -> str:
return await (
dag.version()
.image_tag()
)@func()
async example(): Promise<string> {
return dag
.version()
.imageTag()
}lastReleaseVersion() 🔗
Determine the last released version.
Return Type
String ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
last-release-versionfunc (m *MyModule) Example(ctx context.Context) string {
return dag.
Version().
LastReleaseVersion(ctx)
}@function
async def example() -> str:
return await (
dag.version()
.last_release_version()
)@func()
async example(): Promise<string> {
return dag
.version()
.lastReleaseVersion()
}nextReleaseVersion() 🔗
Determine the “next” version to be released.
It first attempts to use the version in .changes/.next, but if this fails, or that version seems to have already been released, then we automagically calculate the next patch release in the current series.
Return Type
String ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
next-release-versionfunc (m *MyModule) Example(ctx context.Context) string {
return dag.
Version().
NextReleaseVersion(ctx)
}@function
async def example() -> str:
return await (
dag.version()
.next_release_version()
)@func()
async example(): Promise<string> {
return dag
.version()
.nextReleaseVersion()
}git() 🔗
Return Type
Git ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
gitfunc (m *MyModule) Example() *dagger.VersionGit {
return dag.
Version().
Git()
}@function
def example() -> dagger.VersionGit:
return (
dag.version()
.git()
)@func()
example(): VersionGit {
return dag
.version()
.git()
}Git 🔗
Git is an opinionated helper for performing various commands on our dagger repo.
container() 🔗
Return Type
Container ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
git \
containerfunc (m *MyModule) Example() *dagger.Container {
return dag.
Version().
Git().
Container()
}@function
def example() -> dagger.Container:
return (
dag.version()
.git()
.container()
)@func()
example(): Container {
return dag
.version()
.git()
.container()
}versionTagLatest() 🔗
VersionTagLatests gets the latest version tag for a given component
Return Type
Tag !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| component | String | - | No description provided |
Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
git \
version-tag-latestfunc (m *MyModule) Example() *dagger.VersionTag {
return dag.
Version().
Git().
VersionTagLatest()
}@function
def example() -> dagger.VersionTag:
return (
dag.version()
.git()
.version_tag_latest()
)@func()
example(): VersionTag {
return dag
.version()
.git()
.versionTagLatest()
}versionTags() 🔗
VersionTags gets all version tags for a given component - the resulting versions are sorted in ascending order
Return Type
[Tag ! ] !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| component | String | - | No description provided |
Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
git \
version-tagsfunc (m *MyModule) Example() []*dagger.VersionTag {
return dag.
Version().
Git().
VersionTags()
}@function
def example() -> List[dagger.VersionTag]:
return (
dag.version()
.git()
.version_tags()
)@func()
example(): VersionTag[] {
return dag
.version()
.git()
.versionTags()
}head() 🔗
Return Type
Commit ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
git \
headfunc (m *MyModule) Example() *dagger.VersionCommit {
return dag.
Version().
Git().
Head()
}@function
def example() -> dagger.VersionCommit:
return (
dag.version()
.git()
.head()
)@func()
example(): VersionCommit {
return dag
.version()
.git()
.head()
}commit() 🔗
Return Type
Commit !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| ref | String ! | - | No description provided |
Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
git \
commit --ref stringfunc (m *MyModule) Example(ref string) *dagger.VersionCommit {
return dag.
Version().
Git().
Commit(ref)
}@function
def example(ref: str) -> dagger.VersionCommit:
return (
dag.version()
.git()
.commit(ref)
)@func()
example(ref: string): VersionCommit {
return dag
.version()
.git()
.commit(ref)
}mergeBase() 🔗
Return Type
Commit !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| ref | String ! | - | No description provided |
| ref2 | String ! | - | No description provided |
Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
git \
merge-base --ref string --ref-2 stringfunc (m *MyModule) Example(ref string, ref2 string) *dagger.VersionCommit {
return dag.
Version().
Git().
MergeBase(ref, ref2)
}@function
def example(ref: str, ref2: str) -> dagger.VersionCommit:
return (
dag.version()
.git()
.merge_base(ref, ref2)
)@func()
example(ref: string, ref2: string): VersionCommit {
return dag
.version()
.git()
.mergeBase(ref, ref2)
}dirty() 🔗
Return whether the current git state is dirty
Return Type
Boolean ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
git \
dirtyfunc (m *MyModule) Example(ctx context.Context) bool {
return dag.
Version().
Git().
Dirty(ctx)
}@function
async def example() -> bool:
return await (
dag.version()
.git()
.dirty()
)@func()
async example(): Promise<boolean> {
return dag
.version()
.git()
.dirty()
}Tag 🔗
component() 🔗
The component this belongs to.
Return Type
String ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
git \
version-tag-latest \
componentfunc (m *MyModule) Example(ctx context.Context) string {
return dag.
Version().
Git().
VersionTagLatest().
Component(ctx)
}@function
async def example() -> str:
return await (
dag.version()
.git()
.version_tag_latest()
.component()
)@func()
async example(): Promise<string> {
return dag
.version()
.git()
.versionTagLatest()
.component()
}version() 🔗
The semver version for this component.
Return Type
String ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
git \
version-tag-latest \
versionfunc (m *MyModule) Example(ctx context.Context) string {
return dag.
Version().
Git().
VersionTagLatest().
Version(ctx)
}@function
async def example() -> str:
return await (
dag.version()
.git()
.version_tag_latest()
.version()
)@func()
async example(): Promise<string> {
return dag
.version()
.git()
.versionTagLatest()
.version()
}commit() 🔗
The commit hash.
Return Type
String ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
git \
version-tag-latest \
commitfunc (m *MyModule) Example(ctx context.Context) string {
return dag.
Version().
Git().
VersionTagLatest().
Commit(ctx)
}@function
async def example() -> str:
return await (
dag.version()
.git()
.version_tag_latest()
.commit()
)@func()
async example(): Promise<string> {
return dag
.version()
.git()
.versionTagLatest()
.commit()
}date() 🔗
The tag creator date. Distinct from author date, and not to be confused with the underlying commit date.
Return Type
String ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
git \
version-tag-latest \
datefunc (m *MyModule) Example(ctx context.Context) string {
return dag.
Version().
Git().
VersionTagLatest().
Date(ctx)
}@function
async def example() -> str:
return await (
dag.version()
.git()
.version_tag_latest()
.date()
)@func()
async example(): Promise<string> {
return dag
.version()
.git()
.versionTagLatest()
.date()
}Commit 🔗
commit() 🔗
The commit hash.
Return Type
String ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
git \
merge-base --ref string --ref-2 string \
commitfunc (m *MyModule) Example(ctx context.Context, ref string, ref2 string) string {
return dag.
Version().
Git().
MergeBase(ref, ref2).
Commit(ctx)
}@function
async def example(ref: str, ref2: str) -> str:
return await (
dag.version()
.git()
.merge_base(ref, ref2)
.commit()
)@func()
async example(ref: string, ref2: string): Promise<string> {
return dag
.version()
.git()
.mergeBase(ref, ref2)
.commit()
}date() 🔗
The commit commit date. Distinct from the author date.
Return Type
String ! Example
dagger -m github.com/dagger/dagger/version@69c1a1c6de5772201ddab5e1814fcfea2317b1ee call \
git \
merge-base --ref string --ref-2 string \
datefunc (m *MyModule) Example(ctx context.Context, ref string, ref2 string) string {
return dag.
Version().
Git().
MergeBase(ref, ref2).
Date(ctx)
}@function
async def example(ref: str, ref2: str) -> str:
return await (
dag.version()
.git()
.merge_base(ref, ref2)
.date()
)@func()
async example(ref: string, ref2: string): Promise<string> {
return dag
.version()
.git()
.mergeBase(ref, ref2)
.date()
}