Skip to content

Commit

Permalink
Merge pull request #16853 from github/support-hardcoded-version-or-pl…
Browse files Browse the repository at this point in the history
…an-in-link

Support hardcoded versions in links in multiple formats
  • Loading branch information
sarahs authored Dec 16, 2020
2 parents acce63e + 6ada81f commit 51a9c7b
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions lib/rewrite-local-links.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ const externalRedirects = Object.keys(require('./redirects/external-sites'))
const pathUtils = require('./path-utils')
const assert = require('assert')
const nonEnterpriseDefaultVersion = require('./non-enterprise-default-version')
const supportedPlans = Object.values(require('./all-versions')).map(v => v.plan)
const allVersions = require('./all-versions')
const supportedVersions = Object.keys(allVersions)
const supportedPlans = Object.values(allVersions).map(v => v.plan)

// Content authors write links like `/some/article/path`, but they need to be
// rewritten on the fly to match the current language and page version
Expand All @@ -27,9 +29,13 @@ function getNewHref (link, languageCode, version) {

let newHref

// If the link has a hardcoded plan name in it (e.g., /enterprise-server/rest/reference/oauth-authorizations),
// only rewrite it with a language code
if (supportedPlans.includes(href.split('/')[1])) {
// If the link has a hardcoded plan or version in it, do not update the version, just add the language code
// Examples:
// /[email protected]/rest/reference/oauth-authorizations
// /enterprise-server/rest/reference/oauth-authorizations (this redirects to the latest version)
// /enterprise-server@latest/rest/reference/oauth-authorizations (this redirects to the latest version)
const firstLinkSegment = href.split('/')[1]
if ([...supportedPlans, ...supportedVersions, 'enterprise-server@latest'].includes(firstLinkSegment)) {
newHref = pathUtils.getPathWithLanguage(href, languageCode)
}

Expand Down

0 comments on commit 51a9c7b

Please sign in to comment.