nsv
NSV (Next Semantic Version) is a convention-based semantic versioning tool that leans on the power of conventional commits to make versioning your software a breeze!There are many semantic versioning tools already out there! But they typically require some configuration or custom scripting in your CI system to make them work. No one likes managing config; it is error-prone, and the slightest tweak ultimately triggers a cascade of change across your projects.
Step in NSV. Designed to make intelligent semantic versioning decisions about your project without needing a config file. Entirely convention-based, you can adapt your workflow from within your commit message.
The power is at your fingertips.
Installation
dagger install github.com/purpleclay/daggerverse/nsv@v0.4.0Entrypoint
Return Type
Nsv !Arguments
| Name | Type | Description |
|---|---|---|
| base | Container | a custom base image containing an installation of nsv |
| src | Directory ! | a path to a directory containing the projects source code |
Example
func (m *myModule) example(src *Directory) *Nsv {
return dag.
Nsv(src)
}@function
def example(src: dagger.Directory) -> dag.Nsv:
return (
dag.nsv(src)
)@func()
example(src: Directory): Nsv {
return dag
.nsv(src)
}Types
Nsv 🔗
NSV dagger module
next() 🔗
Prints the next semantic version based on the commit history of your repository
Return Type
String !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| paths | [String ! ] | - | a list of relative paths of projects to analyze |
| show | Boolean | - | show how the next semantic version was calculated |
| pretty | String | "full" | pretty-print the output of the next semantic version in a given format. Supported formats are (full, compact). Must be used in conjunction with the show flag |
| majorPrefixes | [String ! ] | - | a comma separated list of conventional commit prefixes for triggering a major semantic version increment |
| minorPrefixes | [String ! ] | - | a comma separated list of conventional commit prefixes for triggering a minor semantic version increment |
| patchPrefixes | [String ! ] | - | a comma separated list of conventional commit prefixes for triggering a patch semantic version increment |
Example
func (m *myModule) example(ctx context.Context, src *Directory) string {
return dag.
Nsv(src).
Next(ctx)
}@function
async def example(src: dagger.Directory) -> str:
return await (
dag.nsv(src)
.next()
)@func()
async example(src: Directory): Promise<string> {
return dag
.nsv(src)
.next()
}tag() 🔗
Tags the next semantic version based on the commit history of your repository
Return Type
String !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| paths | [String ! ] | - | a list of relative paths of projects to analyze |
| show | Boolean | - | show how the next semantic version was calculated |
| pretty | String | "full" | pretty-print the output of the next semantic version in a given format. Supported formats are (full, compact). Must be used in conjunction with the show flag |
| message | String | - | a custom message for the tag, supports go text templates |
| majorPrefixes | [String ! ] | - | a comma separated list of conventional commit prefixes for triggering a major semantic version increment |
| minorPrefixes | [String ! ] | - | a comma separated list of conventional commit prefixes for triggering a minor semantic version increment |
| patchPrefixes | [String ! ] | - | a comma separated list of conventional commit prefixes for triggering a patch semantic version increment |
| gpgPassphrase | Secret | - | an optional passphrase to unlock the GPG private key used for signing the tag |
| gpgPrivateKey | Secret | - | a base64 encoded GPG private key (armored) used for signing the tag |
Example
func (m *myModule) example(ctx context.Context, src *Directory) string {
return dag.
Nsv(src).
Tag(ctx)
}@function
async def example(src: dagger.Directory) -> str:
return await (
dag.nsv(src)
.tag()
)@func()
async example(src: Directory): Promise<string> {
return dag
.nsv(src)
.tag()
}