Skip to content

[T-124] Release workflow release.yml: on tag → images, GitHub Release with CHANGELOG section, SBOMs, demo report #221

Closed

Description

@CodewithJha

Task T-124 · Milestone M11 — Release 1.0 · Size S · Priority P0 · Epic #11

Implements NFR-DEP-001

Branch ci/t-124-release-workflow-on-tag-images — one task = one branch = one PR (doc 32 §6)

Summary

Implement doc 33 §2 step 4: annotated tag vX.Y.Z triggers image build/push (reusing images.yml via workflow_call), extracts the CHANGELOG section, attaches SBOMs and the demo report, creates the GitHub Release; plus a scripts/release_check.py validating version consistency (pyproject, package.json, package.xml).

Context / motivation

Repeatable, auditable releases.

Scope

In scope

  • Dry-run mode on workflow_dispatch.

Implementation guidance

  • .github/workflows/release.yml: trigger push: tags: ['v*.*.*'] + workflow_dispatch (dry-run input). Jobs: verify (scripts/release_check.py: tag equals versions in backend/pyproject.toml, web/package.json, ros_ws/src/roboprobe_ros/package.xml; CHANGELOG has ## [X.Y.Z] - YYYY-MM-DD), images (uses: ./.github/workflows/images.yml with tag inputs), release (extract the CHANGELOG section, download SBOMs, attach the demo report if present, gh release create --verify-tag; pre-release when the tag contains -).
  • Minimal permissions per job; no secrets beyond GITHUB_TOKEN (TM-11).
  • Unit tests for CHANGELOG extraction and version consistency (tests/unit/test_release_check.py).
  • Standards: respect the layering contracts (doc 16 §2) and conventions in doc 34; no hard-coded tunables — thresholds/defaults come from typed settings (doc 27); no magic numbers (ruff PLR2004); public APIs typed (mypy strict) and documented.

Acceptance criteria

  • Dry-run on a pre-release tag (e.g. v0.10.0-rc.1) succeeds.
  • Dry run on v0.10.0-rc.1 produces a pre-release with notes and assets.
  • A version mismatch fails verify.
  • Tests listed below added and green in CI; coverage of new code meets the gate in doc 18 §3.
  • Docs, config reference and CHANGELOG Unreleased updated where behaviour, keys or interfaces changed.
  • Definition of Done (doc 32 §3) satisfied.

Tests required

  • Workflow dry-run; unit test for CHANGELOG extraction.

Dependencies

Blocked by: #189 (T-119)

Blocks: #223 (T-122)

Parallelization notes

Files / paths owned by this task — avoid editing other paths; shared files (pyproject.toml entry points, cli/main.py, api/routers/__init__.py, router.tsx, docker/compose.yaml, ci.yml) are append-only:

  • .github/workflows/release.yml
  • scripts/release_check.py

Independent.

Definition of Done

Per doc 32 §3 and AGENTS.md §5: lint, format, mypy strict and import-linter green; tests added and passing; docs updated; PR template completed with Closes #<this issue>; Conventional Commit messages referencing T-124 (doc 16 §6); commits authored only by the repository owner identity (AGENTS.md §4); CI green; reviewer checklist (doc 32 §5.1) satisfied.

References

Design docs: doc 33 §2 · doc 33 §3 · doc 20 §6 · doc 31 §3

Requirements: NFR-DEP-001 (traceability: doc 28)

External:

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:ciCI/CD workflowsarea:deployDocker images, compose, release packagingmilestone:M11M11 — Release 1.0priority:P0Critical path / blocks otherssize:S<= 1 daytaskChild task of a milestone epictype:infraCI, build, deployment infrastructure

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions