aa5a62d49d
* remove FEATURE_NEW_VERSIONS from feature-flags.json * remove process.env.FEATURE_NEW_VERSIONS from include files * remove process.env.FEATURE_NEW_VERSIONS from lib files * remove process.env.FEATURE_NEW_VERSIONS from middleware files * remove process.env.FEATURE_NEW_VERSIONS from script files * remove process.env.FEATURE_NEW_VERSIONS from test files * update test fixtures to use new versions as canonical fixtures
53 lines
1.9 KiB
JavaScript
53 lines
1.9 KiB
JavaScript
const allVersions = require('./all-versions')
|
|
const versionSatisifiesRange = require('./version-satisfies-range')
|
|
|
|
// return an array of versions that an article's product versions encompasses
|
|
function getApplicableVersions (frontmatterVersions, filepath) {
|
|
if (typeof frontmatterVersions === 'undefined') {
|
|
throw new Error(`No \`versions\` frontmatter found in ${filepath}`)
|
|
}
|
|
|
|
// all versions are applicable!
|
|
if (frontmatterVersions === '*') {
|
|
return Object.keys(allVersions)
|
|
}
|
|
|
|
// get an array like: [ 'free-pro-team@latest', 'enterprise-server@2.21', 'enterprise-cloud@latest' ]
|
|
const applicableVersions = []
|
|
|
|
// where frontmatter is something like:
|
|
// free-pro-team: '*'
|
|
// enterprise-server: '>=2.19'
|
|
// enterprise-cloud: '*'
|
|
// private-instances: '*'
|
|
// ^ where each key correponds to a plan
|
|
Object.entries(frontmatterVersions)
|
|
.forEach(([plan, planValue]) => {
|
|
// for each plan (e.g., enterprise-server), get matching versions from allVersions object
|
|
const relevantVersions = Object.values(allVersions).filter(v => v.plan === plan)
|
|
|
|
if (!relevantVersions.length) {
|
|
throw new Error(`No applicable versions found for ${filepath}. Please double-check the page's \`versions\` frontmatter.`)
|
|
}
|
|
|
|
relevantVersions.forEach(relevantVersion => {
|
|
// special handling for versions with numbered releases
|
|
if (relevantVersion.hasNumberedReleases) {
|
|
if (versionSatisifiesRange(relevantVersion.currentRelease, planValue)) {
|
|
applicableVersions.push(relevantVersion.version)
|
|
}
|
|
} else {
|
|
applicableVersions.push(relevantVersion.version)
|
|
}
|
|
})
|
|
})
|
|
|
|
if (!applicableVersions.length) {
|
|
throw new Error(`No applicable versions found for ${filepath}. Please double-check the page's \`versions\` frontmatter.`)
|
|
}
|
|
|
|
return applicableVersions
|
|
}
|
|
|
|
module.exports = getApplicableVersions
|