Skip to content
Merged
Changes from all commits
Commits
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: 9 additions & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,12 @@ ANcpLua.Agents

### Release flow

1. Push to `main` via PR β€” CI runs, auto-merge bots handle dep bumps
2. Tag `vX.Y.Z` on `main` β€” publish workflow pushes to NuGet
3. NuGet indexes in ~4-8 minutes β€” downstream repos pick up via Renovate
Manual-tag-triggers-publish. The workflow ignores `push: main` for publishing β€” only `push: tags v*` (or `workflow_dispatch`) runs the publish job.

1. PR to `main` via squash merge β€” `ci.yml` runs build + test; `nuget-publish.yml` does **not** run
2. After merge: `git tag vX.Y.Z && git push --tags` β€” version comes from `${GITHUB_REF_NAME#v}`

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Using git push origin vX.Y.Z is generally safer than git push --tags, as the latter pushes all local tags which might include experimental or unrelated tags that shouldn't trigger a release.

Suggested change
2. After merge: `git tag vX.Y.Z && git push --tags` β€” version comes from `${GITHUB_REF_NAME#v}`
2. After merge: git tag vX.Y.Z && git push origin vX.Y.Z β€” version comes from ${GITHUB_REF_NAME#v}

3. Workflow restores, builds, packs, and pushes to NuGet via trusted publishing
4. **No GH release is auto-created** (workflow doesn't call `gh release create`); the tag itself is the marker β€” create the release manually if needed
5. NuGet indexes in ~4-8 minutes β€” downstream repos pick up via Renovate

Note: ANcpLua.NET.Sdk uses a different pattern (auto-bump-on-merge + auto-tag); Roslyn.Utilities and Agents use the same manual-tag pattern as this repo, but additionally auto-create the GH release.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

There is a significant naming discrepancy here. This file is named AGENTS.md and the PR title uses the agents scope, but the content (line 1, line 94, and the analyzer list) clearly describes the ANcpLua.Analyzers repository. Furthermore, this note refers to Agents as a separate repository. This is highly confusing for readers. It is recommended to rename this file to ANALYZERS.md (or README.md) and update the PR scope to analyzers.