Skip to content
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

Add label checks for PRs #3618

Closed

Conversation

kotwanikunal
Copy link
Member

Signed-off-by: Kunal Kotwani kkotwani@amazon.com

Description

  • Add support for label-checker to help with release note automation

Issues Resolved

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Kunal Kotwani <kkotwani@amazon.com>
@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Check success f67db83
Log 6087

Reports 6087

steps:
- uses: docker://agilepathway/pull-request-label-checker:latest
with:
one_of: bug,documentation,enhancement,feature,security,:test,>upgrade
Copy link
Member

@dreamer-89 dreamer-89 Jun 17, 2022

Choose a reason for hiding this comment

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

With assumption that automation script will use buckets to layout release notes. For e.g. a PR labeled bug will be placed in [Bug Fixes] section. What should happen when a PR fall into multiple buckets e.g. A bug in security area.
How do we plan to lay out the release notes in this scenario ? Do we need to restrict only one label. If not, how do prioritize bucket for the PR

Copy link
Member Author

Choose a reason for hiding this comment

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

That's a good point. With the current mechanisms, we do it manually but have to sift through the PRs to understand where it belongs. This will help to simplify in the sense that it narrows down where the PR belongs and provides a heuristic to help classify. For an automated approach, we can design the solution in a way to account for the priority and we always can manually intervene if needed for a few of the changes.

Copy link
Member

@dreamer-89 dreamer-89 Jun 17, 2022

Choose a reason for hiding this comment

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

Thanks for this change. This is a good starting point towards release notes automation.

Automation related discussion can be done on automation related PRs. Please address @tlfeng comment below.

steps:
- uses: docker://agilepathway/pull-request-label-checker:latest
with:
one_of: bug,documentation,enhancement,feature,security,:test,>upgrade
Copy link
Collaborator

Choose a reason for hiding this comment

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

My concern is the labels in the list may not enough. For example, the PRs created by dependabot, they will be labeled as dependencies automatically. Looks like if not having that label, those PRs will fail the check.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for raising the point. I know this is not a complete list and would like inputs on what else can be included. It helps break the PRs atleast into major topics that we currently track. We can always add additional and follow a mapping mechanism in the solution we develop further - i.e. documentation, javadocs -> Documentation

Copy link
Collaborator

@nknize nknize left a comment

Choose a reason for hiding this comment

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

Ping.. looks like little activity for the last two weeks. Is this ready or is it needing more polish?

@kotwanikunal
Copy link
Member Author

Closing this in favor #4085

@kotwanikunal kotwanikunal deleted the label-checker branch October 31, 2022 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants