Skip to content

Account for versioning of ghe.com #1597

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.

Sign up for GitHub

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

Jump to bottom
Merged
rneatherway merged 1 commit into from
Mar 22, 2023
Merged

Account for versioning of ghe.com #1597

rneatherway merged 1 commit into from
Mar 22, 2023

Conversation

@rneatherway
Copy link
Contributor

@rneatherway rneatherway commented Mar 21, 2023

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Confirm the readme has been updated if necessary.
  • Confirm the changelog has been updated if necessary.

@rneatherway rneatherway requested a review from a team as a code owner March 21, 2023 17:32
angelapwen
angelapwen reviewed Mar 21, 2023
View reviewed changes
Copy link
Contributor

@angelapwen angelapwen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You may want to also add this variant to the tests in

codeql-action/src/util.ts

Lines 304 to 339 in 760583e

export enum GitHubVariant {
DOTCOM,
GHES,
GHAE,
}
export type GitHubVersion =
| { type: GitHubVariant.DOTCOM }
| { type: GitHubVariant.GHAE }
| { type: GitHubVariant.GHES; version: string };
export async function getGitHubVersion(
apiDetails: GitHubApiDetails
): Promise<GitHubVersion> {
// We can avoid making an API request in the standard dotcom case
if (parseGitHubUrl(apiDetails.url) === GITHUB_DOTCOM_URL) {
return { type: GitHubVariant.DOTCOM };
}
// Doesn't strictly have to be the meta endpoint as we're only
// using the response headers which are available on every request.
const apiClient = getApiClient();
const response = await apiClient.meta.get();
// This happens on dotcom, although we expect to have already returned in that
// case. This can also serve as a fallback in cases we haven't foreseen.
if (response.headers[GITHUB_ENTERPRISE_VERSION_HEADER] === undefined) {
return { type: GitHubVariant.DOTCOM };
}
if (response.headers[GITHUB_ENTERPRISE_VERSION_HEADER] === "GitHub AE") {
return { type: GitHubVariant.GHAE };
}
const version = response.headers[GITHUB_ENTERPRISE_VERSION_HEADER] as string;
return { type: GitHubVariant.GHES, version };
}
😄

@rneatherway rneatherway force-pushed the rneatherway/ghe-dotcom branch from a9af051 to 3ca2260 Compare March 22, 2023 16:47
@rneatherway
Copy link
Contributor Author

rneatherway commented Mar 22, 2023

You may want to also add this variant to the tests in

Thanks, test added!

angelapwen
angelapwen approved these changes Mar 22, 2023
View reviewed changes
Copy link
Contributor

@angelapwen angelapwen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just realized I linked the non-test file 😆 but you understood what I meant!

@rneatherway rneatherway enabled auto-merge March 22, 2023 17:02
@rneatherway rneatherway merged commit aefd989 into main Mar 22, 2023
@rneatherway rneatherway deleted the rneatherway/ghe-dotcom branch March 22, 2023 17:21
@github-actions github-actions bot mentioned this pull request Mar 22, 2023
Merged
6 tasks
@aliscco aliscco mentioned this pull request Apr 28, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@angelapwen angelapwen angelapwen approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@rneatherway @angelapwen