CHORE: Update release-manager agent, write release notes to markdown file and use --notes-file#638
Open
gargsaumya wants to merge 2 commits into
Open
CHORE: Update release-manager agent, write release notes to markdown file and use --notes-file#638gargsaumya wants to merge 2 commits into
gargsaumya wants to merge 2 commits into
Conversation
…d use --notes-file
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the .github/agents/release-manager.agent.md guidance to make the release PR body more structured and to formalize how release notes are drafted and applied during gh release create.
Changes:
- Require the PR body to include an exact
### Summaryheading with changes grouped by Enhancements / Bug Fixes. - Change the release notes drafting step to write the draft into a repo-root Markdown file (
release-notes-X.X.X.md) for user review/editing. - Update the GitHub release creation command to use
gh release create ... --notes-file release-notes-X.X.X.md.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…fore gh release create
📊 Code Coverage Report
Diff CoverageDiff: main...HEAD, staged and unstaged changesNo lines with coverage information in this diff. 📋 Files Needing Attention📉 Files with overall lowest coverage (click to expand)mssql_python.pybind.logger_bridge.cpp: 59.2%
mssql_python.pybind.ddbc_bindings.h: 59.9%
mssql_python.pybind.logger_bridge.hpp: 70.8%
mssql_python.pybind.connection.connection.cpp: 76.2%
mssql_python.pybind.ddbc_bindings.cpp: 76.2%
mssql_python.row.py: 76.9%
mssql_python.__init__.py: 77.3%
mssql_python.ddbc_bindings.py: 79.6%
mssql_python.logging.py: 85.5%
mssql_python.connection.py: 85.6%🔗 Quick Links
|
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.
Work Item / Issue Reference
Summary
This pull request updates the release manager agent documentation to clarify and improve the PR and release notes process. The main changes require a more structured PR summary section, specify the use of a Markdown file for release notes drafts, and update the release creation command to use this file.
Improvements to PR and release notes process:
### Summarysection, with the heading exactly as### Summary, summarizing all changes grouped by Enhancements / Bug Fixes, in addition to the work item ID and version bump note.release-notes-X.X.X.mdin the repo root for user review and editing, rather than just presenting the draft for approval.--notes-file release-notes-X.X.X.mdoption to include the approved release notes from the Markdown file.