Separate, link & style the changelog #735
Merged
Conversation
This file contains 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
I like the changelog in the README in some ways but it is getting quite
long and large parts of it are of historical interest only so it is a
bit of a burden for the main README.
We link all the PR references with the script below. I was going in
include it but I think it'll be easy enough to copy & paste from
previous lines in the future.
Made with:
import re
# Read the changelog
changelog = open('CHANGELOG.rst').read();
lines = changelog.split('\n')
output = []
# Replace all non-linked end-of-line PR references with a linked version
for line in lines:
output.append(
re.sub(
'(?P<prefix>[^`])#(?P<number>\d+)$',
'\g<prefix>`#\g<number> <https://github.com/michaeljones/breathe/pull/\g<number>>`__',
line, 0, re.M
)
)
# Write the changelog
open('CHANGELOG.rst', 'w').write("\n".join(output))s
Just for style.
They've been there for a while (I think I wrote them both a while ago) and they don't necessarily reflect the degree of professionalism that would be good to bring to the project given that it is used quite widely at this point.
Under 'download' as it seems to fit there.
Merged
jakobandersen
approved these changes
Sep 4, 2021
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.
And remove some statements about reminding us to get work done as they no longer reflect the tone I'm hoping to set up around the project.
I realise this is a bit of a random and opinionated change. Happy to not do it if people strong feelings but I think there is a argument that the CHANGELOG is quite long to be embedding in the README and a lot of it is of historical interest only so there are benefits to having it in its own separate file.
I'm also used to looking for a CHANGELOG.md/rst file when looking a github project so in some ways it is more discoverable like this.