Console release notes script#3465
Conversation
|
Greptile encountered an error while reviewing this PR. Please reach out to support@greptile.com for assistance. |
michaeljguarino
left a comment
There was a problem hiding this comment.
so we shouldn't just put these in the github release notes like you're seeing there, but also in a changelog (which is a common pattern in most repos)
…rate-deep-patch-notes-for-plural
| """Prepend release notes to the changelog file.""" | ||
| from datetime import date | ||
|
|
||
| header = f"# {tag} ({date.today().isoformat()})\n\n" |
There was a problem hiding this comment.
Look at how other repos define their changelogs, this isn't really in line. There's usually a CHANGELOG.md file that references seaprate files (named by the release semver) for each version.
There was a problem hiding this comment.
There was a problem hiding this comment.
I didn't push it up with that last commit. As a random repo example I think it looks in-line with a hashicorp changelog: https://github.com/hashicorp/consul/blob/main/CHANGELOG.md
For each PR, it checks the git diff in order to generate a more accurate summary of the PR. If an LLM is enabled, it's provided with Plural docs to get context when generating a description.
Test Plan
ran python3 .github/scripts/generate-release-notes.py v0.12.15 (or use tag of your choice) and compared the notes with what is in the current release notes.
optionally export OPENAI_API_KEY to get the LLM-generated description
Checklist
Plural Flow: console