Skip to content

RELEASING.md

Latest commit

 

History

History
43 lines (28 loc) · 1.27 KB

RELEASING.md

File metadata and controls

43 lines (28 loc) · 1.27 KB
Raw

Releasing simple-httpd

Version source of truth

The VERSION file is the product version source of truth. CMake reads it into project(... VERSION ...). Keep CHANGELOG.md, packaging metadata, and git tags aligned with that version for the release you publish.

Pre-release

  1. Update CHANGELOG.md (Unreleased → new section with date).
  2. Bump version in CMake / VERSION files if needed.
  3. Run the project/RELEASE_CHECKLIST.md.
  4. Prefer project/PROGRESS_REPORT.md over roadmap checkmarks when deciding readiness.

Build and test

cmake -S . -B build -DENABLE_TESTS=ON
cmake --build build
cd build && ctest --output-on-failure

Adjust CMake options to match this project's conventions (BUILD_VERSION, static builds, etc.).

Tag and publish

git tag -a v1.0.0 -m "Release v1.0.0"
git push origin v1.0.0
  1. Create a GitHub Release for the tag; paste the matching CHANGELOG.md section.
  2. Optional: attach CPack / make package artifacts with gh release upload.

Verify an existing tag (optional)

If this repo has scripts/verify-release-build.sh:

./scripts/verify-release-build.sh v1.0.0

Otherwise, check out the tag in a clean worktree and run the build/test commands above.