Skip to content

docs: move release guide to RELEASING.md - #174

Merged
marandaneto merged 1 commit into
mainfrom
docs/extract-releasing-guide
Apr 16, 2026
Merged

docs: move release guide to RELEASING.md#174
marandaneto merged 1 commit into
mainfrom
docs/extract-releasing-guide

Conversation

@marandaneto

Copy link
Copy Markdown
Member

Problem

The release instructions only live in README.md, which makes them harder to keep as a single source of truth across SDK repos.

Changes

  • added a dedicated RELEASING.md
  • moved the existing .NET release workflow instructions there
  • replaced the inline README release section with a pointer to RELEASING.md

Checklist

  • Tests for new code (if applicable)
  • Updated the docs
  • No breaking change

@marandaneto
marandaneto requested review from a team and haacked as code owners April 16, 2026 11:10
@marandaneto
marandaneto enabled auto-merge (squash) April 16, 2026 11:10
@greptile-apps

greptile-apps Bot commented Apr 16, 2026

Copy link
Copy Markdown
Contributor
Prompt To Fix All 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.

Reviews (1): Last reviewed commit: "docs: move release guide to RELEASING.md" | Re-trigger Greptile

Comment thread README.md
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).

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.

@github-actions

Copy link
Copy Markdown
Contributor

posthog-dotnet Compliance Report

Date: 2026-04-16 11:11:37 UTC
Duration: 233ms

⚠️ Some Tests Failed

0/1 tests passed, 1 failed


Feature_Flags Tests

⚠️ 0/1 tests passed, 1 failed

View Details
Test Status Duration
Request Payload.Request With Person Properties Device Id 44ms

Failures

request_payload.request_with_person_properties_device_id

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

@marandaneto
marandaneto merged commit 16910e2 into main Apr 16, 2026
15 checks passed
@marandaneto
marandaneto deleted the docs/extract-releasing-guide branch April 16, 2026 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants