GitHub upload using GraphQL #882
Conversation
🦋 Changeset detectedLatest commit: 4104f25 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
src/api/github/push.ts
Outdated
| contents: await fs.readFile(filePath, { | ||
| encoding: 'base64', | ||
| }), |
There was a problem hiding this comment.
Is there a request size limit that we need to be aware of here? In that scenario, does GitHub provide an option to upload files separately? (I'm hoping we can avoid this complexity, but just thinking out loud.)
There was a problem hiding this comment.
None that they publicly say. Does not look like there's an option to upload files separately unless you want to use their REST API which requires about 3 different API calls to make a commit :\
docs/development-api/github.md
Outdated
| @@ -119,5 +165,23 @@ await GitHub.putIssueComment({ | |||
|
|
|||
| --- | |||
|
|
|||
| ## mapChangedFilesToFileChanges | |||
There was a problem hiding this comment.
Given this is an I/O operation, I wonder if the verb should here be read or load?
There was a problem hiding this comment.
Yeah I think that makes sense, when I first started this I thought it was going to be a simple map.
docs/development-api/github.md
Outdated
|
|
||
| These file changes will appear as verified commits on GitHub. | ||
|
|
||
| Please note: this will not update the local Git repository |
There was a problem hiding this comment.
| Please note: this will not update the local Git repository | |
| This function is roughly equivalent to `git push`, | |
| but it will not update the local Git repository. |
There was a problem hiding this comment.
I would suggest it's not similar since push would push commits and this would not?
There was a problem hiding this comment.
Perhaps maybe avoiding push might be wise? Would upload make more sense?
There was a problem hiding this comment.
Ah yes, I clearly wrote the wrong thing here. Will revert 🙇
Co-authored-by: Sam Chung <samc@seek.com.au>
Adds new methods to use the GitHub GraphQL API to push code. This signs our commits which resolves #684
Each call seems to consume only 1 point per call out of our 5000 points/hour quota.