From 6f918d4c0f14a4733456514931d3c8d88372c8f3 Mon Sep 17 00:00:00 2001 From: Manoel Aranda Neto Date: Thu, 16 Apr 2026 12:09:31 +0100 Subject: [PATCH] docs: move release guide to RELEASING.md --- README.md | 12 +----------- RELEASING.md | 11 +++++++++++ 2 files changed, 12 insertions(+), 11 deletions(-) create mode 100644 RELEASING.md diff --git a/README.md b/README.md index 5c3353d2..84815c84 100644 --- a/README.md +++ b/README.md @@ -71,17 +71,7 @@ The test projects target both `net8.0` and `netcoreapp3.1`. While .NET Core 3.1 This testing approach ensures broad compatibility without requiring users to install legacy runtimes in production. -## Publishing Releases - -Releases are driven by PR labels. When a PR with the right labels is merged to `main`, a GitHub Actions workflow handles version bumping, tagging, creating a GitHub Release (with auto-generated notes), and publishing to NuGet. - -### Release Process - -1. Add the `release` label and exactly one of `bump-patch`, `bump-minor`, or `bump-major` to your PR -2. Merge the PR to `main` -3. Approve the release in the GitHub Environment gate (the workflow pauses for maintainer approval) -4. The workflow bumps the version in `Directory.Build.props`, commits to `main`, creates a git tag, and creates a GitHub Release -5. The GitHub Release triggers the [`main.yaml`](.github/workflows/main.yaml) workflow, which builds and publishes the packages to NuGet +For release instructions, see [RELEASING.md](RELEASING.md). ## Installation diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 00000000..0ffc836c --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,11 @@ +# Releasing + +Releases are driven by PR labels. When a PR with the right labels is merged to `main`, a GitHub Actions workflow handles version bumping, tagging, creating a GitHub Release (with auto-generated notes), and publishing to NuGet. + +## Release Process + +1. Add the `release` label and exactly one of `bump-patch`, `bump-minor`, or `bump-major` to your PR +2. Merge the PR to `main` +3. Approve the release in the GitHub Environment gate (the workflow pauses for maintainer approval) +4. The workflow bumps the version in `Directory.Build.props`, commits to `main`, creates a git tag, and creates a GitHub Release +5. The GitHub Release triggers the [`main.yaml`](.github/workflows/main.yaml) workflow, which builds and publishes the packages to NuGet