-
Notifications
You must be signed in to change notification settings - Fork 2.2k
chore: convert changelog to markdown #5672
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
3.14t macOS. |
There was a problem hiding this 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 converts changelog sections from reStructuredText to Markdown and updates references accordingly.
- Renames the changelog entry regex and adjusts its pattern for Markdown.
- Updates output formatting to use Markdown syntax and switches file references from .rst to .md.
- Updates GitHub configuration files to recognize the new changelog file.
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tools/make_changelog.py | Renames regex and prints entries in Markdown, handles legacy RST entries separately. |
| docs/release.rst | Updates release documentation to reference the Markdown changelog. |
| .github/pull_request_template.md | Adjusts the pull request template to accommodate the new changelog format. |
| .github/labeler_merged.yml | Updates file globs to target the Markdown changelog. |
| .github/labeler.yml | Adjusts labeler configuration to ignore the Markdown changelog. |
Comments suppressed due to low confidence (1)
tools/make_changelog.py:34
- [nitpick] Consider renaming the variable 'old' to a more descriptive name such as 'old_rst_entries' to clarify its purpose.
old = []
Signed-off-by: Henry Schreiner <[email protected]>
Signed-off-by: Henry Schreiner <[email protected]>
7ff1af2 to
d647e16
Compare
Signed-off-by: Henry Schreiner <[email protected]>
Signed-off-by: Henry Schreiner <[email protected]>
b074ab8 to
1e1bd6d
Compare
|
I also would like to grep and fix |
Simpler changelog blocks in pull requests, and simpler in creating the GitHub releases.
Removed the mention of the upgrade guide as I think not one single person has ever added anything in that block.
📚 Documentation preview 📚: https://pybind11--5672.org.readthedocs.build/