Skip to content

Formalize build_notes.md path and artifact handling#75

Merged
Malcolmnixon merged 2 commits intomainfrom
copilot/merge-sister-project-pull-66
Mar 26, 2026
Merged

Formalize build_notes.md path and artifact handling#75
Malcolmnixon merged 2 commits intomainfrom
copilot/merge-sister-project-pull-66

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 26, 2026

Pull Request

Description

Ports TemplateDotNetLibrary#66 to this repository.

build_notes.md is generated at artifacts/build_notes.md after artifact download. The release workflow was unnecessarily moving it before use, and the agent documentation incorrectly placed it under docs/build_notes/ rather than docs/.

  • release.yaml: Remove "Move build_notes.md to root" step; use artifacts/build_notes.md directly as bodyFile
  • technical-writer.agent.md: Fix structure diagram — build_notes.md at docs/ level (not docs/build_notes/build_notes.md); update example reference to docs/build_notes.md

Type of Change

  • 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.TemplateDotNetTool --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:

  • All linters pass: ./lint.sh (Unix/macOS) or cmd /c lint.bat / ./lint.bat (Windows)

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 functional behavior change — docs/build_notes.md was already the correct output path. This removes the workaround in the release job and corrects the agent documentation to match reality.


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

…teDotNetLibrary PR #66)

Agent-Logs-Url: https://github.com/demaconsulting/TemplateDotNetTool/sessions/f857d5ca-35b8-4bbb-b5ee-fe26dbb234b4

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Merge pull request #66 from sister project Formalize build_notes.md path and artifact handling Mar 26, 2026
Copilot AI requested a review from Malcolmnixon March 26, 2026 21:06
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 26, 2026 21:07
Copilot AI review requested due to automatic review settings March 26, 2026 21:07
Copy link
Copy Markdown
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

Aligns the release workflow and agent documentation with the actual build_notes.md generation/output location, removing an unnecessary workaround step.

Changes:

  • Update release workflow to use artifacts/build_notes.md directly as the GitHub Release body file.
  • Correct the technical writer agent’s documentation tree and example link to reference docs/build_notes.md (not docs/build_notes/build_notes.md).

Reviewed changes

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

File Description
.github/workflows/release.yaml Removes the move-to-root workaround and points bodyFile at the downloaded artifact path.
.github/agents/technical-writer.agent.md Fixes the documented docs tree and example reference for build_notes.md.

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

@Malcolmnixon Malcolmnixon merged commit 250414f into main Mar 26, 2026
19 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/merge-sister-project-pull-66 branch March 26, 2026 21:26
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