Skip to content

Promote develop to main: template docs and workflow reconverge#758

Merged
ptr727 merged 2 commits into
mainfrom
develop
Jun 22, 2026
Merged

Promote develop to main: template docs and workflow reconverge#758
ptr727 merged 2 commits into
mainfrom
develop

Conversation

@ptr727

@ptr727 ptr727 commented Jun 22, 2026

Copy link
Copy Markdown
Owner

Maintenance promotion of the ProjectTemplate reconverge from develop to main.

Contents

Versioning

Maintenance promotion: version.json stays at 3.18 (no functional change). NBGV advances main's git height, so the next publish ships a fresh stable 3.18.x (x > 13) and moves latest accordingly.

No code (PlexCleaner/) changes.

🤖 Generated with Claude Code

ptr727 and others added 2 commits June 22, 2026 12:52
* Re-sync governance docs and code style from template

Re-sync the verbatim-carry artifacts and governance from the current
ptr727/ProjectTemplate main, adapted for PlexCleaner:

- AGENTS.md: re-synced to the template structure - new Release Model with
  the current versioning policy (bump version.json only for functional
  changes; no post-release bump, no develop-ahead requirement), Documentation
  Style Conventions (incl. the Comments house-rule), PR Review Etiquette /
  Expected Review Loop carried verbatim, Workflow YAML Conventions, and a
  Project Structure that points to ARCHITECTURE.md.
- .github/copilot-instructions.md: trimmed to the narrow template shape
  (commit/PR-title summary + Copilot review runbook); project-specific
  content relocated.
- ARCHITECTURE.md: new - holds PlexCleaner's architecture, processing
  pipeline, and design patterns (relocated from copilot-instructions.md),
  referenced from AGENTS.md and copilot-instructions.md.
- CODESTYLE.md: re-synced (General + .NET sections), adapted to this repo.
- .editorconfig: add the .NET-only boundary marker and suppressions note.
- .markdownlint-cli2.jsonc: align the MD060 comment to the template.

Closes #731. Addresses #745 (docs portions; workflow conventions follow).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* Address Copilot review: doc accuracy and clean-compile ordering

- .vscode/tasks.json: add dependsOrder: sequence to .Net Format so the
  clean-compile actually chains CSharpier Format -> .Net Build -> verify
  (matches the template and the documented behavior).
- CODESTYLE.md: reference GlobalUsing.cs (this repo's actual file name).
- ARCHITECTURE.md: drop var from the builder example (CODESTYLE bans it),
  rename the colliding identifier, and use dotnet csharpier format.
- AGENTS.md: correct the merge-bot description to this repo's behavior
  (gates on PR author so maintainer repair commits still auto-merge;
  default cancel-in-progress, so only publish-release is a concurrency
  exception).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* Correct nbgv action-pinning note in AGENTS.md

This repo SHA-pins dotnet/nbgv like every other action; drop the template's
@master no-pin exception, which does not apply here.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* Align ARCHITECTURE.md build/format commands with the canonical tasks

Use the actual VS Code task label .Net Build, and the canonical CSharpier
Format invocation (dotnet csharpier format --log-level=debug).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…-readme) (#757)

- build-executable-task.yml: upload the standalone build as
  release-asset-<branch>-executable and drop the artifact-id output, so the
  GitHub release collects assets by the release-asset-<branch>-* pattern
  instead of naming the build job (#727).
- build-release-task.yml: the github-release job now downloads
  release-asset-<branch>-* with merge-multiple, never referencing a build job.
- Set retention-days: 1 on the intermediate upload-artifact steps
  (build-executable-task per-runtime + final, build-toolversions) so they
  do not pile up against the artifact-storage quota (#745).
- Rename build-dockerreadme-task.yml to publish-docker-readme-task.yml and
  align the task/job names (entry-point/orchestrator naming); keep the m4
  tool-version render and the working DOCKER_HUB_USERNAME/PASSWORD auth.
- Update the AGENTS.md and ARCHITECTURE.md references to the renamed task.

Closes #727. Closes #745.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 22, 2026 21:19

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

Maintenance promotion that reconverges governance/docs and GitHub Actions workflow conventions from develop into main, without changing PlexCleaner application code. This aligns the repo with the current ProjectTemplate expectations (docs split, clearer ownership of conventions, and release workflow artifact handling/retention).

Changes:

  • Re-synced/reshaped repo governance and style docs (new ARCHITECTURE.md, refreshed AGENTS.md/CODESTYLE.md, trimmed .github/copilot-instructions.md).
  • Updated release workflow conventions: standardized release-asset-<branch>-* artifact collection, renamed docker readme task, and set intermediate artifact retention-days: 1.
  • Minor tooling/config alignment updates (.editorconfig, .markdownlint-cli2.jsonc, .vscode/tasks.json sequencing for .Net Format).

Reviewed changes

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

Show a summary per file
File Description
CODESTYLE.md Re-synced style guide structure (General + .NET), clarifies clean-compile task expectations and suppression guidance.
ARCHITECTURE.md New architecture/design doc relocated out of Copilot instructions; provides contributor/agent reference.
AGENTS.md Updated cross-cutting governance (branching/release model/review loop contract) and template-sync guidance.
.vscode/tasks.json Ensures .Net Format runs dependencies in sequence.
.markdownlint-cli2.jsonc Clarifies MD060 policy comment; no behavioral change to rules.
.editorconfig Adds explicit “.NET-only below” boundary marker and suppression guidance note.
.github/workflows/publish-release.yml Switches docker readme to renamed reusable workflow and updates job naming.
.github/workflows/publish-docker-readme-task.yml Renames task/job display names to “Publish Docker Hub readme”.
.github/workflows/build-toolversions-task.yml Adds retention-days: 1 and updates comment reference to the renamed readme task.
.github/workflows/build-executable-task.yml Uploads release asset as release-asset-<branch>-executable and adds retention-days: 1; removes unused artifact-id outputs.
.github/workflows/build-release-task.yml Collects release assets via pattern: release-asset-<branch>-* + merge-multiple to decouple release from specific build job names.
.github/copilot-instructions.md Trimmed to narrow Copilot-specific guidance + review runbook, with pointers to AGENTS.md/CODESTYLE.md/ARCHITECTURE.md.

@ptr727 ptr727 merged commit 0599b18 into main Jun 22, 2026
44 checks passed
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