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

# bjd2385/github

Helpful GitHub functions, based on git and the gh CLI.


## Commands

### install-gh-cli

Install the GitHub gh CLI tool.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `version` | string | 2.12.1 | Version of the CLI to install. |

## Jobs

### increment-tag

Increment a repository's tag.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `ssh-key-fingerprint` | string |  | GitHub repository's SSH key (must be r/w). |

### release

Generate a GitHub release from the latest tag on a repository. Requires a GITHUB_TOKEN environment variable be set.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `tag` | string | latest | The tag from which to generate a release. Defaults to latest. |

### validate-tag

Ensure a tag is unpublished in CircleCI's registry

| Parameter | Type | Default | Description |
|---|---|---|---|
| `orb-name` | string |  | Orb name to query. |
| `tag` | string | $CIRCLE_TAG | Override the tag being checked. |
| `workspace` | string |  | Workspace within which to query. |

## Executors

### default

base default CircleCI executor.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `tag` | string | stable | Default stable Ubuntu executor. |