Skip to content

Use BuildMark-generated build notes in GitHub releases#45

Merged
Malcolmnixon merged 5 commits intomainfrom
copilot/update-release-yaml-for-buildnotes
Feb 6, 2026
Merged

Use BuildMark-generated build notes in GitHub releases#45
Malcolmnixon merged 5 commits intomainfrom
copilot/update-release-yaml-for-buildnotes

Conversation

Copy link
Contributor

Copilot AI commented Feb 6, 2026

Pull Request

Description

Release workflow now uses BuildMark-generated buildnotes.md instead of GitHub's auto-generated release notes.

Modified .github/workflows/release.yaml:

  • Download documents artifact containing buildnotes.md
  • Move buildnotes.md from artifacts/ to root with error handling
  • Configure ncipollo/release-action with bodyFile: buildnotes.md
  • Set generateReleaseNotes: false

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

Addresses feature request to use BuildMark's own build notes for BuildMark releases.

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 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:

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

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

Workflow change only - no code changes required. The documents artifact is created by build-docs job in build.yaml and contains both PDFs and buildnotes.md. The upload-artifact action strips the common docs/ path prefix, so buildnotes.md is at the root of the artifact.

Original prompt

This section details on the original issue you should resolve

<issue_title>[Feature]: BuildMark Notes in Releases</issue_title>
<issue_description>### Problem Statement

The ncipollo/release-action step in release.yaml should use the buildnotes.md published in the documents artifact made by build-docs.

Proposed Solution

Modify the release.yaml to:

  • Download the documents artifact into the artifacts folder (with document PDFs and the buildnotes.md)
  • Move the buildnotes.md up one folder out of the artifacts
  • Modify the ncipollo/release-action to specify the bodyFile of the buildnotes.md file

Alternatives Considered

No response

Usage Examples

Benefits

BuildMark build notes used for BuildMark releases

Priority

High - Blocking my use case

Willingness to Contribute

Yes, I can submit a pull request

Additional Context

No response

Checklist

  • I have searched existing issues to ensure this is not a duplicate
  • I have provided a clear description of the feature
  • I have explained why this feature would be useful</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 3 commits February 6, 2026 16:17
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Update release.yaml to include buildnotes.md Use BuildMark-generated build notes in GitHub releases Feb 6, 2026
Copilot AI requested a review from Malcolmnixon February 6, 2026 16:21
…rectory

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
@Malcolmnixon Malcolmnixon marked this pull request as ready for review February 6, 2026 16:26
@Malcolmnixon Malcolmnixon merged commit 23a1e0f into main Feb 6, 2026
11 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/update-release-yaml-for-buildnotes branch February 6, 2026 16:29
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.

[Feature]: BuildMark Notes in Releases

2 participants