Conversation
… (#84) ## Summary - Closes #82 — drop strict "Require branches to be up to date before merging" from the `develop` ruleset (already flipped on the live repo, id 15886282). With strict on, two bot PRs against `develop` landing within the same window left the second OPEN forever: the first merge flipped it to `mergeStateStatus: BEHIND`, GitHub's auto-merge will not fire while strict is on, and the merge-bot only enables auto-merge on `opened`/`reopened` (never auto-updates bot branches). Squash mechanics, linear history, textual-conflict detection, and the required `Check pull request workflow status` still gate merges. - Closes #83 — fix the GitHub Pre-Release shield with `&filter=*-g*` (NBGV pre-release tags carry a `-g<sha>` suffix, stable tags don't); drop the NuGet Pre-Release badge because shields.io's `vpre` endpoint accepts no filter parameter and silently returns the latest stable whenever one exists (the steady state after every release). - AGENTS.md "Branching Model" + README.md "Rules / Rulesets" updated in lockstep with the ruleset flip; both rulesets now omit the strict flag for related-but-distinct reasons (documented inline). ## Test plan - [ ] Visual: rendered README badge row shows three pre-release-aware badges (GitHub Release, GitHub Pre-Release, NuGet Release) plus Docker Latest/Develop and PyPI Release — `NuGet Pre-Release` is gone. - [ ] Shield URL spot-check against a downstream consumer with current pre-releases: `https://img.shields.io/github/v/release/ptr727/LanguageTags?include_prereleases&filter=*-g*` renders an NBGV pre-release tag (e.g. `1.2.40-g0f69a1b0a0`), not the latest stable. - [ ] `gh api repos/ptr727/ProjectTemplate/rulesets/15886282 | jq '.rules[] | select(.type=="required_status_checks")'` shows `strict_required_status_checks_policy: false` — already verified. - [ ] Next pair of overlapping Dependabot/codegen PRs against `develop` both auto-merge without one stalling in `BEHIND`.
There was a problem hiding this comment.
Pull request overview
This PR updates the template documentation to reflect a ruleset configuration change for develop (disabling “Require branches to be up to date before merging” to prevent bot auto-merge stalls) and fixes the README’s pre-release badge behavior to correctly show NBGV pre-release tags.
Changes:
- Update
develop/mainruleset documentation to state the “up to date” requirement is intentionally disabled on both branches, with distinct rationales. - Fix the GitHub Pre-Release badge to filter for NBGV
-g<sha>tags and remove the NuGet Pre-Release badge that can’t be filtered reliably.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Removes the NuGet pre-release badge, fixes GitHub pre-release badge filtering, and updates the “Rules / Rulesets” docs to match the intended ruleset behavior. |
| AGENTS.md | Updates the “Branching Model” section to document that both branch rulesets omit the strict “up to date” requirement, with branch-specific reasoning. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
developruleset (already applied on the live ruleset id 15886282). With strict on, two bot PRs againstdeveloplanding within the same window left the second OPEN forever: the first merge flipped it tomergeStateStatus: BEHIND, GitHub's auto-merge will not fire while strict is on, and the merge-bot only enables auto-merge onopened/reopened.&filter=*-g*(NBGV pre-release tags carry a-g<sha>suffix, stable tags don't); drop the NuGet Pre-Release badge because shields.io'svpreendpoint accepts no filter parameter and silently returns the latest stable whenever one exists.Test plan
NuGet Pre-Releaseis gone.https://img.shields.io/github/v/release/<owner>/<repo>?include_prereleases&filter=*-g*renders an NBGV pre-release tag, not the latest stable.gh api repos/ptr727/ProjectTemplate/rulesets/15886282 | jq '.rules[] | select(.type=="required_status_checks")'showsstrict_required_status_checks_policy: false(already verified).developboth auto-merge without one stalling inBEHIND.