Pass correct baseUrl to octokit #1288
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The PR actions#1246 replaced the `getOctokit` method from the `octokit-provider.ts` file with the `getOctokit` method from the `@actions/github` package. The octokit-provider was previously responsible for creating an Octokit instance and setting the `baseUrl` via the `getServerApiUrl` helper function. This function calls `getServerUrl` which reads the server url from the `GITHUB_SERVER_URL` environment variable, which on GHES is set to the enterprise instance. This commit restores the previous behaviour by calling `getServerApiUrl` in all places where an octokit instance is created. Co-authored-by: Markus Wolf <mail@markus-wolf.de>
fhammerl
reviewed
Apr 13, 2023
| }) | ||
|
|
||
| it('getDefaultBranch should use GITHUB_SERVER_URL to set the baseUrl', async () => { | ||
| ;(github.getOctokit as jest.Mock).mockImplementation(() => { |
There was a problem hiding this comment.
Is the ; necessary for this typecast?
There was a problem hiding this comment.
Technically no, but the prettier configuration in this repository seems to require it. At least the format-check fails without it and format adds it.
There was a problem hiding this comment.
Ah right, my mistake, it is correct. The ; is to prevent the parentheses of (github.getOctokit as jest.Mock) to be interpreted as function invocation in case later statement is added above.
console.log('foo')
(github.getOctokit as jest.Mock)
would be read as console.log('foo')(github.getOctokit as jest.Mock), the ; prevents it.
|
We're already rolling out the hotfix (with the exact same changes :) ) I'll merge this PR regardless, thanks for the unit test. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The PR #1246 replaced the
getOctokitmethod from theoctokit-provider.tsfile with thegetOctokitmethod from the@actions/githubpackage.The octokit-provider was previously responsible for creating an Octokit instance and setting the
baseUrlvia thegetServerApiUrlhelper function. This function callsgetServerUrlwhich reads the server url from theGITHUB_SERVER_URLenvironment variable, which on GHES is set to the enterprise instance.This commit restores the previous behaviour by calling
getServerApiUrlin all places where an octokit instance is created.