Skip to content

docs: move release guide to RELEASING.md #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marandaneto merged 1 commit into from
Apr 16, 2026
Merged

docs: move release guide to RELEASING.md #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 1 addition & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

@greptile-apps greptile-apps Bot Apr 16, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Missing section header for release pointer

The original content sat under a ## Publishing Releases heading. Without it, this line reads as a stray paragraph inside the "Testing" section rather than its own navigable entry, which breaks the README's heading hierarchy and removes the TOC anchor.

Suggested change
For release instructions, see [RELEASING.md](RELEASING.md).
## Publishing Releases
For release instructions, see [RELEASING.md](RELEASING.md).
Prompt To Fix With AI 
This is a comment left during a code review.
Path: README.md
Line: 74

Comment:
**Missing section header for release pointer**

The original content sat under a `## Publishing Releases` heading. Without it, this line reads as a stray paragraph inside the "Testing" section rather than its own navigable entry, which breaks the README's heading hierarchy and removes the TOC anchor.

```suggestion
## Publishing Releases

For release instructions, see [RELEASING.md](RELEASING.md).
```

How can I resolve this? If you propose a fix, please make it concise.


## Installation

Expand Down
11 changes: 11 additions & 0 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Loading