Skip to content

Formalize build_notes.md path and artifact handling#66

Merged
Malcolmnixon merged 2 commits intomainfrom
copilot/formalize-build-notes-handling
Mar 26, 2026
Merged

Formalize build_notes.md path and artifact handling#66
Malcolmnixon merged 2 commits intomainfrom
copilot/formalize-build-notes-handling

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 26, 2026

Pull Request

Description

build_notes.md was being generated to docs/build_notes.md but the release workflow
unnecessarily moved it before use, and agent documentation incorrectly placed it under
docs/build_notes/ rather than at the docs/ root.

release.yaml — Eliminate unnecessary file move

  • Remove the "Move build_notes.md to root" step
  • Use artifacts/build_notes.md directly as bodyFile (already present after artifact download)

technical-writer.agent.md — Fix generated docs structure

  • Move build_notes.md to correct level in the structure diagram (docs/build_notes.md, not docs/build_notes/build_notes.md)
  • Update example reference from bare build_notes.md to docs/build_notes.md

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
  • 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 in build.yaml and docs/build_notes/definition.yaml. This PR removes the workaround in the release job and corrects the agent documentation to reflect reality.


💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

Copilot AI changed the title [WIP] Formalize handling of build_notes.md in documentation Formalize build_notes.md path and artifact handling Mar 26, 2026
Copilot AI requested a review from Malcolmnixon March 26, 2026 20:54
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 26, 2026 20:54
Copilot AI review requested due to automatic review settings March 26, 2026 20:54
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

This PR standardizes how build_notes.md is handled across CI/CD by aligning the release workflow and agent documentation with the actual build output location.

Changes:

  • Remove the unnecessary mv step in release.yaml and point the release body directly at the downloaded artifact (artifacts/build_notes.md).
  • Correct the Technical Writer agent’s generated-docs structure diagram to place build_notes.md at docs/build_notes.md.
  • Update the documentation example reference to use docs/build_notes.md instead of 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 Uses artifacts/build_notes.md directly as the GitHub Release body file, removing the extra move step.
.github/agents/technical-writer.agent.md Fixes the generated docs structure diagram and references to match the real output path (docs/build_notes.md).

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

@Malcolmnixon Malcolmnixon merged commit 6738494 into main Mar 26, 2026
10 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/formalize-build-notes-handling branch March 26, 2026 21:02
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