Install the fj CLI on a runner (checksum-pinned, from your Forgejo releases) and auth it with the workflow token. No github.com.
  • Shell 88.8%
  • Makefile 11.2%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Stephen Way 8b7864cc85
All checks were successful
test / unit (push) Successful in 3s
test / e2e (push) Successful in 6s
Merge pull request 'Scrub runner event env in test harness' (#1) from fix/harness-event-path-scrub into main
Reviewed-on: #1
2026-08-06 00:03:07 +00:00
.forgejo/workflows Initial release: setup-fj-action 2026-06-01 19:10:31 -07:00
scripts Fetch releases anonymously first (cross-repo token 404s) 2026-06-01 19:14:00 -07:00
tests Scrub runner event env in test harness 2026-08-05 23:07:04 +00:00
.gitignore Initial release: setup-fj-action 2026-06-01 19:10:31 -07:00
action.yml Repoint references from rasterstate to fjord org 2026-06-03 16:17:07 -07:00
CHANGELOG.md Initial release: setup-fj-action 2026-06-01 19:10:31 -07:00
LICENSE Initial release: setup-fj-action 2026-06-01 19:10:31 -07:00
Makefile Initial release: setup-fj-action 2026-06-01 19:10:31 -07:00
README.md Repoint references from rasterstate to fjord org 2026-06-03 16:17:07 -07:00

Setup fj

The fj CLI on your runner. Install a checksum-verified fj binary from your own Forgejo releases, put it on PATH, and authenticate it with the workflow's token, so any later step can fj pr, fj run, fj api, fj workflow run. No github.com.

Part of the Fjord Actions bundle. The foundation the fj-CLI-native actions build on.

Usage

jobs:
  orchestrate:
    runs-on: [self-hosted, Linux]
    steps:
      - uses: https://rasterhub.com/fjord/setup-fj-action@v1
        with:
          version: latest        # or a pinned tag like v0.1.3
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - run: fj pr list --json number,title
      - run: fj workflow run deploy.yml --ref main

Inputs

Input Default Description
version latest fj tag to install, or latest.
repository rasterstate/fj Repo publishing fj releases.
download-base <server>/<repo>/releases/download Override the download base URL / mirror.
authenticate true Run fj auth login with the token.
host GITHUB_SERVER_URL host Forgejo host for fj.
token GITHUB_TOKEN env Token for download (private repos) + auth.

Outputs

Output Description
version The fj version installed.

Notes

  • Releases are pulled from your Forgejo instance and verified against the release's SHA256SUMS. Supported platforms: linux-x86_64, darwin-aarch64, darwin-x86_64.
  • Auth is best-effort. fj auth login stores the token in the OS keychain; a keychain-less CI runner can't store it, so the action warns and continues (fj is still installed and FJ_HOST is exported). On such runners, pass the token per command, or run on a host-mode runner with a keyring. The install itself always works.

License

MIT, see LICENSE.