Skip to content

Resync verbatim-carry files with upstream ProjectTemplate - #443

Merged
ptr727 merged 3 commits into
developfrom
resync-projecttemplate
Jun 24, 2026
Merged

Resync verbatim-carry files with upstream ProjectTemplate#443
ptr727 merged 3 commits into
developfrom
resync-projecttemplate

Conversation

@ptr727

@ptr727 ptr727 commented Jun 23, 2026

Copy link
Copy Markdown
Owner

Periodic re-sync of the template-carried artifacts against ptr727/ProjectTemplate (tip 8a701a9), plus the staged workspace dictionary/extension change.

What changed

  • .github/copilot-instructions.md — adopt the template's current lean Copilot runbook: Merge Gate awareness, "a review with no inline comments is still a completed review", and round-1 auto-seed polling. This also fixes the file's LF line-ending drift (.editorconfig mandates CRLF for .md) and the regression from Realign copilot-instructions.md with ProjectTemplate lean form #439, which had realigned to an older/leaner form than the template now ships. Owner/repo placeholders filled; the per-language pointer drops Python (this repo is .NET-only).
  • AGENTS.md — carry the upgraded PR Review Etiquette contract verbatim (new Merge Gate subsection, "no-findings is a valid terminal outcome"). Added the Pull Request Title and Commit Message Conventions section that the lean runbook now links to. The Release Model anchor/PUBLISH_ON_MERGE reference were adapted to this repo's CI Pipeline section. Fixed a .Net Format.NET Format task reference.
  • CODESTYLE.md — restructure to the template's General + .NET shape; drop the Python section; adapt the project list to CreateMatrix/CreateMatrixTests and InternalsVisibleTo accordingly. Husky.Net is retained as this repo's style gate (maintainer decision) — the template dropped it only because hooks don't fit non-.NET repos.
  • .editorconfig, .markdownlint-cli2.jsonc — pull current comments verbatim.
  • .vscode/tasks.json — rename .Net.NET, add dependsOrder: sequence to .NET Format, keep the project-specific Husky.Net Run task; updated .vscode/launch.json and .husky/task-runner.json label references.
  • NxWitness.code-workspace — the staged change (hddpool dictionary word; swap gruntfuggly.todo-tree for fanaticpythoner.better-todo-tree).

Notes

  • Versioning is unchanged; this is a maintenance re-sync.
  • Two upstream issues will be filed in ptr727/ProjectTemplate: (1) commit-gate confusion — Husky's absence is a non-.NET-fit concern, not a recommendation against gates; (2) verbatim-carry coherence gaps where carried files reference template-only sections/anchors (#release-model, the commit-conventions section, #files-and-sections-derived-repos-must-carry-verbatim).
  • Markdownlint clean on all three docs.

Periodic re-sync of the template-carried artifacts against ptr727/ProjectTemplate:

- copilot-instructions.md: adopt the current lean runbook (Merge Gate
  awareness, "no inline comments is still a completed review", round-1
  auto-seed polling); fixes the LF drift and the #439 regression to an
  older form. Owner/repo placeholders filled, Python pointer dropped.
- AGENTS.md: carry the upgraded PR Review Etiquette contract (Merge Gate
  subsection); add the Pull Request Title and Commit Message Conventions
  section the runbook links to.
- CODESTYLE.md: restructure to the General + .NET shape, drop the Python
  section, adapt project list to CreateMatrix/CreateMatrixTests, keep
  Husky.Net as this repo's style gate.
- .editorconfig, .markdownlint-cli2.jsonc: pull current comments verbatim.
- .vscode/tasks.json: rename .Net -> .NET, add dependsOrder sequence to
  .NET Format; update launch.json and .husky/task-runner.json references.

Also stages the workspace dictionary/extension change (hddpool;
better-todo-tree). Husky retained by maintainer decision.
Copilot AI review requested due to automatic review settings June 23, 2026 23:31

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Periodic re-sync of template-carried repository governance/configuration artifacts (docs + editor/tooling config) to align NxWitness with the current upstream ptr727/ProjectTemplate lean runbook conventions, plus a staged VS Code workspace spelling/extension recommendation update.

Changes:

  • Refresh agent/Copilot guidance docs to the upstream “lean” runbook/contract (including Merge Gate + “no-findings is a valid terminal outcome” guidance).
  • Restructure CODESTYLE.md into “General + .NET” and normalize .NET task naming across tasks/launch/Husky.
  • Update editor/workspace configs (CSpell word + swap todo-tree extension recommendation) and refresh .editorconfig / markdownlint comments.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

