Merge branch 'main' into graphql-schema-update

Author: rsese

content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md

@@ -16,6 +16,7 @@ const plans = [
     releases: [latestNonNumberedRelease],
     latestRelease: latestNonNumberedRelease,
     nonEnterpriseDefault: true, // permanent way to refer to this plan if the name changes
+    hasNumberedReleases: false,
     openApiBaseName: 'api.github.com', // used for REST
     miscBaseName: 'dotcom', // used for GraphQL and webhooks
   },
@@ -25,6 +26,7 @@ const plans = [
     shortName: 'ghec',
     releases: [latestNonNumberedRelease],
     latestRelease: latestNonNumberedRelease,
+    hasNumberedReleases: false,
     openApiBaseName: 'api.github.com',
     miscBaseName: 'ghec',
   },
@@ -44,8 +46,11 @@ const plans = [
     shortName: 'ghae',
     releases: [latestNonNumberedRelease],
     latestRelease: latestNonNumberedRelease,
+    hasNumberedReleases: false,
     openApiBaseName: 'github.ae',
     miscBaseName: 'ghae',
+    allowedFrontmatterPattern: '^issue-\\d+?$',
+    allowedInlinePattern: '^ghae-issue-\\d+?$',
   },
 ]
 

content/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections.md

@@ -14,13 +14,6 @@ const layoutNames = [
   'release-notes',
   false,
 ]
-const semverValidRange = semver.validRange
-const semverRange = {
-  type: 'string',
-  conform: semverValidRange,
-  message: 'Must be a valid SemVer range',
-}
-const versionObjs = Object.values(allVersions)
 
 const guideTypes = ['overview', 'quick_start', 'tutorial', 'how_to', 'reference']
 const featureVersions = fs
@@ -246,19 +239,44 @@ const featureVersionsProp = {
   },
 }
 
+const asteriskPattern = /^\*$/
+
 schema.properties.versions = {
   type: ['object', 'string'], // allow a '*' string to indicate all versions
   required: true,
-  properties: versionObjs.reduce((acc, versionObj) => {
-    acc[versionObj.plan] = semverRange
-    acc[versionObj.shortName] = semverRange
+  additionalProperties: false, // don't allow any versions in FM that aren't defined in lib/all-versions
+  properties: Object.values(allVersions).reduce((acc, versionObj) => {
+    acc[versionObj.plan] = getValidProps(versionObj)
+    acc[versionObj.shortName] = getValidProps(versionObj)
     return acc
   }, featureVersionsProp),
 }
 
-// Support 'github-ae': next
-schema.properties.versions.properties['github-ae'] = 'next'
-schema.properties.versions.properties.ghae = 'next'
+function getValidProps(versionObj) {
+  const valid = { type: 'string' }
+
+  // The properties attached to versionObj are defined in lib/all-versions.js.
+
+  // If a version has no numbered releases or exception pattern, the only valid value is '*'.
+  if (!(versionObj.hasNumberedReleases || versionObj.allowedFrontmatterPattern)) {
+    valid.pattern = asteriskPattern
+    valid.message = `Must have a value of '*'`
+  }
+
+  // If a version has an exception pattern, both '*' and the exception pattern are valid.
+  if (versionObj.allowedFrontmatterPattern) {
+    valid.pattern = new RegExp(`${asteriskPattern.source}|${versionObj.allowedFrontmatterPattern}`)
+    valid.message = `Must have a value of '*' or 'issue-###', where ### is an integer`
+  }
+
+  // If a version has numbered releases, any semver range is valid. Note '*' is a valid semver range.
+  if (versionObj.hasNumberedReleases) {
+    valid.conform = semver.validRange
+    valid.message = 'Must be a valid SemVer range'
+  }
+
+  return valid
+}
 
 function frontmatter(markdown, opts = {}) {
   const defaults = {

content/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests.md

@@ -19,7 +19,11 @@ export default function useEnglishHeadings({ englishHeadings }) {
       // get English slug
       const englishSlug = slugger.slug(englishHeading)
       // use English slug for heading ID and link
-      node.properties.id = englishSlug
+      if (englishSlug) {
+        // only use English slug if there is one, otherwise we'll end up with
+        // empty IDs
+        node.properties.id = englishSlug
+      }
     })
   }
 }

data/features/README.md

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:a54b3c6a9d1abdfe9b5cd0464117d26b6ddc99809a843c7c89e5fd9ecd199921
-size 741463
+oid sha256:ed16c36428997cd7d3705f1edf1dc967122e8f8a73e7f67538ada3e092230c95
+size 741390

lib/all-versions.js

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:63ec856eed5675e38b969738a6f2cb2443461f5a389562aa8f6aac4a73ce8e35
-size 1564192
+oid sha256:05687c572244244f212bab3c96d7bd34384231189cce239da4a27af099f10c7f
+size 1564131

lib/frontmatter.js

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:8b965d9439d85120507e7dacc985e1c4fab7c272d8bba61fd78dcc4780c4b0fa
-size 998450
+oid sha256:a74e09658956a04ed2b1ef295901d568c1b0d6f325563b03d796c1acaf0b75ca
+size 997473