42e785b0a8
* First run of script * Get the app running --- ish * Get NextJS working * Remove `node:` * Get more tests passing in unit directory * Update FailBot test to use nock * Update test.yml * Update Dockerfile * tests/content fixes * Update page.js * Update build-changelog.js * updating tests/routing * Update orphan-tests.js * updating tests/rendering * Update .eslintrc.js * Update .eslintrc.js * Install jest/globals * "linting" tests * staging update to server.mjs * Change '.github/allowed-actions.js' to a ESM export * Lint * Fixes for the main package.json * Move Jest to be last in the npm test command so we can pass args * Just use 'npm run lint' in the npm test command * update algolia label script * update openapi script * update require on openapi * Update enterprise-algolia-label.js * forgot JSON.parse * Update lunr-search-index.js * Always explicitly include process.cwd() for JSON file reads pathed from project root * update graphql/update-files.js script * Update other npm scripts using jest to pass ESM NODE_OPTIONS * Update check-for-enterprise-issues-by-label.js for ESM * Update create-enterprise-issue.js for ESM * Import jest global for browser tests * Convert 'script/deploy' to ESM Co-authored-by: Grace Park <gracepark@github.com> Co-authored-by: James M. Greene <jamesmgreene@github.com>
81 lines
3.7 KiB
JavaScript
81 lines
3.7 KiB
JavaScript
import path from 'path'
|
|
import { supported, latest } from './enterprise-server-releases.js'
|
|
import patterns from './patterns.js'
|
|
import nonEnterpriseDefaultVersion from './non-enterprise-default-version.js'
|
|
import xAllVersions from './all-versions.js'
|
|
const latestNewVersion = `enterprise-server@${latest}`
|
|
const oldVersions = ['dotcom'].concat(supported)
|
|
const newVersions = Object.keys(xAllVersions)
|
|
|
|
// Utility functions for converting between old version paths and new version paths.
|
|
// See lib/path-utils.js for utility functions based on new paths.
|
|
// Examples:
|
|
// OLD /github/category/article to NEW /free-pro-team@latest/github/category/article
|
|
// OLD /enterprise/2.21/user/github/category/article to NEW /enterprise-server@2.21/github/category/article
|
|
// OLD /enterprise/user/github/category/article to NEW /enterprise-server@<latest>/github/category/article
|
|
|
|
// Given a new version like enterprise-server@2.21,
|
|
// return an old version like 2.21.
|
|
// Fall back to latest GHES version if one can't be found,
|
|
// for example, if the new version is private-instances@latest.
|
|
export function getOldVersionFromNewVersion (newVersion) {
|
|
return newVersion === nonEnterpriseDefaultVersion
|
|
? 'dotcom'
|
|
: oldVersions.find(oldVersion => newVersion.includes(oldVersion)) || latest
|
|
}
|
|
|
|
// Given an old version like 2.21,
|
|
// return a new version like enterprise-server@2.21.
|
|
// Fall back to latest GHES version if one can't be found.
|
|
export function getNewVersionFromOldVersion (oldVersion) {
|
|
return oldVersion === 'dotcom'
|
|
? nonEnterpriseDefaultVersion
|
|
: newVersions.find(newVersion => newVersion.includes(oldVersion)) || latestNewVersion
|
|
}
|
|
|
|
// Given an old path like /enterprise/2.21/user/github/category/article,
|
|
// return an old version like 2.21.
|
|
export function getOldVersionFromOldPath (oldPath, languageCode) {
|
|
// We should never be calling this function on a path that starts with a new version,
|
|
// so we can assume the path either uses the old /enterprise format or it's dotcom.
|
|
if (!patterns.enterprise.test(oldPath)) return 'dotcom'
|
|
|
|
const ghesNumber = oldPath.match(patterns.getEnterpriseVersionNumber)
|
|
return ghesNumber ? ghesNumber[1] : latest
|
|
}
|
|
|
|
// Given an old path like /en/enterprise/2.21/user/github/category/article,
|
|
// return a new path like /en/enterprise-server@2.21/github/category/article.
|
|
export function getNewVersionedPath (oldPath, languageCode = '') {
|
|
// It's possible a new version has been injected into an old path
|
|
// via syntax like: /en/enterprise/{{ currentVersion }}/admin/category/article
|
|
// which could resolve to /en/enterprise/private-instances@latest/admin/category/article,
|
|
// in which case the new version is the `private-instances@latest` segment.
|
|
// Get the second or third segment depending on whether there is a lang code.
|
|
const pathParts = oldPath.split('/')
|
|
const possibleVersion = languageCode ? pathParts[3] : pathParts[2]
|
|
let newVersion = newVersions.includes(possibleVersion) ? possibleVersion : ''
|
|
|
|
// If no new version was found, assume path contains an old version, like 2.21
|
|
if (!newVersion) {
|
|
const oldVersion = getOldVersionFromOldPath(oldPath, languageCode)
|
|
newVersion = getNewVersionFromOldVersion(oldVersion)
|
|
}
|
|
|
|
// Remove /<lang>?/enterprise?/<version>?/user? if present.
|
|
// This leaves only the part of the string that starts with the product.
|
|
// Example: /github/category/article
|
|
const restOfString = oldPath.replace(patterns.oldEnterprisePath, '')
|
|
|
|
// Add the language and new version to the product part of the string
|
|
return path.posix.join('/', languageCode, newVersion, restOfString)
|
|
}
|
|
|
|
export default {
|
|
oldVersions,
|
|
getOldVersionFromOldPath,
|
|
getOldVersionFromNewVersion,
|
|
getNewVersionFromOldVersion,
|
|
getNewVersionedPath
|
|
}
|