Update Changelog script to include changes in lib dependencies. #420
Conversation
| def getCommitsBetween( tagA, tagB = "HEAD", dir=None): | ||
| if dir: | ||
| original_dir = os.getcwd() | ||
| os.chdir(dir) |
There was a problem hiding this comment.
To be able to easily run this function in other directories I've added the dir parameter to temporarily change the current working directory.
microbit-carlos
force-pushed
the
changelog-libs
branch
from
ed81539 to
d0d6d02
Compare
microbit-carlos
force-pushed
the
changelog-libs
branch
from
d0d6d02 to
94b4a54
Compare
| if dir: | ||
| original_dir = os.getcwd() | ||
| os.chdir(dir) | ||
| commits = os.popen(f'git log --format="%s (by %an)" --no-merges --reverse {tagA}..{tagB}').read().strip().splitlines() |
There was a problem hiding this comment.
There was no way to change shortlog to not group commits, so I've replaced it with git log --no-merges. Reverse was needed because that's the order used by shortlog, which I guess makes sense with older commits first, as we read top to bottom.
The format includes the git author name at the end of the commit title, in case we wanted to still provide attribution.
%s -> commit title
%an -> commit author name
|
@JohnVidler if possible it'd be great to merge this before releasing the next tag, to be able to include this info in the changelog. |
It also changes the log format, as
git shortloggroups the commits by author (or other options, but they always have to grouped) and that can get a bit verbose when also including commits from the other libraries.Also, an advantage of not grouping by author is that the commits are listed historically.
As part of this PR I've also updated the changelog from v0.2.63, as this is the last tag used for MakeCode live, so it'll be useful to have this info when presenting MS the changelog for deployment.