do not rewrite deprecated GHES links

This commit is contained in:
Sarah Schneider 2021-01-07 16:47:57 -05:00
Родитель 1dd9f3cbf1
Коммит a6c48782c6
1 изменённых файлов: 15 добавлений и 11 удалений

Просмотреть файл

@ -4,7 +4,7 @@ const externalRedirects = Object.keys(require('./redirects/external-sites'))
const { getPathWithoutLanguage, getVersionStringFromPath } = require('./path-utils')
const { getNewVersionedPath } = require('./old-versions-utils')
const patterns = require('./patterns')
const { latest } = require('./enterprise-server-releases')
const { deprecated, latest } = require('./enterprise-server-releases')
const nonEnterpriseDefaultVersion = require('./non-enterprise-default-version')
const removeFPTFromPath = require('./remove-fpt-from-path')
const allVersions = require('./all-versions')
@ -24,16 +24,13 @@ module.exports = function rewriteLocalLinks ($, version, languageCode) {
function getNewHref (link, languageCode, version) {
const href = link.attr('href')
// these links should not be rewritten
// Exceptions to link rewriting
if (href.startsWith('/assets')) return
if (href.startsWith('/public')) return
// Leave old redirected URLs intact
// e.g. `/contact` should not be replaced with `/en/contact`
if (externalRedirects.includes(href)) return
let newHref
// If the link has a hardcoded plan or version in it, do not update the version, just add the language code
let newHref = href
// If the link has a hardcoded plan or version in it, do not update other than adding a language code
// Examples:
// /enterprise-server@2.20/rest/reference/oauth-authorizations
// /enterprise-server/rest/reference/oauth-authorizations (this redirects to the latest version)
@ -43,11 +40,16 @@ function getNewHref (link, languageCode, version) {
newHref = path.join('/', languageCode, href)
}
// If link is dotcom-only, just get the language code
// Otherwise, get the versioned path with language code
if (!newHref) {
// If the link includes a deprecated version, do not update other than adding a language code
// Example: /enterprise/11.10.340/admin/articles/upgrading-to-the-latest-release
const oldEnterpriseVersionNumber = href.match(patterns.getEnterpriseVersionNumber)
if (oldEnterpriseVersionNumber && deprecated.includes(oldEnterpriseVersionNumber[1])) {
newHref = path.join('/', languageCode, href)
}
if (newHref === href) {
// start clean with no language (TOC pages already include the lang codes via lib/liquid-tags/link.js)
const hrefWithoutLang = getPathWithoutLanguage(href).replace(patterns.trailingSlash, '$1')
const hrefWithoutLang = getPathWithoutLanguage(href)
// normalize any legacy links so they conform to new link structure
newHref = path.join('/', languageCode, getNewVersionedPath(hrefWithoutLang))
@ -76,5 +78,7 @@ function getNewHref (link, languageCode, version) {
newHref = removeFPTFromPath(newHref.replace(versionFromHref, version))
}
newHref = newHref.replace(patterns.trailingSlash, '$1')
if (href !== newHref) link.attr('href', newHref)
}