Remove support versions: * (#40548)

Author: gracepark

content/get-started/learning-about-github/about-versions-of-github-docs.md

@@ -1,7 +1,11 @@
 ---
 title: About versions of GitHub Docs
 intro: 'You can read documentation that reflects the {% data variables.product.company_short %} product you''re currently using.'
-versions: '*'
+versions:
+  fpt: '*'
+  ghes: '*'
+  ghae: '*'
+  ghec: '*'
 shortTitle: Docs versions
 ---
 

content/index.md

@@ -42,7 +42,11 @@ redirect_from:
   - /github/enforcing-best-practices-with-github-policies/sharing
   - /early-access/github/enforcing-best-practices-with-github-policies/syntax
   - /github/enforcing-best-practices-with-github-policies/syntax
-versions: '*'
+versions:
+  fpt: '*'
+  ghes: '*'
+  ghae: '*'
+  ghec: '*'
 children:
   - search
   - get-started

lib/get-applicable-versions.js

@@ -14,9 +14,11 @@ function getApplicableVersions(versionsObj, filepath, opts = {}) {
     throw new Error(`No \`versions\` frontmatter found in ${filepath}`)
   }
 
-  // all versions are applicable!
+  // Catch an old frontmatter value that was used to indicate an article was available in all versions.
   if (versionsObj === '*') {
-    return allVersionKeys
+    throw new Error(
+      `${filepath} contains the invalid versions frontmatter: *. Please explicitly list out all the versions that apply to this article.`,
+    )
   }
 
   if (!featureData) {

script/update-tocs.js

@@ -3,7 +3,7 @@
 // [start-readme]
 //
 // This script creates or updates an index.md file for a given directory.
-// It will add `children` frontmatter in alphabetical order and create versions: '*'.
+// It will add `children` frontmatter in alphabetical order and create versions: { fpt: '*', ghes: '*', ghae: '*', ghec: '*' }.
 // It also prints a helpful message to update those values manually if needed.
 //
 // [end-readme]
@@ -52,7 +52,7 @@ function updateOrCreateToc(directory) {
     content = ''
     data = {
       title: sentenceCase(path.basename(directory)), // fake the title of the index.md from the directory name
-      versions: '*', // default to all versions
+      versions: { fpt: '*', ghes: '*', ghae: '*', ghec: '*' }, // default to all versions
     }
   }
 

tests/fixtures/article-with-redirect-from-string.md

@@ -1,5 +1,9 @@
 ---
 title: Article with redirect_from string
-versions: '*'
+versions:
+  fpt: '*'
+  ghes: '*'
+  ghae: '*'
+  ghec: '*'
 redirect_from: /redirect-string
 ---

tests/fixtures/content/early-access/index.md

@@ -1,7 +1,11 @@
 ---
 title: Early Access documentation
 hidden: true
-versions: '*'
+versions:
+  fpt: '*'
+  ghes: '*'
+  ghae: '*'
+  ghec: '*'
 children:
   - /secrets
 ---

tests/fixtures/content/early-access/secrets/deeper/index.md

@@ -1,6 +1,10 @@
 ---
 title: Deeper secrets
-versions: '*'
+versions:
+  fpt: '*'
+  ghes: '*'
+  ghae: '*'
+  ghec: '*'
 hidden: true
 children:
   - /mariana-trench

tests/fixtures/content/early-access/secrets/deeper/mariana-trench.md

@@ -1,6 +1,10 @@
 ---
 title: Mariana Trench
-versions: '*'
+versions:
+  fpt: '*'
+  ghes: '*'
+  ghae: '*'
+  ghec: '*'
 hidden: true
 ---
 

tests/fixtures/content/early-access/secrets/index.md

@@ -1,6 +1,10 @@
 ---
 title: GitHub Secrets
-versions: '*'
+versions:
+  fpt: '*'
+  ghes: '*'
+  ghae: '*'
+  ghec: '*'
 hidden: true
 children:
   - /early-days

tests/fixtures/content/index.md

@@ -12,7 +12,11 @@ featuredLinks:
     - /actions/category/map-topic
 redirect_from:
   - /olden-days
-versions: '*'
+versions:
+  fpt: '*'
+  ghes: '*'
+  ghae: '*'
+  ghec: '*'
 children:
   # The list of childen in the fixtures has to be the same names
   # as we use in the real content. It can have fewer but can't include

tests/fixtures/liquid-tags/bad-data-variable.md

@@ -1,6 +1,10 @@
 ---
 title: Sample page
-versions: '*'
+versions:
+  fpt: '*'
+  ghes: '*'
+  ghae: '*'
+  ghec: '*'
 ---
 
 {% data foo.bar.tipu %}

tests/fixtures/liquid-tags/good-data-variable.md

@@ -1,6 +1,10 @@
 ---
 title: Good sample page
-versions: '*'
+versions:
+  fpt: '*'
+  ghes: '*'
+  ghae: '*'
+  ghec: '*'
 ---
 
 {% data variables.stuff.foo %}

tests/unit/get-applicable-versions.js

@@ -35,10 +35,18 @@ describe('Versions frontmatter', () => {
 })
 
 describe('general cases', () => {
-  test('simply a wildcard', () => {
-    const applicableVersions = getApplicableVersions('*')
-    expect(applicableVersions.length).toBe(Object.keys(allVersions).length)
-    expect(Object.keys(allVersions).every((v) => applicableVersions.includes(v)))
+  test('wildcard * is no longer used', () => {
+    // docs engineering 3110
+    expect.assertions(2)
+    try {
+      getApplicableVersions('*')
+    } catch (e) {
+      expect(e).toBeInstanceOf(Error)
+      expect(e).toHaveProperty(
+        'message',
+        'undefined contains the invalid versions frontmatter: *. Please explicitly list out all the versions that apply to this article.',
+      )
+    }
   })
   test("using 'features'", () => {
     const possibleFeatures = fs

tests/unit/page.js

@@ -341,7 +341,7 @@ describe('Page class', () => {
         basePath: path.join(__dirname, '../../content'),
         languageCode: 'en',
       })
-      expect(page.versions).toBe('*')
+      expect(page.versions).toEqual({ fpt: '*', ghae: '*', ghec: '*', ghes: '*' })
     })
 
     test('enterprise admin index page', async () => {