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

feat: Support merge_group events #1726

Merged
merged 1 commit into from
Oct 13, 2023
Merged

feat: Support merge_group events #1726

merged 1 commit into from
Oct 13, 2023

Conversation

felipefrancisco
Copy link
Contributor

@felipefrancisco felipefrancisco commented Oct 13, 2023

Description

Important

DISCLAIMER: I'm not a Java developer - This PR is based on the changes implemented in #1316, which seemed quite simple to do, so I'm proposing these changes for review.


This PR adds support for merge_group events fired by merge queues, please see the official documentation for details:

I'm submitting this PR since I'm using jenkinsci/github-plugin, which is failing to accept these valid events fired by Github. It does an event-check here based on org.kohsuke.github.GHEvent (defined by this project) and, since merge_group is not a supported event, it fails with "Hook should contain event type".

Here's an example of what I see on Github Settings > Webhook on my end when Jenkins receives that payload:

image

Before submitting a PR:

  • Changes must not break binary backwards compatibility. If you are unclear on how to make the change you think is needed while maintaining backward compatibility, CONTRIBUTING.md for details.
  • Add JavaDocs and other comments explaining the behavior.
  • When adding or updating methods that fetch entities, add @link JavaDoc entries to the relevant documentation on https://docs.github.com/en/rest .
  • Add tests that cover any added or changed code. This generally requires capturing snapshot test data. See CONTRIBUTING.md for details.
  • Run mvn -D enable-ci clean install site locally. If this command doesn't succeed, your change will not pass CI.
  • Push your changes to a branch other than main. You will create your PR from that branch.

When creating a PR:

  • Fill in the "Description" above with clear summary of the changes. This includes:
    • If this PR fixes one or more issues, include "Fixes #" lines for each issue.
    • Provide links to relevant documentation on https://docs.github.com/en/rest where possible. If not including links, explain why not.
  • All lines of new code should be covered by tests as reported by code coverage. Any lines that are not covered must have PR comments explaining why they cannot be covered. For example, "Reaching this particular exception is hard and is not a particular common scenario."
  • Enable "Allow edits from maintainers".

@felipefrancisco
Copy link
Contributor Author

Hey @bitwiseman, apologies for the direct ping - I noticed that you're an active contributor to this project, so I was hoping you could kindly have a look through this very short PR in case you get a chance.

@codecov
Copy link

codecov bot commented Oct 13, 2023

Codecov Report

All modified lines are covered by tests ✅

Files Coverage Δ
src/main/java/org/kohsuke/github/GHEvent.java 100.00% <100.00%> (ø)

📢 Thoughts on this report? Let us know!.

@bitwiseman bitwiseman merged commit 8014bec into hub4j:main Oct 13, 2023
10 of 11 checks passed
@felipefrancisco
Copy link
Contributor Author

felipefrancisco commented Oct 16, 2023

Thank you for the speedy feedback @bitwiseman 🙏🏽

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.

2 participants