Skip to content

Commit 2851c14

Browse files
authored
Tidy up remaining skips around ghae in code (#49282)
1 parent f5546af commit 2851c14

File tree

11 files changed

+19
-57
lines changed

11 files changed

+19
-57
lines changed

src/audit-logs/tests/rendering.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { expect } from '@jest/globals'
22

33
import { getDOM } from '#src/tests/helpers/e2etest.js'
4-
import { allTestableVersions } from '#src/versions/lib/all-versions.js'
4+
import { allVersions } from '#src/versions/lib/all-versions.js'
55
import { getAuditLogEvents } from '../lib/index.js'
66

77
describe('audit log events docs', () => {
@@ -26,7 +26,7 @@ describe('audit log events docs', () => {
2626
test.each(auditLogEventPages)(
2727
'loads audit log event data for all versions on page %o',
2828
async (page) => {
29-
for (const version of allTestableVersions) {
29+
for (const version of Object.keys(allVersions)) {
3030
const auditLogEvents = getAuditLogEvents(page.type, version, true)
3131

3232
if (Object.keys(auditLogEvents).length === 0) {

src/graphql/scripts/sync.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ async function main() {
2828
for (const version of versionsToBuild) {
2929
// Get the relevant GraphQL name for the current version
3030
// For example, free-pro-team@latest corresponds to dotcom,
31-
// [email protected] corresponds to ghes-2.22,
32-
// and github-ae@latest corresponds to ghae
31+
// [email protected] corresponds to ghes-2.22.
3332
const graphqlVersion = allVersions[version].openApiVersionName
3433

3534
// 1. UPDATE PREVIEWS

src/languages/tests/frame.js

-8
Original file line numberDiff line numberDiff line change
@@ -99,14 +99,6 @@ describe('release notes', () => {
9999
const combinations = []
100100
const prefixes = []
101101
for (const version of page.applicableVersions) {
102-
// Like a chicken-and-egg problem, we can't entirely remove
103-
// github-ae from the list of versions because first we
104-
// have to stop depending on it and clean up all front matter
105-
// and all Liquid. But we also shouldn't depend on testing it
106-
// any more since it always redirects to enterprise-cloud.
107-
if (version === 'github-ae@latest') {
108-
continue
109-
}
110102
const prefix = version.split('@')[0]
111103
if (prefixes.includes(prefix)) {
112104
continue

src/release-notes/tests/release-notes.js

+1-6
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,7 @@ describe('server', () => {
2828
expect(res.statusCode).toBe(200)
2929
})
3030

31-
const applicableVersions = page.applicableVersions.filter(
32-
// github-ae can't be deleted from the list of all versions until
33-
// all front matter and all Liquid is cleaned up. This is a legacy
34-
// version and we always redirect it out anyway to enterprise-cloud.
35-
(version) => version !== 'github-ae@latest',
36-
)
31+
const { applicableVersions } = page
3732

3833
test.each(applicableVersions)('version %s that has release-notes', async (version) => {
3934
const url = `/en/${version}/admin/release-notes`

src/rest/docs.js

+1-5
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,7 @@ Object.assign(
1111
versionMapping,
1212
...Object.entries(invertedVersionMapping).map(([a, b]) => ({ [b]: a })),
1313
)
14-
const openApiVersions = Object.entries(allVersions)
15-
// As of Feb 2024, we can't remove ghae from all-versions.js so instead
16-
// we deliberately filter it out.
17-
.filter(([version]) => version !== 'github-ae@latest')
18-
.map(([, value]) => value)
14+
const openApiVersions = Object.values(allVersions)
1915
.map((version) => version.openApiVersionName)
2016
.map((version) => (version in versionMapping ? versionMapping[version] : version))
2117
.join(', ')

src/rest/scripts/utils/update-markdown.js

-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@ async function getDataFrontmatter(dataDirectory, schemaFilename) {
8282
"artifacts": {
8383
"versions": {
8484
"free-pro-team@latest",
85-
"github-ae@latest",
8685
"enterprise-cloud@latest",
8786
8887

src/rest/tests/openapi-schema.js

-2
Original file line numberDiff line numberDiff line change
@@ -194,8 +194,6 @@ describe('code examples are defined', () => {
194194
let domain = 'https://api.github.com'
195195
if (version.includes('enterprise-server')) {
196196
domain = 'http(s)://HOSTNAME/api/v3'
197-
} else if (version === 'github-ae@latest') {
198-
domain = 'https://HOSTNAME/api/v3'
199197
}
200198

201199
const operation = await findOperation(version, 'GET', '/repos/{owner}/{repo}')

src/rest/tests/rendering.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { jest, test } from '@jest/globals'
22
import { slug } from 'github-slugger'
33

44
import { get, getDOM } from '#src/tests/helpers/e2etest.js'
5-
import { isApiVersioned, allVersions, allTestableVersions } from '#src/versions/lib/all-versions.js'
5+
import { isApiVersioned, allVersions } from '#src/versions/lib/all-versions.js'
66
import { getDiffOpenAPIContentRest } from '../scripts/test-open-api-schema.js'
77
import getRest from '#src/rest/lib/index.js'
88

@@ -13,7 +13,7 @@ describe('REST references docs', () => {
1313
// in sync. It checks that every version of the /rest/checks
1414
// page has every operation defined in the openapi schema.
1515
test('loads schema data for all versions', async () => {
16-
for (const version of allTestableVersions) {
16+
for (const version of Object.keys(allVersions)) {
1717
const calendarDate = allVersions[version].latestApiVersion
1818
const checksRestOperations = await getRest(version, calendarDate, 'checks', 'runs')
1919
const $ = await getDOM(`/en/${version}/rest/checks/runs?restVersion=${calendarDate}`)
@@ -99,7 +99,7 @@ describe('REST references docs', () => {
9999
})
100100

101101
test('REST pages show the correct versions in the api version picker', async () => {
102-
for (const version of allTestableVersions) {
102+
for (const version of Object.keys(allVersions)) {
103103
if (isApiVersioned(version)) {
104104
for (const apiVersion of allVersions[version].apiVersions) {
105105
const $ = await getDOM(`/en/${version}/rest?apiVersion=${apiVersion}`)

src/search/tests/rendering.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ describeIfElasticsearchURL('search rendering page', () => {
105105
// Note it testid being 'search-result', not 'search-results'
106106
const results = $('[data-testid="search-result"]')
107107
expect(results.length).toBeGreaterThan(0)
108-
// Each link should have github-ae@latest in the pathname
108+
// Each link should have enterprise-cloud@latest in the pathname
109109
const links = $('[data-testid="search-result"] a')
110110
const hrefs = links.map((i, el) => $(el).attr('href')).get()
111111
for (const href of hrefs) {

src/versions/components/VersionPicker.tsx

+10-17
Original file line numberDiff line numberDiff line change
@@ -32,23 +32,16 @@ export const VersionPicker = ({ xs }: Props) => {
3232
return prefix + router.asPath.replace(`/${currentVersion}`, '')
3333
}
3434

35-
const allLinks = (page.applicableVersions || [])
36-
.filter((pageVersion) => {
37-
// GHAE is deprecated. As per issue #3589 we're softly removing
38-
// the version from the version picker. The only exception is if
39-
// you're already on a GHAE page.
40-
return pageVersion !== 'github-ae@latest' || currentVersion === 'github-ae@latest'
41-
})
42-
.map((pageVersion) => ({
43-
text: allVersions[pageVersion].versionTitle,
44-
selected: currentVersion === pageVersion,
45-
href: versionToHref(pageVersion),
46-
extra: {
47-
arrow: false,
48-
info: false,
49-
},
50-
divider: false,
51-
}))
35+
const allLinks = (page.applicableVersions || []).map((pageVersion) => ({
36+
text: allVersions[pageVersion].versionTitle,
37+
selected: currentVersion === pageVersion,
38+
href: versionToHref(pageVersion),
39+
extra: {
40+
arrow: false,
41+
info: false,
42+
},
43+
divider: false,
44+
}))
5245

5346
const hasEnterpriseVersions = (page.applicableVersions || []).some((pageVersion) =>
5447
pageVersion.startsWith('enterprise-server'),

src/versions/lib/all-versions.js

-10
Original file line numberDiff line numberDiff line change
@@ -119,14 +119,4 @@ export function getOpenApiVersion(version) {
119119
return allVersions[version].openApiVersionName
120120
}
121121

122-
export const allTestableVersions = Object.keys(allVersions).filter(
123-
// Because of the deprecation of GHAE we can't delete it from `allVersions`
124-
// until ALL cleaning up is done. Since we're now always redirecting
125-
// all requests for `.../github-ae@latest/...` we also shouldn't test it.
126-
// Other end-to-end tests will test the redirects of that legacy.
127-
// The day `github-ae@latest` is no longer in all-versions.js
128-
// this filtering can be deleted.
129-
(version) => version !== 'github-ae@latest',
130-
)
131-
132122
export { allVersions }

0 commit comments

Comments
 (0)