Show a summary per file
File Description
NxWitness.code-workspace Adds hddpool to workspace dictionary and switches recommended TODO-tree extension.
CODESTYLE.md Reorganizes code-style guidance into General + .NET sections and updates task/tooling descriptions to match repo structure.
AGENTS.md Adds commit/PR title conventions and updates PR review contract with an explicit Merge Gate and “no-findings” terminal outcome.
.vscode/tasks.json Renames .Net task labels to .NET, adds dependsOrder: sequence for .NET Format, and updates outdated-upgrade arg casing.
.vscode/launch.json Updates preLaunchTask references to the renamed .NET Build task.
.markdownlint-cli2.jsonc Refreshes comment text to reflect MD060 policy (rule remains disabled).
.husky/task-runner.json Renames Husky task from .Net Format to .NET Format for consistency with docs/tasks.
.github/copilot-instructions.md Adopts the updated lean Copilot runbook, emphasizing Merge Gate awareness and correct polling/re-request behavior.
.editorconfig Refreshes comments and clarifies JSON/JSONC section; documents suppression guidance near analyzer settings.

Second re-sync pass against ptr727/ProjectTemplate, which addressed the
issues filed from the first pass (#199) and added a storage cleanup guard
(#196):

- publish-release.yml, test-pull-request.yml: add a terminal
  cleanup-artifacts job that deletes the run's workflow artifacts via the
  REST API once consumed (best-effort, if: always(), independent of the
  required status check). Workflow artifacts are an intra-run handoff;
  durable copies live on the GitHub release and Docker Hub. needs/if
  adapted to this repo's job graph (publisher always publishes on
  schedule/dispatch, so no publish-gate beyond always()).
- AGENTS.md: adopt the template's portable 'Merging is not releasing'
  wording (drops the repo-specific release-section anchor); add the
  'Git and Commit Rules' section now mandated in the verbatim-carry list
  (the runbook's commit-conventions deferral relies on it).
- CODESTYLE.md: add the clean-compile bullet stating a local commit gate
  is the repo's choice (Husky.Net is fine for .NET); align the carry-list
  link text with the template.

Workflow yml line endings left as-is (these files are LF); the repo's
mixed yml LF/CRLF drift is a separate normalization pass.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.

Comment thread .github/workflows/test-pull-request.yml
Comment thread .github/workflows/publish-release.yml
ptr727 added a commit to ptr727/ProjectTemplate that referenced this pull request Jun 24, 2026
…#201)

The cleanup-artifacts step is best-effort, but set -euo pipefail + the per-command guards only cover expected list/delete failures; an unexpected failure (e.g. gh itself) would still red the run. Add continue-on-error: true to the delete step in publish-release.yml and test-pull-request.yml, and note it in the AGENTS.md recipe. Surfaced by Copilot on the NxWitness re-sync (ptr727/NxWitness#443).
Follows the template's fix (ptr727/ProjectTemplate#201) for the
cleanup-artifacts best-effort intent that Copilot flagged on #443:
add continue-on-error: true to the Delete workflow artifacts step in
both publish-release.yml and test-pull-request.yml, and drop the now
redundant inner run-block comment so the step matches the template.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated no new comments.

@ptr727
ptr727 merged commit 17e9a59 into develop Jun 24, 2026
9 checks passed
ptr727 added a commit that referenced this pull request Jun 24, 2026
Maintenance promotion of `develop` to `main`. `version.json` is
unchanged (2.13 on both branches), so NBGV advances only `main`'s height
— no minor bump.

## Why a promotion branch (not a direct develop->main PR)

`develop` and `main` have diverged in commit history (parallel
Dependabot/codegen PRs target both branches, and the merge-base is old),
so a direct develop->main merge conflicts on the template-carried files
(e.g. `main` still has a standalone `## Versioning` block in
`copilot-instructions.md` that the lean resync intentionally drops).
`develop` is forward-only and squash-only, so it can't take a back-merge
to resolve. This branch merges `main` into a branch off `develop` and
resolves every conflict to **develop's content**, so the result tree is
**byte-identical to `develop`** while preserving main as a merge parent.
(`git diff develop` on this branch is empty.)

## What's promoted (content diff vs main = the resync files only)

- **ProjectTemplate re-sync** (#443): `.github/copilot-instructions.md`
(lean Copilot runbook + LF->CRLF fix), `AGENTS.md` (Merge Gate,
Git/commit-conventions sections), `CODESTYLE.md` (General + .NET
restructure, Husky retained), `.editorconfig`,
`.markdownlint-cli2.jsonc`, `.vscode/tasks.json` (+ launch.json,
`.husky/task-runner.json` `.Net`->`.NET`), workspace
dictionary/extension change.
- **CI storage cleanup guard** (template #196/#201): terminal
`cleanup-artifacts` job in `publish-release.yml` and
`test-pull-request.yml` deleting run artifacts via REST API once
consumed; `continue-on-error: true` so housekeeping never reds the run.

## Notes

- Merge method is **merge-commit** (preserves develop's commit list as a
second parent), per branch protection.
- Merging does **not** publish — publishing is the weekly schedule /
manual dispatch only.
- All earlier code/Docker/Make changes already match between the
branches; this promotion carries no functional code change.
@ptr727
ptr727 deleted the resync-projecttemplate branch June 24, 2026 01:49
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