Are you looking for something? Here is all of the GitHub Docs history in one single commit. Enjoy! 🎉
78 lines
2.9 KiB
JavaScript
78 lines
2.9 KiB
JavaScript
const allVersions = require('./all-versions')
|
|
const versionSatisifiesRange = require('./version-satisfies-range')
|
|
|
|
let nonEnterpriseProductVersions
|
|
if (!process.env.FEATURE_NEW_VERSIONS) {
|
|
nonEnterpriseProductVersions = Object.keys(require('./frontmatter').schema.properties.productVersions.properties)
|
|
.filter(prop => prop !== 'enterprise')
|
|
}
|
|
|
|
// 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}`)
|
|
}
|
|
|
|
if (!process.env.FEATURE_NEW_VERSIONS) {
|
|
const applicableVersions = allVersions.filter(version => {
|
|
if (version === 'dotcom') {
|
|
// find any non-Enterprise product versions that apply
|
|
return nonEnterpriseProductVersions.some(version => version in frontmatterVersions)
|
|
} else {
|
|
return versionSatisifiesRange(version, frontmatterVersions.enterprise)
|
|
}
|
|
})
|
|
|
|
if (!applicableVersions.length) {
|
|
throw new Error(`No applicable product versions found for file ${filepath}. Please double-check the page's \`productVersions\` frontmatter.`)
|
|
}
|
|
|
|
return applicableVersions
|
|
}
|
|
|
|
if (process.env.FEATURE_NEW_VERSIONS) {
|
|
// 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
|