Create add-ghec-to-fpt.js (github#19610)

* Create add-ghec-to-fpt.js

* Update add-ghec-to-fpt.js

* Update add-ghec-to-fpt.js

* Fix regexp

* Update script/enterprise-server-releases/add-ghec-to-fpt.js

Co-authored-by: James M. Greene <[email protected]>

* Update script/enterprise-server-releases/add-ghec-to-fpt.js

Co-authored-by: James M. Greene <[email protected]>

* Rename github-ec to enterprise-cloud

* Update script/enterprise-server-releases/add-ghec-to-fpt.js

Co-authored-by: James M. Greene <[email protected]>

* Apply suggestions from code review

Co-authored-by: Rachael Sewell <[email protected]>

Co-authored-by: James M. Greene <[email protected]>
Co-authored-by: Rachael Sewell <[email protected]>

Author: 3 people

script/enterprise-server-releases/add-ghec-to-fpt.js

@@ -0,0 +1,143 @@
+#!/usr/bin/env node
+
+// [start-readme]
+//
+// Run this script to add versions frontmatter and Liquid conditionals for
+// GitHub Enterprise Cloud, based on anything currently versioned for the specified release
+// of free-pro-team.
+//
+// [end-readme]
+
+const fs = require('fs')
+const path = require('path')
+const walk = require('walk-sync')
+const program = require('commander')
+const frontmatter = require('../../lib/read-frontmatter')
+const contentPath = path.join(process.cwd(), 'content')
+const dataPath = path.join(process.cwd(), 'data')
+
+program
+  .description('Add versions frontmatter and Liquid conditionals for GitHub EC based on FPT. Runs on all content by default.')
+  .option('-p, --products [OPTIONAL PRODUCT_IDS...]', 'Optional list of space-separated product IDs. Example: admin github developers')
+  .parse(process.argv)
+
+const { products } = program.opts()
+
+console.log('✅ Adding EC versioning based on FPT latest versioning')
+
+if (products) {
+  console.log(`✅ Running on the following products: ${products}`)
+} else {
+  console.log('✅ Running on all products')
+}
+
+console.log('✅ Running on English content and data\n')
+
+// The new conditional to add
+const githubECConditional = 'currentVersion == "enterprise-cloud@latest"'
+
+// Match: currentVersion == "free-pro-team@latest"
+const fptConditionalRegex = /currentVersion == "free-pro-team@latest"/
+
+console.log('Working...\n')
+
+const englishContentFiles = walkContent(contentPath)
+const englishDataFiles = walkData(dataPath)
+
+function walkContent (dirPath) {
+  const productArray = products || ['']
+  return productArray.map(product => {
+    dirPath = path.join(contentPath, product)
+    return walk(dirPath, { includeBasePath: true, directories: false })
+      .filter(file => file.includes('/content/'))
+      .filter(file => file.endsWith('.md'))
+      .filter(file => !file.endsWith('README.md'))
+  }).flat()
+}
+
+function walkData (dirPath) {
+  return walk(dirPath, { includeBasePath: true, directories: false })
+    .filter(file => file.includes('/data/reusables') || file.includes('/data/variables'))
+    .filter(file => !file.endsWith('README.md'))
+}
+
+const allContentFiles = englishContentFiles
+const allDataFiles = englishDataFiles
+
+// Update the data files
+allDataFiles
+  .forEach(file => {
+    const dataContent = fs.readFileSync(file, 'utf8')
+
+    const conditionalsToUpdate = getConditionalsToUpdate(dataContent)
+    if (!conditionalsToUpdate.length) return
+
+    // Update Liquid in data files
+    const newDataContent = updateLiquid(conditionalsToUpdate, dataContent)
+
+    fs.writeFileSync(file, newDataContent)
+  })
+
+// Update the content files
+allContentFiles
+  .forEach(file => {
+    const { data, content } = frontmatter(fs.readFileSync(file, 'utf8'))
+
+    // Return early if the current page frontmatter does not apply to either GHEC or the given fpt release
+    if (!(data.versions['free-pro-team'])) return
+
+    const conditionalsToUpdate = getConditionalsToUpdate(content)
+    if (!conditionalsToUpdate.length) return
+
+    // Update Liquid in content files
+    const newContent = updateLiquid(conditionalsToUpdate, content)
+
+    // Add frontmatter version
+    data.versions['enterprise-cloud'] = '*'
+
+    // Update Liquid in frontmatter props
+    Object.keys(data)
+      .filter(key => typeof data[key] === 'string')
+      .forEach(key => {
+        const conditionalsToUpdate = getConditionalsToUpdate(data[key])
+        if (!conditionalsToUpdate.length) return
+        data[key] = updateLiquid(conditionalsToUpdate, data[key])
+      })
+
+    fs.writeFileSync(file, frontmatter.stringify(newContent, data, { lineWidth: 10000 }))
+  })
+
+function getConditionalsToUpdate (content) {
+  const allConditionals = content.match(/{% if .+?%}/g)
+
+  return (allConditionals || [])
+    .filter(conditional => !conditional.includes('enterprise-cloud'))
+    .filter(conditional => conditional.includes('free-pro-team'))
+}
+
+function updateLiquid (conditionalsToUpdate, content) {
+  let newContent = content
+
+  conditionalsToUpdate.forEach(conditional => {
+    let newConditional = conditional
+
+    const fptMatch = conditional.match(fptConditionalRegex)
+
+    if (!fptMatch) {
+      console.error(conditional)
+      return
+    }
+
+    // First do the replacement within the conditional
+    // Old: {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
+    // New: {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" or currentVersion == "enterprise-cloud@latest" %}
+    newConditional = newConditional.replace(fptMatch[0], `${fptMatch[0]} or ${githubECConditional}`)
+
+    // Then replace all instances of the conditional in the content
+    newContent = newContent.replace(conditional, newConditional)
+  })
+
+  return newContent
+}
+
+console.log('Done!')