docs(agents): correct release flow — manual tag, auto GH release - #84
Conversation
…to release Workflow runs on push: main for build + test only (publish job gated by is_release=true). Tag push runs publish path → packs, pushes to NuGet, and gh release create auto-creates the GH release. Distinguishes from ANcpLua.NET.Sdk's auto-bump-on-merge and from ANcpLua.Analyzers (no auto GH release). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation in AGENTS.md to detail the manual release flow, where tagging triggers the NuGet publishing process. A recommendation was made to push specific tags rather than using the global --tags flag to avoid accidentally triggering releases for unintended local tags.
| Manual-tag-triggers-publish. The workflow runs on `push: main` for build + test only (publish job gated by `is_release=true`); the tag push triggers the publish path. | ||
|
|
||
| 1. PR to `main` via squash merge — workflow runs build + test; publish job skipped (`is_release=false`) | ||
| 2. After merge: `git tag vX.Y.Z && git push --tags` — version comes from `${GITHUB_REF_NAME#v}`, `is_release=true` |
There was a problem hiding this comment.
Using git push --tags is generally considered a risky practice in shared repositories because it pushes all local tags to the remote. This can lead to accidentally triggering release workflows for experimental or unfinished tags. It is safer to recommend pushing only the specific tag intended for the release.
| 2. After merge: `git tag vX.Y.Z && git push --tags` — version comes from `${GITHUB_REF_NAME#v}`, `is_release=true` | |
| 2. After merge: `git tag vX.Y.Z && git push origin vX.Y.Z` — version comes from `${GITHUB_REF_NAME#v}`, `is_release=true` |
There was a problem hiding this comment.
Pull request overview
Updates AGENTS.md to describe the repository’s actual release workflow, emphasizing the “manual tag triggers publish” pattern and clarifying how this repo differs from related ANcpLua repos.
Changes:
- Replaces the prior 3-step release notes with a more detailed manual-tag release flow description.
- Documents that tagged releases trigger NuGet publish and that the workflow creates a GitHub Release automatically.
- Adds comparison notes vs. ANcpLua.NET.Sdk and ANcpLua.Analyzers release patterns.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Manual-tag-triggers-publish. The workflow runs on `push: main` for build + test only (publish job gated by `is_release=true`); the tag push triggers the publish path. | ||
|
|
||
| 1. PR to `main` via squash merge — workflow runs build + test; publish job skipped (`is_release=false`) |
| Manual-tag-triggers-publish. The workflow runs on `push: main` for build + test only (publish job gated by `is_release=true`); the tag push triggers the publish path. | ||
|
|
||
| 1. PR to `main` via squash merge — workflow runs build + test; publish job skipped (`is_release=false`) | ||
| 2. After merge: `git tag vX.Y.Z && git push --tags` — version comes from `${GITHUB_REF_NAME#v}`, `is_release=true` |
Summary
Test plan
🤖 Generated with Claude Code