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

Support make_latest when creating/updating a release #1676

Merged
merged 6 commits into from
Jun 14, 2023

Conversation

nikclayton
Copy link
Contributor

@nikclayton nikclayton commented Jun 9, 2023

Description

Add support for the make_latest option when creating or updating a release (https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#create-a-release).

Fixes #1595.

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

Copy link
Member

@bitwiseman bitwiseman left a comment

Choose a reason for hiding this comment

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

It looks like there is an api to the the latest release, example: https://api.github.com/repos/hub4j/github-api/releases/latest .

I've invited you to https://github.com/hub4j-test-org to make creating the test easier.

So, you could write a test that:

  • Creates a temp repository (built-in utility)
  • Creates a release
  • Gets latest (should match the created release)
  • Creates a new release with make_latest set to false
  • Gets latest (should match the first release)
  • Creates a new release with make_latest set to true
  • Gets latest (should match the last created release)

@codecov
Copy link

codecov bot commented Jun 13, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.02 🎉

Comparison is base (8b80485) 79.97% compared to head (722ec7f) 80.00%.

❗ Current head 722ec7f differs from pull request most recent head 0af9c3a. Consider uploading reports for the commit 0af9c3a to get more accurate results

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1676      +/-   ##
============================================
+ Coverage     79.97%   80.00%   +0.02%     
- Complexity     2221     2223       +2     
============================================
  Files           213      213              
  Lines          6718     6727       +9     
  Branches        365      365              
============================================
+ Hits           5373     5382       +9     
  Misses         1131     1131              
  Partials        214      214              
Impacted Files Coverage Δ
...main/java/org/kohsuke/github/GHReleaseBuilder.java 84.00% <100.00%> (+6.22%) ⬆️
...main/java/org/kohsuke/github/GHReleaseUpdater.java 58.33% <100.00%> (+3.78%) ⬆️

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

@bitwiseman bitwiseman merged commit 8e73065 into hub4j:main Jun 14, 2023
@nikclayton nikclayton deleted the 1595-makelatest branch June 14, 2023 19:25
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.

Feature Request: GHReleaseBuilder able to update relaese to latest
2 participants