-
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
Merged
Merged
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
baf21a3
adds release notes action
JBAhire f49134a
modifies workflow
JBAhire 44aeae8
cleanup
JBAhire 0741901
runs without actions
JBAhire 6c6077c
Update pr-build.yml
JBAhire e76d710
uses gren action
JBAhire b867703
modifies grenrc file
JBAhire acaaa56
adds section in config file
JBAhire edc756b
cleanup
JBAhire 5854569
chnages action name for chnagelog pubish
JBAhire 141f9ed
adds token for changelog publish action
JBAhire b744f64
removes changelog publish job
JBAhire e2ca867
cleanup
JBAhire 8c84529
addresses Ronak's comments
JBAhire a07cb9b
adds ignoreLabels
JBAhire 32238da
adds some more labels in ignore issues
JBAhire File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -58,3 +58,16 @@ jobs: | |
helm-gcs-credentials: ${{ secrets.HELM_GCS_CREDENTIALS }} | ||
helm-gcs-repository: ${{ secrets.HELM_GCS_REPOSITORY }} | ||
|
||
publish-release-notes: | ||
needs: [ publish-artifacts, publish-helm-charts ] | ||
runs-on: ubuntu-20.04 | ||
steps: | ||
- uses: actions/[email protected] | ||
with: | ||
fetch-depth: 0 | ||
- uses: lakto/[email protected] | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
with: | ||
options: '-c .grenrc.js --override' | ||
|
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
module.exports = { | ||
"dataSource": "prs", | ||
"prefix": "", | ||
"onlyMilestones": false, | ||
"ignoreIssuesWith": ["no-release", "wontfix", "question"], | ||
"ignoreTagsWith": ["-rc", "-alpha", "-beta", "test", "current"], | ||
"ignoreLabels": ["closed", "automation", "enhancement", "bug", "fix", | ||
"internal", "feature", "feat", "docs", "chore", "refactor", "ci", | ||
"perf", "test", "tests", "style", "linux"], | ||
"groupBy": { | ||
"Enhancements": ["enhancement", "internal", "feature", "feat"], | ||
"Bug Fixes": ["bug", "fix"], | ||
"Documentation": ["docs", "question"], | ||
"Minor Fixes": ["chore", "refactor", "perf", "test", "style"], | ||
"Config": ["config", "helm"], | ||
"CI": ["ci"] | ||
}, | ||
"template": { | ||
commit: ({ message, url, author, name }) => `- [${message}](${url}) - ${author ? `@${author}` : name}`, | ||
issue: "- {{labels}} {{name}} [{{text}}]({{url}})", | ||
label: "[**{{label}}**]", | ||
noLabel: "closed", | ||
changelogTitle: "# Changelog\n\n", | ||
release: "## {{release}} ({{date}})\n{{body}}", | ||
releaseSeparator: "\n---\n\n", | ||
group: function (placeholders) { | ||
var icon = "🙈" | ||
if(placeholders.heading == 'Enhancements'){ | ||
icon = "🚀" | ||
} else if(placeholders.heading == 'Bug Fixes'){ | ||
icon = "🐛" | ||
} else if(placeholders.heading == 'Documentation'){ | ||
icon = "📚" | ||
} else if(placeholders.heading == 'Minor Fixes'){ | ||
icon = "❗" | ||
} else if(placeholders.heading == 'Config'){ | ||
icon = "⚙️" | ||
} else if(placeholders.heading == 'CI'){ | ||
icon = "⚡" | ||
} | ||
return '\n#### ' + icon + ' ' + placeholders.heading + '\n'; | ||
} | ||
} | ||
} |
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.
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? andignoreCommitsWith
also? As commit withchore
is included in group by asMinor
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.
Yes. We don't need
ignoreCommits
explicitly but we needignoreLabels
to format output of notes. else it will look like this: