github-api icon indicating copy to clipboard operation
github-api copied to clipboard

fix: fix issue #1325 and add missing `truncated` field in the `GHGist` object

Open SCHJonathan opened this issue 4 years ago • 2 comments

Description

  1. Fixes #1325 by adding a lazy download from the raw_url field of GHGistFile object if the gist file content is uninitialized.
  2. From the list public gist documentation, I found out we are missing the truncated field in the GHGist object and I added that field in this PR.

Before submitting a PR:

  • [x] 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.
  • [x] Add JavaDocs and other comments as appropriate. Consider including links in comments to relevant documentation on https://docs.github.com/en/rest .
  • [x] Add tests that cover any added or changed code. This generally requires capturing snapshot test data. See CONTRIBUTING.md for details.
  • [x] Run mvn -D enable-ci clean install site locally. If this command doesn't succeed, your change will not pass CI.
  • [x] Push your changes to a branch other than main. You will create your PR from that branch.

When creating a PR:

  • [x] Fill in the "Description" above with clear summary of the changes. This includes:
    • [x] If this PR fixes one or more issues, include "Fixes #" lines for each issue.
    • [x] Provide links to relevant documentation on https://docs.github.com/en/rest where possible.
  • [x] 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."
  • [x] Enable "Allow edits from maintainers".

SCHJonathan avatar Dec 07 '21 17:12 SCHJonathan

@bitwiseman. Thank you so much for your help and detailed comment, bitwiseman! All of those suggestions are super helpful and I have made revisions based on your suggestions!

SCHJonathan avatar Dec 08 '21 17:12 SCHJonathan

@SCHJonathan You're very close on this. Do you time to finish this PR in the next few days? I plan to do a release soon.

bitwiseman avatar Feb 14 '22 22:02 bitwiseman