Skip to content

chore: bring in updates from the template repo#11

Merged
Malcolmnixon merged 5 commits intomainfrom
copilot/update-template-repo
Mar 8, 2026
Merged

chore: bring in updates from the template repo#11
Malcolmnixon merged 5 commits intomainfrom
copilot/update-template-repo

Conversation

Copy link
Contributor

Copilot AI commented Mar 7, 2026

Pull Request

Description

Syncs NuGetCacheTool with four TemplateDotNetTool PRs merged 2026-03-04 through 2026-03-06.

Template PR #50 – Semantic requirement IDs and documentation fixes

  • Convert all numeric requirement IDs to semantic IDs in requirements.yaml:
    • NC-CLI-*NuGetCache-Cmd-* (e.g. NuGetCache-Cmd-Context, NuGetCache-Cmd-Version, etc.)
    • NC-SEC-001NuGetCache-Sec-PathTraversal
    • NC-PLT-*NuGetCache-PLT-* (e.g. NuGetCache-PLT-Windows, NuGetCache-PLT-Net8, etc.)
  • Fix AGENTS.md: "UTF-8+BOM" → "UTF-8"
  • Fix CONTRIBUTING.md: "UTF-8 with BOM" → "UTF-8" and correct Assert.HasCount parameter order

Template PR #52 – Staged pipelines, artifact consolidation, OTS requirements

  • Bump reqstream 1.3.0 → 1.4.0
  • Rename artifacts: artifacts-build-*, packages-*, artifacts-codeql, artifacts-validation-*
  • Move test results output dir to artifacts/
  • Add OTS self-validation steps (VersionMark in quality-checks/build; all 5 tools in build-docs)
  • Consolidate build-docs downloads with merge-multiple: true
  • Fix release.yaml to download packages-ubuntu-latest
  • Add OTS Software requirements section (MSTest, ReqStream, BuildMark, VersionMark, SarifMark, SonarMark)
  • Add structured section comments throughout workflow

Template PR #54 – macOS support, question issue template, Agent Selection Guide

  • Add macos-latest to build and integration-test matrices
  • Fix OS_SHORT sed pattern to 's/-latest//' (handles all three platforms)
  • Add NuGetCache-PLT-MacOS macOS platform requirement
  • Create .github/ISSUE_TEMPLATE/question.yml
  • Add Agent Selection Guide + macos@TestName filter to AGENTS.md
  • Update README.md: "Windows and Linux" → "Windows, Linux, and macOS"

Template PR #55 – CodeQL build-mode: manual

  • Add build-mode: manual to CodeQL Initialize step

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code quality improvement

Related Issues

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

  • Code builds successfully: dotnet build --configuration Release
  • All unit tests pass: dotnet test --configuration Release
  • Self-validation tests pass:
    dotnet run --project src/DemaConsulting.NuGet.CacheTool --configuration Release --framework net10.0
    --no-build -- --validate
  • Code produces zero warnings

Code Quality

  • Code formatting is correct: dotnet format --verify-no-changes
  • New code has appropriate XML documentation comments
  • Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

  • Spell checker passes: cspell "**/*.{md,cs}"
  • Markdown linter passes: markdownlint "**/*.md"
  • YAML linter passes: yamllint .

Testing

  • Added unit tests for new functionality
  • Updated existing tests if behavior changed
  • All tests follow the AAA (Arrange, Act, Assert) pattern
  • Test coverage is maintained or improved

Documentation

  • Updated README.md (if applicable)
  • Updated ARCHITECTURE.md (if applicable)
  • Added code examples for new features (if applicable)
  • Updated requirements.yaml (if applicable)

Additional Notes

No source code changes — all changes are in CI workflows, requirements, issue templates, and documentation.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Update local repository with changes from template repo chore: bring in updates from the template repo Mar 7, 2026
…on fixes

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 8, 2026 01:13
Copilot AI review requested due to automatic review settings March 8, 2026 01:13
@Malcolmnixon
Copy link
Contributor

@copilot For the requirement IDs - please use "PLT" instead of "Platform" to keep the IDs shorter.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 8, 2026

@copilot For the requirement IDs - please use "PLT" instead of "Platform" to keep the IDs shorter.

Done in df939b0 — all six platform IDs updated to NuGetCache-PLT-Windows, NuGetCache-PLT-Linux, NuGetCache-PLT-MacOS, NuGetCache-PLT-Net8, NuGetCache-PLT-Net9, and NuGetCache-PLT-Net10.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Syncs this repo with recent TemplateDotNetTool updates by standardizing requirement IDs/documentation and modernizing CI pipelines (artifact layout, staged workflows, OTS self-validation), including expanded macOS support.

Changes:

  • Updated requirements.yaml to use semantic requirement IDs, added macOS platform requirement, and introduced an “OTS Software” requirements section.
  • Refreshed CI workflows to use consolidated artifact naming/layout, expanded OS matrices to include macos-latest, added OTS self-validation steps, and set CodeQL build-mode: manual.
  • Documentation and community updates (README/platform text, contributing guidelines, agent guide, and a new question issue template) plus a reqstream tool bump.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
requirements.yaml Converts requirement IDs to semantic names; adds macOS + OTS requirements and related test evidence links.
README.md Updates stated platform support to include macOS.
CONTRIBUTING.md Updates encoding guidance and corrects MSTest Assert.HasCount parameter order in docs.
AGENTS.md Adds Agent Selection Guide; updates encoding text and platform matrix mentions (incl. macOS).
.github/workflows/release.yaml Updates release workflow to download renamed package artifact.
.github/workflows/build.yaml Major CI sync: artifact consolidation, macOS matrix, OTS validations, CodeQL manual build mode, and updated paths.
.github/ISSUE_TEMPLATE/question.yml Adds a GitHub Issue Form for “Question / Help”.
.config/dotnet-tools.json Bumps demaconsulting.reqstream tool version to 1.4.0.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Malcolmnixon Malcolmnixon merged commit 6fcae17 into main Mar 8, 2026
15 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.

3 participants