Create Release

Create Release — Revela Project

Prepare and create a new release for Revela. Follow all steps in order. Do NOT commit or push automatically — present changes and let the user decide.

Prerequisites

Before starting, verify:

• All tests pass (dotnet test)
• No uncommitted changes (git status)
• [Unreleased] section in CHANGELOG.md has content

Step 1: Determine Version

Ask the user for the version number if not provided. Follow Semantic Versioning:

• Pre-release: 0.0.1-beta.15, 0.0.1-rc.1
• Stable: 1.0.0, 1.0.1, 1.1.0

Check the latest version in CHANGELOG.md. The new version must be higher than the previous one.

Step 2: Update CHANGELOG.md

The changelog follows Keep a Changelog format.

1. Replace ## [Unreleased] content with the new version and today's date:

   ## [Unreleased]
   
   ## [X.Y.Z-suffix] - YYYY-MM-DD
   

2. Add comparison link at the bottom of the file:

   [Unreleased]: https://github.com/spectara/revela/compare/vX.Y.Z-suffix...HEAD
   [X.Y.Z-suffix]: https://github.com/spectara/revela/compare/vPREVIOUS...vX.Y.Z-suffix
   

   Update the existing [Unreleased] link to point to the new tag.

3. Verify the [Unreleased] section is now empty (ready for next development cycle).

Step 3: Present Changes

Show the user what was changed and suggest next steps:

git add CHANGELOG.md
git commit -m "Release vX.Y.Z-suffix"
git tag vX.Y.Z-suffix
git push origin main --tags

Do NOT execute these commands automatically. Let the user review and decide.

Note: Directory.Build.props does NOT need updating — the release workflow passes the version from the git tag via -p:Version= and -p:PackageVersion= build parameters.

Workflow Reference

The release pipeline (.github/workflows/release.yml) handles everything after the tag push:

1. Validate — Version format and ordering
2. Packages — Build and pack NuGet packages (CLI tool + plugins + themes + SDK)
3. Build — Native executables for 5 platforms (win-x64, linux-x64, linux-arm64, osx-x64, osx-arm64)
4. Sign — Keyless cosign signatures + SHA256SUMS
5. Release — Create GitHub Release with all artifacts
6. Publish NuGet — Push to NuGet.org (requires nuget-org environment approval)

Additional workflows triggered after release:

• deploy-website.yml — Deploy revela.website

Checklist

Before presenting to the user, verify:

• CHANGELOG.md: [Unreleased] section is empty
• CHANGELOG.md: New version section has correct date (today)
• CHANGELOG.md: Comparison links at bottom are correct
• Version is higher than the previous release

Converted and distributed by TomeVault — claim your Tome and manage your conversions.