Fix type of commit for create_file
#2120
Conversation
Codecov ReportPatch coverage has no change and project coverage change:
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. Additional details and impacted files@@ Coverage Diff @@
## master #2120 +/- ##
==========================================
+ Coverage 98.68% 98.77% +0.08%
==========================================
Files 117 117
Lines 11825 11674 -151
==========================================
- Hits 11670 11531 -139
+ Misses 155 143 -12
☔ View full report in Codecov by Sentry. |
|
@s-t-e-v-e-n-k updated with a bit of checking in the test but wasn't quite sure what to test, so I just checked if the raw data matched the GitCommit, and if it !matched Commit. I wanted to take a look at the tree property, but that requires adding new github responses and as noted in #2118 I'm not quite sure what the "proper" way to add them is. |
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
|
@sfdye could I bother you with reopening and taking a gander at this? As far as I can tell it remains an issue, which makes |
|
@xmo-odoo I have rebased your branch to the latest maser |
The `commit` key of `create_file`'s result currently uses `github.Commit.Commit`, but that does not match the data model of the endpoint: while ill documented on docs.github.com, looking at the published schema (via https://github.com/github/rest-api-description or more readably https://github.com/octokit/types.ts which is automatically generated from the former) `file-commit.commit` looks significantly more like a `git-commit` than a `commit`: * `commit`'s author and committer are git*hub* objects (`nullable-simple-user`), while `file-commit.commit`'s are git objects (triplets of name, email, and date) * `commit` embeds the tree, and message in a sub-object, while `file-commit.commit` has them at the toplevel * `file-commit.commit` has no `stats` or `files` properties, or `comments_url` In all of these, `file-commit.commit` matches `git-commit` exactly. The only real divergence between `git-commit` and `file-commit.commit` is that the schema indicates all of `file-commit.commit`'s properties are optional, but I think it's a case of the endpoint being under-specified and the properties *not* being marked required, rather than them being explicitly optional. See github/rest-api-description#650 for an issue on that subject with more information.
The
commitkey ofcreate_file's result currently usesgithub.Commit.Commit, but that does not match the data model of the endpoint: while ill documented on docs.github.com, looking at the published schema (via https://github.com/github/rest-api-description or more readably https://github.com/octokit/types.ts which is automatically generated from the former)file-commit.commitlooks significantly more like agit-committhan acommit:commit's author and committer are github objects (nullable-simple-user), whilefile-commit.commit's are git objects (triplets of name, email, and date)commitembeds the tree, and message in a sub-object, whilefile-commit.commithas them at the toplevelfile-commit.commithas nostatsorfilesproperties, orcomments_urlIn all of these,
file-commit.commitmatchesgit-commitexactly.The only real divergence between
git-commitandfile-commit.commitis that the schema indicates all offile-commit.commit's properties are optional, but I think it's a case of the endpoint being under-specified and the properties not being marked required, rather than them being explicitly optional. See github/rest-api-description#650 for an issue on that subject with more information.