TRT-635: Update release notes to include git commit messages.#36
TRT-635: Update release notes to include git commit messages.#36owenlittlejohns merged 5 commits intomainfrom
Conversation
|
(And now those changes are in this branch, it's all resolved) |
flamingbear
left a comment
There was a problem hiding this comment.
I like this idea, not sure it's complete for pre-commit PRs and maybe has the wrong font size?
| # Append git commit messages to the release notes: | ||
| if [[ ${GIT_COMMIT_MESSAGES} ]] | ||
| then | ||
| result+="\n\n## Commits\n\n${GIT_COMMIT_MESSAGES}" |
There was a problem hiding this comment.
These will have a larger font than the added/changed level. Is that what you want? ## instead of ###?
There was a problem hiding this comment.
It is what I wanted. It felt like this was distinct from the KeepAChangelog content, so I wanted it to be clear that it wasn't just a subsection of that. I don't have a strong opinion on if that's best, but it is intentional.
|
|
||
| # Retrieve the title line of all commit messages since $GIT_REF, filtering out | ||
| # those from the pre-commit-ci[bot] author. | ||
| GIT_COMMIT_MESSAGES=$(git log --oneline --format="%s" --perl-regexp --author='^(?!pre-commit-ci\[bot\]).*$' ${GIT_REF}..HEAD) |
There was a problem hiding this comment.
the pre-commit merges are included though. from hybig
## Commits
Merge pull request #49 from nasa/pre-commit-ci-update-config
There was a problem hiding this comment.
Hmmm. Tricky. Probably there's another regular expression filter for that specific branch (assuming that pre-commit-ci will always publish PRs to the same branch name, which I think is valid, given that it updates existing PRs if they are still open)
There was a problem hiding this comment.
That looks good. We can adjust later if it's not.
Description
This PR augments GitHub release notes with commits since the previous release. (Excluding pre-commit-ci[bot] commits)
Jira Issue ID
N/A
Local Test Steps
bin/extract-release-notes.sh. You should see an extra section with the single commit from this branch in the output.mainon the Swath Projector. This should not add any more content, because there are no commits since the most recent release.mainon the regression test repository. This should have a lot of commits, because there are no tags. So all commits are included. (This script is meant for repos that should be using tags - so we shouldn't hit this issue except for a new service)