Skip to content

Commit 16910e2

Browse files
authored
docs: move release guide to RELEASING.md (#174)
1 parent 0df9218 commit 16910e2

2 files changed

Lines changed: 12 additions & 11 deletions

File tree

README.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -71,17 +71,7 @@ The test projects target both `net8.0` and `netcoreapp3.1`. While .NET Core 3.1
7171

7272
This testing approach ensures broad compatibility without requiring users to install legacy runtimes in production.
7373

74-
## Publishing Releases
75-
76-
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.
77-
78-
### Release Process
79-
80-
1. Add the `release` label and exactly one of `bump-patch`, `bump-minor`, or `bump-major` to your PR
81-
2. Merge the PR to `main`
82-
3. Approve the release in the GitHub Environment gate (the workflow pauses for maintainer approval)
83-
4. The workflow bumps the version in `Directory.Build.props`, commits to `main`, creates a git tag, and creates a GitHub Release
84-
5. The GitHub Release triggers the [`main.yaml`](.github/workflows/main.yaml) workflow, which builds and publishes the packages to NuGet
74+
For release instructions, see [RELEASING.md](RELEASING.md).
8575

8676
## Installation
8777

RELEASING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Releasing
2+
3+
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.
4+
5+
## Release Process
6+
7+
1. Add the `release` label and exactly one of `bump-patch`, `bump-minor`, or `bump-major` to your PR
8+
2. Merge the PR to `main`
9+
3. Approve the release in the GitHub Environment gate (the workflow pauses for maintainer approval)
10+
4. The workflow bumps the version in `Directory.Build.props`, commits to `main`, creates a git tag, and creates a GitHub Release
11+
5. The GitHub Release triggers the [`main.yaml`](.github/workflows/main.yaml) workflow, which builds and publishes the packages to NuGet

0 commit comments

Comments
 (0)