Skip to content

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 16 commits into from
Jan 21, 2021
Merged

Automates release note generation #61

merged 16 commits into from
Jan 21, 2021

Conversation

JBAhire
Copy link
Member

@JBAhire JBAhire commented Jan 21, 2021

Description

Testing

These are updated release notes for latest release in this repo generated by Gren bot

Screenshot 2021-01-21 at 12 04 39 PM

Checklist:

  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Any dependent changes have been merged and published in downstream modules

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:

  • Start the subject line with a verb (e.g. Change header styles)
  • Use the imperative mood in the subject line (e.g. Fix, not Fixed or Fixes header styles)
  • Limit the subject line to about 50 characters
  • Do not end the subject line with a period
  • Separate subject from body with a blank line
  • Wrap the body at 72 characters
  • Use the body to explain what and why not how

@JBAhire JBAhire changed the title Release notes action Automates release note generation Jan 21, 2021
RELEASE_NOTES.md Outdated
@@ -0,0 +1,17 @@
# Changelog
Copy link
Contributor

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?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed.

with:
options: '-c .grenrc.js --override'

publish-changelog:
Copy link
Contributor

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?

Copy link
Member Author

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",
Copy link
Contributor

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.

Copy link
Member Author

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 need ignoreLabels to format output of notes. else it will look like this:

Screenshot 2021-01-21 at 4 05 39 PM

.grenrc.js Outdated
"Config": ["config", "helm"],
"CI": ["ci"]
},
"changelogFilename": "CHANGELOG.md",
Copy link
Contributor

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?

@JBAhire JBAhire added ci enhancement New feature or request labels Jan 21, 2021
Copy link
Contributor

@kotharironak kotharironak left a 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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants