ForgeKit Documentation

Docs that start with a command, not a manifesto.

Install the CLI, connect a repo, ship a release. Then go deeper if you want.

Supports GitHub Actions Supports GitLab CI Config is readable YAML

Quickstart

Copy, paste, ship.

Global install is fastest for the first run. (Use your package manager if you prefer.)

ForgeKit detects your repo shape and generates a minimal, readable policy file.

Preview in a PR, then release. Same verbs locally and in CI.

GitHub Actions template

ForgeKit can generate a workflow file you can edit in plain YAML—no magic actions required.

# .github/workflows/release.yml
- name: Release
  run: forgekit release

Choose your flavor. Templates are meant to be owned by your team.

Fast path: checks → preview → release. Compose with your existing jobs.

Stages mirror the CLI verbs. No hidden includes required.

A policy is what you would tell a new teammate—written down.

Readable. Versioned. Reviewed like code. Evaluated locally and in CI.

checks:
  - name: tests
    command: pnpm test
  - name: lint
    command: pnpm lint
approvals:
  required: 1
release:
  block_after: "18:00"

The common gotchas (and the fixes).

Ensure your CI token has permission to push tags. In GitHub Actions, prefer a fine‑grained token scoped to your repo.

Add a secrets block to your policy so ForgeKit fails fast before tests run. It will validate presence and optionally format.

ForgeKit is telling you the release is safe to build—but not safe to ship. Add the required approval or release from an approved branch.

Confirm the token used by CI can comment on PRs/MRs. If you use forked PRs, you may need a separate workflow with restricted secrets.

Still stuck?

Send us the last 30 lines of output (redact secrets). We respond like engineers: with a repro and a fix.