> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# tx3stn/vrsn

Running vrsn in CircleCI.

## Commands

### bump-version

Increment the current version in the version file.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `additional-args` | string |  | Additional arguments or flags to pass to the vrsn command. |
| `bump-type` | enum |  | The version increment type you want to make. |

### check-version

Check the version bump is a valid semver increment with vrsn.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `additional-args` | string |  | Additional arguments or flags to pass to the vrsn command. |

## Jobs

### check-version

Check the version bump is a valid semver increment with vrsn.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `additional-args` | string |  | Additional arguments or flags to pass to the vrsn command. |
| `executor` | executor | vrsn | The executor to use during the check version job. |
| `resource-class` | enum | small | The resource class to use for the job. |
| `working-directory` | string | /repo | The directory the project will be checked out to. |

### bump-version

Increment the semantic version with vrsn.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `additional-args` | string | --commit --commit-msg 'bump version from ci' | Additional arguments or flags to pass to the vrsn command. |
| `bump-type` | enum |  | The version increment type you want to make. |
| `check-before` | boolean | true | Check if the version has been incremented before bumping. |
| `check-args` | string |  | Additional arguments or flags to pass to the vrsn check command. |
| `executor` | executor | vrsn | The executor to use during the check version job. |
| `resource-class` | enum | small | The resource class to use for the job. |
| `ssh-key-fingerprint` | string |  | Finger print of the ssh key to use, required to commit the version bump back to the branch. |
| `working-directory` | string | /repo | The directory the project will be checked out to. |

## Executors

### vrsn

| Parameter | Type | Default | Description |
|---|---|---|---|
| `version` | string | 1.2.0 |  |