Skip to content

Conversation

@anenviousguest
Copy link
Contributor

@anenviousguest anenviousguest commented Nov 20, 2023

Description

Added support for generate_release_notes request body parameter for Releases GitHub API.

This fixes #1745.

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".

},
"bodyPatterns" : [
{
"matchesJsonPath" : "$.[?(@.generate_release_notes == true)]"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is where the newly added parameter is verified.

Pre-existing behavior of not passing generate_release_notes when not set is validated in createSimpleRelease test.

@codecov
Copy link

codecov bot commented Nov 20, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (40992f7) 80.16% compared to head (22aeb17) 80.16%.

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #1746   +/-   ##
=========================================
  Coverage     80.16%   80.16%           
- Complexity     2301     2302    +1     
=========================================
  Files           217      217           
  Lines          6962     6964    +2     
  Branches        371      371           
=========================================
+ Hits           5581     5583    +2     
  Misses         1150     1150           
  Partials        231      231           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bitwiseman bitwiseman merged commit 2062439 into hub4j:main Nov 20, 2023
@anenviousguest
Copy link
Contributor Author

@bitwiseman thanks for fast turnaround reviewing it. Any chance to get this released in a foreseeable future?

@bitwiseman
Copy link
Member

I can foresee that happening very soon. Next day or two.

@bitwiseman
Copy link
Member

Released in 1.318.

@anenviousguest anenviousguest deleted the fix/1745-generate_release_notes-support branch November 28, 2025 21:56
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.

Missing support for generate_release_notes in Releases API

2 participants