> Every action input maps to a CLI flag of the same name.
> Source: https://orochibraru.com/releaser/docs/options · Site index: https://orochibraru.com/llms.txt

# Inputs and Flags

Every action input maps to a CLI flag of the same name.

```yaml
- uses: orochibraru/releaser@v1
  with:
    branch: main
    rules: ""
    prepare: ""
    commit: ""
    artifacts: ""
    docker: false
    docker-image: ""
    docker-platforms: ""
    draft: false
    prerelease: ""
    release-pr: false
    dry-run: false
    token: ${{ github.token }}
```

| Input / flag       | Default                  | Description                                                                                                                                                                                   |
| ------------------ | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `branch`           | `main`                   | Branch to release from. Any other branch is a no-op.                                                                                                                                          |
| `rules`            | —                        | Bump overrides, e.g. `breaking=patch,feat=patch`. See [Versioning](https://orochibraru.com/releaser/docs/versioning#rules).                                                                                                      |
| `prepare`          | —                        | Shell command run before the release commit. `${version}` is replaced with the new version, e.g. `1.2.3`. It doesn't see `GITHUB_TOKEN` or `GH_TOKEN`; pass what it needs under another name. |
| `commit`           | —                        | Extra files for the release commit, comma separated. `CHANGELOG.md` and `package.json` (when present) are always committed.                                                                   |
| `artifacts`        | —                        | Enables [artifact mode](https://orochibraru.com/releaser/docs/artifacts). `path[=name]`, comma or newline separated.                                                                                                             |
| `docker`           | `false`                  | Enables [Docker mode](https://orochibraru.com/releaser/docs/docker).                                                                                                                                                             |
| `docker-image`     | `ghcr.io/<owner>/<repo>` | Image to push.                                                                                                                                                                                |
| `docker-platforms` | —                        | e.g. `linux/amd64,linux/arm64`.                                                                                                                                                               |
| `draft`            | `false`                  | Create the GitHub release as a draft, assets still attached. Publish it yourself (`gh release edit`).                                                                                         |
| `prerelease`       | —                        | Ship every push as `X.Y.Z-<id>.N`: tag and GitHub prerelease, no commit. See [Canaries and release PR](https://orochibraru.com/releaser/docs/trunk).                                                                             |
| `release-pr`       | `false`                  | Open or update a release PR instead of committing; merging it releases. See [Canaries and release PR](https://orochibraru.com/releaser/docs/trunk).                                                                              |
| `dry-run`          | `false` in CI            | Only print the next version and notes. The CLI defaults to `true` when `CI` is unset.                                                                                                         |
| `token`            | `github.token`           | Action only; the CLI reads `GITHUB_TOKEN` or `GH_TOKEN`. Used for the release, uploads, the release PR and the ghcr.io login.                                                                 |

## Outputs

| Output       | Example  | Description                                               |
| ------------ | -------- | --------------------------------------------------------- |
| `released`   | `true`   | `false` when nothing shipped, dry runs included.          |
| `version`    | `1.2.3`  | The version released, or that a dry run would release.    |
| `tag`        | `v1.2.3` | Same as `version`, with the `v`.                          |
| `prerelease` | `false`  | `true` when `version` is a prerelease (`1.2.3-canary.4`). |

| Case                                | `released` | `version` |
| ----------------------------------- | ---------- | --------- |
| released                            | `true`     | set       |
| dry run with a release pending      | `false`    | set       |
| nothing to release, or wrong branch | `false`    | empty     |

```yaml
- id: release
  uses: orochibraru/releaser@v1
- if: steps.release.outputs.released == 'true'
  run: echo "shipped ${{ steps.release.outputs.tag }}"
```

## Environment

The CLI reads the usual Actions variables, so it behaves the same inside the
action or as a plain `run:` step:

| Variable                              | Used for                                       |
| ------------------------------------- | ---------------------------------------------- |
| `CI`                                  | Unset → dry run by default.                    |
| `GITHUB_TOKEN` / `GH_TOKEN`           | GitHub release, uploads, release PR, ghcr.io.  |
| `GITHUB_REF_NAME`                     | Current branch (falls back to `git`).          |
| `GITHUB_REPOSITORY`                   | `owner/repo` (falls back to the `origin` URL). |
| `GITHUB_SERVER_URL`, `GITHUB_API_URL` | GitHub Enterprise Server.                      |
| `GITHUB_ACTOR`                        | ghcr.io login username.                        |
| `GITHUB_OUTPUT`                       | Where the outputs above are written.           |