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

Only try to strip upload url 'helpful garbage' if it is present #1799

Merged
merged 2 commits into from
Feb 23, 2024

Conversation

SuperKael
Copy link
Contributor

@SuperKael SuperKael commented Feb 22, 2024

This library is mostly compatible with the Gitea API, which although somewhat incidental, is nonetheless wonderful. However, it fails to upload release assets due to this one small and easily-fixed issue. Adding this check does not in any way obstruct the normal use of the GitHub API.

Description

The GHRelease.uploadAsset method substrings the upload URL to grab the URL before the 'helpful garbage' provided by GitHub, which begins with a '{' character. However, if the upload URL does not have a '{' character in it for some reason (such as the API actually being provided by Gitea, not GitHub), this method throws an exception. This change simply adds a check to avoid this exception.

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

This library is mostly compatible with the Gitea API, which although somewhat incidental, is nonetheless wonderful. However, it fails to upload release assets due to this one small and easily-fixed issue. Adding this check does not in any way obstruct the normal use of the GitHub API.
@bitwiseman bitwiseman changed the title Only substring upload url if 'helpful garbage' is present Only try to strip upload url 'helpful garbage' if it is present Feb 23, 2024
Copy link

codecov bot commented Feb 23, 2024

Codecov Report

Attention: Patch coverage is 66.66667% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 80.69%. Comparing base (be00e51) to head (a1499d7).
Report is 11 commits behind head on main.

Files Patch % Lines
src/main/java/org/kohsuke/github/GHRelease.java 66.66% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1799      +/-   ##
============================================
+ Coverage     80.64%   80.69%   +0.04%     
- Complexity     2322     2330       +8     
============================================
  Files           219      220       +1     
  Lines          7027     7049      +22     
  Branches        371      372       +1     
============================================
+ Hits           5667     5688      +21     
  Misses         1128     1128              
- Partials        232      233       +1     

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

@bitwiseman bitwiseman merged commit 6f3f39f into hub4j:main Feb 23, 2024
10 of 11 checks passed
@SuperKael SuperKael deleted the release-upload-fix branch February 23, 2024 20:15
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