-
Notifications
You must be signed in to change notification settings - Fork 7
Automates release note generation #61
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
RELEASE_NOTES.md
Outdated
@@ -0,0 +1,17 @@ | |||
# Changelog |
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.
Do we need to keep this file in repo?
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.
removed.
.github/workflows/publish.yml
Outdated
with: | ||
options: '-c .grenrc.js --override' | ||
|
||
publish-changelog: |
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.
Do we need this step? If, yes, does someone has to create PR at the end?
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.
This was to generate RELEASE_NOTES.md
file. We don't explicitly need it and our branched are protected so won't probably overwrite this.
Removed this job.
"ignoreCommitsWith": ["chore", "refactor", "style"], | ||
"ignoreIssuesWith": ["no-release"], | ||
"ignoreTagsWith": ["-rc", "-alpha", "-beta", "test", "current"], | ||
"ignoreLabels": ["closed", "automation", "enhancement", "bug", "fix", |
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.
Looks like most of the labels mentioned in groupBy are ignored?
What does ignoreLabels
mean? and ignoreCommitsWith
also? As commit with chore
is included in group by as Minor
fixes.
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.
.grenrc.js
Outdated
"Config": ["config", "helm"], | ||
"CI": ["ci"] | ||
}, | ||
"changelogFilename": "CHANGELOG.md", |
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.
This will not be used, right?
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.
@JBAhire
We need to roll out this change for at least to all the repos whose charts are included here - https://github.com/hypertrace/hypertrace/blob/main/kubernetes/*/Chart.yaml
Can you create checkboxes in the release notes ticket?
Do you think, we should update our PULL request template to indicate a checkbox for adding labels to PR?
Description
.grenrc.js
which formats the output of GREN bot according to our requirements.Testing
These are updated release notes for latest release in this repo generated by Gren bot
Checklist:
Documentation
This utility uses labels for grouping PRs into categories so please use appropriate labels in upcoming PRs.
In order to have splendidly generated release notes, we recommend to follow these conventions: