Formalize build_notes.md path and artifact handling#66
Merged
Malcolmnixon merged 2 commits intomainfrom Mar 26, 2026
Merged
Conversation
Agent-Logs-Url: https://github.com/demaconsulting/TemplateDotNetLibrary/sessions/a4e07755-5e60-4c11-ae4a-8199abfdbac9 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
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
Malcolmnixon
approved these changes
Mar 26, 2026
Contributor
There was a problem hiding this comment.
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
mvstep inrelease.yamland 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.mdatdocs/build_notes.md. - Update the documentation example reference to use
docs/build_notes.mdinstead ofbuild_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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request
Description
build_notes.mdwas being generated todocs/build_notes.mdbut the release workflowunnecessarily moved it before use, and agent documentation incorrectly placed it under
docs/build_notes/rather than at thedocs/root.release.yaml— Eliminate unnecessary file moveartifacts/build_notes.mddirectly asbodyFile(already present after artifact download)technical-writer.agent.md— Fix generated docs structurebuild_notes.mdto correct level in the structure diagram (docs/build_notes.md, notdocs/build_notes/build_notes.md)build_notes.mdtodocs/build_notes.mdType of Change
Related Issues
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
Build and Test
dotnet build --configuration Releasedotnet test --configuration ReleaseCode Quality
dotnet format --verify-no-changesQuality Checks
Please run the following checks before submitting:
./lint.sh(Unix/macOS) orcmd /c lint.bat/./lint.bat(Windows)Testing
Documentation
Additional Notes
No functional behavior change —
docs/build_notes.mdwas already the correct output path inbuild.yamlanddocs/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.