Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

feat: Add head_commit to GHEventPayload.Push #1586

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 1 commit into from
Dec 25, 2022

Conversation

rahulsom
Copy link
Contributor

When that class represents a commit being pushed to a branch, the list of commits is available and useful to know what was pushed.

When it represents a tag being pushed, the list of commits can be empty. The head_commit comes in handy to know more about the commit.

This change exposes head_commit using the getter getHeadCommit().

The test data already has the data for this to work. The test case has been updated to test for this method.

The docs for this can be found at https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#push

Fixes: #1585

Description

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 as appropriate. Consider including links in comments to 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.
  • 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".

When that class represents a commit being pushed to a branch, the list
of commits is available and useful to know what was pushed.

When it represents a tag being pushed, the list of commits can be empty.
The `head_commit` comes in handy to know more about the commit.

This change exposes `head_commit` using the getter `getHeadCommit()`.

The test data already has the data for this to work. The test case has
been updated to test for this method.

Refs: hub4j#1585
@rahulsom
Copy link
Contributor Author

On JDK 8, this build goes the furthest and I end with mvn -D enable-ci clean install site

Exit code: 1 - javadoc: error - invalid flag: --release

I'm not sure what JDK I should be on. The other two (11 and 17) don't go this far. I would appreciate any insight on how to build it locally and have the build pass.

@codecov
Copy link

codecov bot commented Dec 24, 2022

Codecov Report

Base: 79.29% // Head: 79.31% // Increases project coverage by +0.01% 🎉

Coverage data is based on head (1876a69) compared to base (a9a93ad).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1586      +/-   ##
============================================
+ Coverage     79.29%   79.31%   +0.01%     
  Complexity     2140     2140              
============================================
  Files           206      206              
  Lines          6564     6565       +1     
  Branches        362      362              
============================================
+ Hits           5205     5207       +2     
+ Misses         1147     1146       -1     
  Partials        212      212              
Impacted Files Coverage Δ
...c/main/java/org/kohsuke/github/GHEventPayload.java 80.46% <100.00%> (+0.46%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@bitwiseman bitwiseman merged commit 7b54d64 into hub4j:main Dec 25, 2022
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.

Support head_commit for GHEventPayload.Push
2 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.