Account for versioning of ghe.com by rneatherway · Pull Request #1597 · github/codeql-action · GitHub

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.

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

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 }; 
        
           }

😄

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

Thanks, test added!

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

rneatherway requested a review from a team as a code owner March 21, 2023 17:32

angelapwen reviewed Mar 21, 2023

View reviewed changes

Account for versioning of ghe.com

3ca2260

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

angelapwen approved these changes Mar 22, 2023

View reviewed changes

rneatherway enabled auto-merge March 22, 2023 17:02

rneatherway merged commit aefd989 into main Mar 22, 2023

rneatherway deleted the rneatherway/ghe-dotcom branch March 22, 2023 17:21

github-actions Bot mentioned this pull request Mar 22, 2023

Merge main into releases/v2 #1601

Merged

6 tasks

aliscco mentioned this pull request Apr 28, 2023

[Snyk] Fix for 3 vulnerabilities aliscco/codeql-action#351

Open

Account for versioning of ghe.com by rneatherway · Pull Request #1597 · github/codeql-action · GitHub

Account for versioning of ghe.com - #1597

Account for versioning of ghe.com#1597
rneatherway merged 1 commit into
mainfrom
rneatherway/ghe-dotcom

rneatherway commented Mar 21, 2023

Uh oh!

angelapwen left a comment

Uh oh!

rneatherway commented Mar 22, 2023

Uh oh!

angelapwen left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	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 };
	}

Account for versioning of ghe.com by rneatherway · Pull Request #1597 · github/codeql-action · GitHub

Account for versioning of ghe.com - #1597

Account for versioning of ghe.com#1597rneatherway merged 1 commit intomaingithub/codeql-action:mainfrom rneatherway/ghe-dotcomgithub/codeql-action:rneatherway/ghe-dotcomCopy head branch name to clipboard

Conversation

rneatherway commented Mar 21, 2023

Merge / deployment checklist

Uh oh!

angelapwen left a comment

Choose a reason for hiding this comment

Uh oh!

rneatherway commented Mar 22, 2023

Uh oh!

angelapwen left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Account for versioning of ghe.com#1597
rneatherway merged 1 commit into
mainfrom
rneatherway/ghe-dotcom