Skip to content

RELEASE.md

Latest commit

 

History

History
71 lines (48 loc) · 2.37 KB

RELEASE.md

File metadata and controls

71 lines (48 loc) · 2.37 KB

Release process

How maintainers ship semver tags for CVE Radar.

Prerequisites

  • Green CI on the commit you will tag (make check locally)
  • CHANGELOG.md updated under [X.Y.Z]
  • package.json version matches the tag (without v prefix)

Steps

  1. Bump version

    npm version 1.2.0 --no-git-tag-version   # or edit package.json manually

  2. Edit CHANGELOG — move items from [Unreleased] to the new section with date.

  3. Commit

    git add package.json CHANGELOG.md
git commit -m "chore: release v1.2.0"
git push origin main

  4. Tag and push (triggers Release / GitHub and Release / Docker Hub)

    git tag v1.2.0
git push origin v1.2.0

  5. Verify

    • GitHub Releases — assets: cve-radar-vX.Y.Z-dist.tar.gz, CHANGELOG.md
    • Docker Hub — tags X.Y.Z and latest (on git tag v*)
    • GitHub Pages — Deploy / GitHub Pages (dispatched on main after release; or push extended-docs/ to main)
    • curl -s https://your-host/api/health | jq .version matches X.Y.Z

What the Release workflow runs

Same gate as CI app job:

  • ESLint, Prettier, TypeScript, tests, OpenAPI sync
  • npm run build && npm run build:server
  • Tag ↔ package.json version check

It does not rebuild extended-docs; run Pages workflow or push doc changes separately if the public site must update.

Documentation sync checklist

For user-facing changes, before tagging:

  • All six extended-docs/docs/content/{en,fa,ar,ru,zh,fr}/ chapters
  • extended-docs/docs/glossary.md
  • Six root README*.md files (Features / env sections)
  • src/i18n/messages/*.ts (six locales)
  • ARCHITECTURE.md, SECURITY.md, CONTRIBUTING.md as needed

Semver guidance

Change Bump
Bug fix, docs-only PATCH
New features (wizard, API fields) MINOR
Breaking API or storage migration MAJOR

Current release: v1.2.1 — hardened Docker image (no runtime manifest/npm), Trivy OS gate, SonarCloud Quality Gate green, branch protection ruleset.