Files
CV_Site_Nuxt/OKF_Nuxt/decisions/release-engineering.md
T
Noel Sabia 7bf649cba6
PR Check / Dockerfile lint (droast) (pull_request) Skipped
PR Check / Security scan (Snyk) (pull_request) Skipped
PR Check / ESLint (pull_request) Successful in 36s
PR Check / Typecheck (pull_request) Successful in 38s
PR Check / Secret scan (gitleaks) (pull_request) Successful in 5s
PR Check / Dependency audit (pull_request) Successful in 9s
PR Check / AI code review (opencode) (pull_request) Failing after 13s
docs(okf): record CI/CD, AI review, release and secrets decisions
Four new decision documents covering the pipeline work: layering,
AI review setup (provider prefix, v2 CLI, env-only auth, verdict
gate), release engineering (release-please manifest mode), and the
Snyk pause with the token scope policy. Index grouped, log extended,
open questions updated.
2026-10-18 18:19:59 +02:00

2.6 KiB

type, title, description, tags, status, generated, verified, sources
type title description tags status generated verified sources
Decision Release engineering Releases are produced by release-please in manifest mode, driven by conventional commits, with the message format enforced at commit time by commitizen.
decision
release
release-please
ci
draft
by at
opencode-go/glm-5.3-flash 2026-10-18T16:05:00Z
by at
human:noel not yet
id resource title
config release-please-config.json release-please configuration
id resource title
manifest .release-please-manifest.json release-please manifest
id resource title
workflow .gitea/workflows/release-please.yml release-please workflow

Decision

On every push to main, release-please (manifest mode) collects conventional commits, derives the next version, and opens a release PR that bumps package.json, updates CHANGELOG.md and moves the manifest forward. Merging that PR creates the release. The message format that feeds this machine is enforced locally by the commitizen pre-commit hook.

Why

  • Manifest mode (config JSON + manifest JSON) over inline release-type in the workflow: the configuration becomes part of the repository, reviewable in PRs, instead of buried in workflow YAML.
  • Plain tags (v1.0.0, include-component-in-tag: false): single-package repository; component-prefixed tags would be noise.
  • A version field in package.json: the node release type reads it; without the field the release machinery cannot track anything.
  • Enforcement at commit time: a non-conventional message is not an error release-please reports — it just silently produces no release. Commitizen turns that silent failure into a blocked commit.

How a release happens, end to end

  1. Work lands on branches as conventional commits (feat:, fix:, chore:, …), enforced by the local hook.
  2. Merge to main → release-please opens/updates a release PR (chore(main): release …).
  3. Merge the release PR → version bumped, changelog written, tag vX.Y.Z created.

Not verified

  • The first release PR end to end — needs at least one feat:/fix: commit on main after the workflow merge.
  • That RELEASE_PLEASE_TOKEN_CV_SITE_NUXT carries the write:issue scope the same way PR_GITEA_TOKEN needed it; the previous failure was an immediate API rejection consistent with a scope problem.

Revisit when

  • A second package appears in the repository (then include-component-in-tag and separate-pull-requests matter).
  • A release must trigger a deploy — the workflow gains a step after release_created is set.