Skip to content

github-action.md

Latest commit

 

History

History
112 lines (87 loc) · 3.01 KB

github-action.md

File metadata and controls

112 lines (87 loc) · 3.01 KB

flopha GitHub Action

Auto-tag the next semantic version and optionally create a GitHub Release.

- uses: sjquant/flopha@v1
  with:
    create-release: true

Requires permissions: contents: write in the calling workflow.

When to use

flopha treats Git tags as the authoritative version source. It is not the right tool when the version lives in a file (Cargo.toml, package.json, etc.) and is bumped manually before release.

Inputs

Input Default Description
auto true Detect bump level from conventional commits: feat→minor, feat!/BREAKING CHANGE→major, anything else→patch.
increment patch Bump level when auto: false: major, minor, or patch.
pattern v{major}.{minor}.{patch} Tag pattern. Use {major}, {minor}, {patch} as placeholders, or {semver} as shorthand.
pre Pre-release channel: alpha, beta, rc, etc. Produces tags like v1.2.3-rc.1.
rule Custom bump rules, one per line, as level:regex. Replaces built-in conventional-commit defaults entirely.
create-release false Create a GitHub Release for the new tag.
draft false Create the release as a draft.
release-title tag name Title for the GitHub Release.
release-body Body text for the release. Takes precedence over generate-release-notes.
generate-release-notes false Auto-generate release notes from commits (GitHub API).
dry-run false Compute and print the next tag without creating or pushing anything.
flopha-version latest Pin the flopha binary version, e.g. v0.3.0.
github-token github.token Token used to push the tag and create the release.

Outputs

Output Description
tag The version tag created (or would-be, on dry-run), e.g. v1.3.0.
version Bare version number without prefix, e.g. 1.3.0.
release-url URL of the GitHub Release. Empty when create-release: false or dry-run: true.

Examples

Minimal — tag only:

permissions:
  contents: write

steps:
  - uses: actions/checkout@v4
    with:
      fetch-depth: 0
  - uses: sjquant/flopha@v1

Tag + GitHub Release:

permissions:
  contents: write

steps:
  - uses: actions/checkout@v4
    with:
      fetch-depth: 0
  - uses: sjquant/flopha@v1
    with:
      create-release: true
      generate-release-notes: true

Pre-release on non-main branches:

- uses: sjquant/flopha@v1
  with:
    pre: ${{ github.ref_name != 'main' && 'rc' || '' }}
    create-release: true

Custom bump rules:

- uses: sjquant/flopha@v1
  with:
    rule: |
      major:BREAKING CHANGE
      minor:^feat
    create-release: true
    draft: true

Dry-run (safe for PRs):

- uses: sjquant/flopha@v1
  id: next
  with:
    dry-run: true
- run: echo "Next tag will be ${{ steps.next.outputs.tag }}"

Monorepo / custom tag pattern:

- uses: sjquant/flopha@v1
  with:
    pattern: 'app@{semver}'