ReleaseProcess.md

Release Process

This document describes how to create and publish releases.

Table of Contents

• Workflow
  • 1. Create Draft Release
  • 2. Review and Edit
  • 3. Publish
• Version Numbers

Workflow

The process for creating and publishing a release consists of 3 manual steps (in orange):

flowchart LR

  subgraph subCreate ["1. Create"]
    Trigger[Run<br/>'Create Release'<br/>workflow]
    Draft[Draft release<br/>created<br/>in GitHub]
  end

  subgraph subReview ["2. Review"]
    Review[Review & edit<br/>draft release]
  end

  subgraph subPublish ["3. Publish"]
    Publish[Publish<br/>release]
    Done[Packages published to<br/>GitHub & NuGet.org]
  end

  Trigger --> Draft
  Draft --> Review
  Review --> Publish
  Publish --> Done

  classDef action fill:#E68A39,color:#000000
  class Trigger,Review,Publish action

  classDef result fill:#4A90E2,color:#FFFFFF
  class Draft,Done result

Loading

1. Create Draft Release

1. Go to Actions → Create Release
2. Click Run workflow
3. Ensure main is selected
4. Click Run workflow

A draft release will be created with an auto-generated changelog and versioned packages attached.

2. Review and Edit

1. Go to Releases
2. Open the draft release
3. Verify:
   • ✅ Version number is correct
   • ✅ Changelog is accurate
   • ✅ Packages are attached
4. Edit as needed (optional)

3. Publish

1. Click Publish release

Packages will be automatically published to GitHub Packages and NuGet.org.

Version Numbers

Version numbers follow Semantic Versioning and are calculated automatically by GitVersion.

To force a specific version bump, update next-version in GitVersion.yml.