jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-23 21:07:12 -05:00
Code Issues Projects Releases Wiki Activity

Merge branch 'main' into revert-20087-revert-20069-fix-homepage-versions-dropdown

Browse Source
This commit is contained in:
Sarah Schneider
2021-06-24 12:40:17 -04:00
committed by GitHub
parent 8cb3f02fd7 a73a8dca24
commit cffafaf748
2013 changed files with 7040 additions and 6846 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
tests/content/site-data.js
View File

@@ -14,7 +14,7 @@ describe('siteData module (English)', () => {
done()
})
test('exports an object', async () => {
test('makes an object', async () => {
expect(isPlainObject(data)).toBe(true)
})

17
tests/helpers/get-ifversion-conditionals.js
View File

@@ -1,17 +0,0 @@
const renderContent = require('../../lib/render-content')
module.exports = function getIfversionConditionals (str) {
const conditionals = []
renderContent.liquid.parse(str)
.filter(block => block.name === 'ifversion')
// block.impl.branches is the only way to get an array of ifs and elsifs.
.map(block => block.impl.branches.map(branch => branch.cond))
.forEach(block => {
block.forEach(branch => {
conditionals.push(branch)
})
})
return conditionals
}

2
tests/helpers/supertest.js
View File

@@ -1,4 +1,4 @@
// This file exports an object with utility functions for re-use in
// This file makes an object with utility functions for re-use in
// multiple test files
const cheerio = require('cheerio')

74
tests/linting/lint-files.js
View File

@@ -18,10 +18,11 @@ const renderContent = require('../../lib/render-content')
const getApplicableVersions = require('../../lib/get-applicable-versions')
const { execSync } = require('child_process')
const allVersions = require('../../lib/all-versions')
const { supported } = require('../../lib/enterprise-server-releases')
const getIfversionConditionals = require('../helpers/get-ifversion-conditionals')
const { supported, next } = require('../../lib/enterprise-server-releases')
const getLiquidConditionals = require('../../script/helpers/get-liquid-conditionals')
const enterpriseServerVersions = Object.keys(allVersions).filter(v => v.startsWith('enterprise-server@'))
const versionShortNames = Object.values(allVersions).map(v => v.shortName)
const versionKeywords = versionShortNames.concat(['currentVersion', 'enterpriseServerReleases'])
const allowedVersionOperators = require('../../lib/liquid-tags/ifversion-supported-operators')
const rootDir = path.join(__dirname, '../..')
@@ -317,7 +318,7 @@ describe('lint markdown content', () => {
'%s',
(markdownRelPath, markdownAbsPath) => {
let content, ast, links, yamlScheduledWorkflows, isHidden, isEarlyAccess, isSitePolicy, frontmatterErrors, frontmatterData,
ifversionConditionals
ifversionConditionals, ifConditionals
beforeAll(async () => {
const fileContents = await readFileAsync(markdownAbsPath, 'utf8')
@@ -353,8 +354,11 @@ describe('lint markdown content', () => {
.flat()
.map(schedule => schedule.cron)
ifversionConditionals = getIfversionConditionals(data)
.concat(getIfversionConditionals(bodyContent))
ifversionConditionals = getLiquidConditionals(data, ['ifversion', 'elsif'])
.concat(getLiquidConditionals(bodyContent, ['ifversion', 'elsif']))
ifConditionals = getLiquidConditionals(data, 'if')
.concat(getLiquidConditionals(bodyContent, 'if'))
})
// We need to support some non-Early Access hidden docs in Site Policy
@@ -369,6 +373,13 @@ describe('lint markdown content', () => {
expect(errors.length, errors.join('\n')).toBe(0)
})
test('ifversion, not if, is used for versioning in markdown', async () => {
const ifsForVersioning = ifConditionals.filter(cond => versionKeywords.some(keyword => cond.includes(keyword)))
const errorMessage = `Found ${ifsForVersioning.length} "if" conditionals used for versioning! Use "ifversion" instead.
${ifsForVersioning.join('\n')}`
expect(ifsForVersioning.length, errorMessage).toBe(0)
})
test('relative URLs must start with "/"', async () => {
const matches = links.filter(link => {
if (
@@ -544,15 +555,17 @@ describe('lint yaml content', () => {
describe.each(ymlToLint)(
'%s',
(yamlRelPath, yamlAbsPath) => {
let dictionary, isEarlyAccess, ifversionConditionals
let dictionary, isEarlyAccess, ifversionConditionals, ifConditionals
beforeAll(async () => {
const fileContents = await readFileAsync(yamlAbsPath, 'utf8')
ifversionConditionals = getIfversionConditionals(fileContents)
dictionary = yaml.load(fileContents, { filename: yamlRelPath })
isEarlyAccess = yamlRelPath.split('/').includes('early-access')
ifversionConditionals = getLiquidConditionals(fileContents, ['ifversion', 'elsif'])
ifConditionals = getLiquidConditionals(fileContents, 'if')
})
test('ifversion conditionals are valid in yaml', async () => {
@@ -560,6 +573,13 @@ describe('lint yaml content', () => {
expect(errors.length, errors.join('\n')).toBe(0)
})
test('ifversion, not if, is used for versioning in markdown', async () => {
const ifsForVersioning = ifConditionals.filter(cond => versionKeywords.some(keyword => cond.includes(keyword)))
const errorMessage = `Found ${ifsForVersioning.length} "if" conditionals used for versioning! Use "ifversion" instead.
${ifsForVersioning.join('\n')}`
expect(ifsForVersioning.length, errorMessage).toBe(0)
})
test('relative URLs must start with "/"', async () => {
const matches = []
@@ -871,9 +891,6 @@ describe('lint learning tracks', () => {
})
it('has one and only one featured track per supported version', async () => {
const featuredTracks = {}
const context = { enterpriseServerVersions }
// Use the YAML filename to determine which product this refers to, and then peek
// inside the product TOC frontmatter to see which versions the product is available in.
const product = path.posix.basename(yamlRelPath, '.yml')
@@ -882,21 +899,26 @@ describe('lint learning tracks', () => {
const { data } = frontmatter(productContents)
const productVersions = getApplicableVersions(data.versions, productTocPath)
const featuredTracks = {}
const context = { enterpriseServerVersions }
// For each of the product's versions, render the learning track data and look for a featured track.
await Promise.all(productVersions.map(async (version) => {
const featuredTracksPerVersion = (await Promise.all(Object.values(dictionary).map(async (entry) => {
const featuredTracksPerVersion = []
for (const entry of Object.values(dictionary)) {
if (!entry.featured_track) return
context.currentVersion = version
context[allVersions[version].shortName] = true
const isFeaturedLink = typeof entry.featured_track === 'boolean' || (await renderContent(entry.featured_track, context, { textOnly: true, encodeEntities: true }) === 'true')
return isFeaturedLink
})))
.filter(Boolean)
featuredTracksPerVersion.push(isFeaturedLink)
}
featuredTracks[version] = featuredTracksPerVersion.length
}))
Object.entries(featuredTracks).forEach(([version, numOfFeaturedTracks]) => {
const errorMessage = `Expected one featured learning track for ${version} in ${yamlAbsPath}`
const errorMessage = `Expected 1 featured learning track but found ${numOfFeaturedTracks} for ${version} in ${yamlAbsPath}`
expect(numOfFeaturedTracks, errorMessage).toBe(1)
})
})
@@ -994,15 +1016,17 @@ function validateIfversionConditionals (conds) {
// the second item is a supported operator, and the third is a supported GHES release.
if (strParts.length === 3) {
const [version, operator, release] = strParts
const isGhes = version === 'ghes'
const isSupportedOperator = allowedVersionOperators.includes(operator)
const isSupportedRelease = supported.includes(release)
const isValid = isGhes && isSupportedOperator && isSupportedRelease
const errorMessage = str === cond
? `"${str}" is not a valid operation`
: `"${str}" is not a valid operation inside "${cond}"`
if (!isValid) {
errors.push(errorMessage)
if (version !== 'ghes') {
errors.push(`Found "${version}" inside "${cond}" with a "${operator}" operator; expected "ghes"`)
}
if (!allowedVersionOperators.includes(operator)) {
errors.push(`Found a "${operator}" operator inside "${cond}", but "${operator}" is not supported`)
}
// NOTE: The following will throw errors when we deprecate a version until we run the script to remove the
// deprecated versioning. If we deprecate a version before we have a working version of that script,
// we can comment out this part of the test temporarily and re-enable it once the script is ready.
if (!(supported.includes(release) || release === next)) {
errors.push(`Found ${release} inside "${cond}", but ${release} is not a supported GHES release`)
}
}
})

2
tests/unit/openapi-schema.js
View File

@@ -9,7 +9,7 @@ const schemasPath = path.join(__dirname, '../../lib/rest/static/decorated')
const nonEnterpriseDefaultVersionSchema = operations[nonEnterpriseDefaultVersion]
describe('OpenAPI schema validation', () => {
test('exports an object', () => {
test('makes an object', () => {
expect(isPlainObject(operations)).toBe(true)
})

13
tests/unit/page.js
View File

@@ -491,15 +491,8 @@ describe('Page class', () => {
// There are none of these in the content at this time!
})
// Note this test will go out of date when we deprecate 2.20
test('pages that apply to newer enterprise versions', async () => {
const page = await Page.init({
relativePath: 'github/administering-a-repository/releasing-projects-on-github/comparing-releases.md',
basePath: path.join(__dirname, '../../content'),
languageCode: 'en'
})
expect(nonEnterpriseDefaultPlan in page.versions).toBe(true)
expect(page.versions['enterprise-server']).toBe('>=2.21')
test.skip('pages that apply to newer enterprise versions', async () => {
// There are none of these in the content at this time!
})
test('pages that use short names in versions frontmatter', async () => {
@@ -533,7 +526,7 @@ describe('Page class', () => {
})
expect(nonEnterpriseDefaultPlan in page.versions).toBe(false)
expect(page.versions['enterprise-server']).toBe('*')
expect(page.versions.ghes).toBe('*')
})
test('feature versions frontmatter', async () => {