Merge branch 'main' into main

ramyaparimi · web-flow · commit e4ad07c6b23d · 2022-03-11T06:58:19.000-06:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -132,6 +132,11 @@ jobs:
       - name: Run build script
         run: npm run build
 
+      - name: Warm possible disk caching
+        env:
+          NODE_ENV: test
+        run: ./script/warm-before-tests.mjs
+
       - name: Run tests
         env:
           DIFF_FILE: get_diff_files.txt
diff --git a/content/actions/learn-github-actions/contexts.md b/content/actions/learn-github-actions/contexts.md
@@ -767,10 +767,14 @@ on:
       deploy_target:
         required: true
         type: string
+      perform_deploy:
+        required: true
+        type: boolean
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
+    if: ${{ inputs.perform_deploy == 'true' }}
     steps:
       - name: Deploy build to target
         run: deploy --build ${{ inputs.build_id }} --target ${{ inputs.deploy_target }}
diff --git a/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md b/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md
@@ -69,7 +69,7 @@ The number of jobs you can run concurrently across all repositories in your user
 
 ## Calculating minute and storage spending
 
-{% data reusables.dotcom_billing.pricing_cal %}
+{% data reusables.dotcom_billing.pricing_calculator.pricing_cal_actions %}
 
 At the end of the month, {% data variables.product.prodname_dotcom %} calculates the cost of minutes and storage used over the amount included in your account.
 
diff --git a/content/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces.md b/content/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces.md
@@ -38,7 +38,7 @@ Your {% data variables.product.prodname_codespaces %} usage shares your account'
 If you purchased {% data variables.product.prodname_enterprise %} through a Microsoft Enterprise Agreement, you can connect your Azure Subscription ID to your enterprise account to enable and pay for {% data variables.product.prodname_codespaces %} usage. For more information, see "[Connecting an Azure subscription to your enterprise](/billing/managing-billing-for-your-github-account/connecting-an-azure-subscription-to-your-enterprise)."
 {% endif %}
 
-{% data reusables.dotcom_billing.pricing_cal %}
+{% data reusables.dotcom_billing.pricing_calculator.pricing_cal_codespaces %}
 
 ### Billing for {% data variables.product.prodname_codespaces %} prebuilds
 
diff --git a/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md b/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md
@@ -51,7 +51,9 @@ Storage usage is shared with build artifacts produced by {% data variables.produ
 
 {% data variables.product.prodname_dotcom %} charges usage to the account that owns the repository where the package is published. If your account's usage surpasses these limits and you have set a spending limit above $0 USD, you will pay $0.25 USD per GB of storage and $0.50 USD per GB of data transfer.
 
-For example, if your organization uses {% data variables.product.prodname_team %}, allows unlimited spending, uses 150GB of storage, and has 50GB of data transfer out during a month, the organization would have overages of 148GB for storage and 40GB for data transfer for that month. The storage overage would cost $0.25 USD per GB or $37 USD. The overage for data transfer would cost $0.50 USD per GB or $20 USD. {% data reusables.dotcom_billing.pricing_cal %}
+For example, if your organization uses {% data variables.product.prodname_team %}, allows unlimited spending, uses 150GB of storage, and has 50GB of data transfer out during a month, the organization would have overages of 148GB for storage and 40GB for data transfer for that month. The storage overage would cost $0.25 USD per GB or $37 USD. The overage for data transfer would cost $0.50 USD per GB or $20 USD. 
+
+{% data reusables.dotcom_billing.pricing_calculator.pricing_cal_packages %}
 
 At the end of the month, {% data variables.product.prodname_dotcom %} rounds your data transfer to the nearest GB.
 
diff --git a/content/code-security/security-overview/about-the-security-overview.md b/content/code-security/security-overview/about-the-security-overview.md
@@ -26,7 +26,7 @@ shortTitle: About security overview
 
 ## About the security overview
 
-You can use the security overview for a high-level view of the security status of your organization or to identify problematic repositories that require intervention. You can view aggregate or repository-specific security information in the security overview. You can also use the security overview to see which which security features are enabled for your repositories and to configure any available security features that are not currently in use.
+You can use the security overview for a high-level view of the security status of your organization or to identify problematic repositories that require intervention. You can view aggregate or repository-specific security information in the security overview. You can also use the security overview to see which security features are enabled for your repositories and to configure any available security features that are not currently in use.
 
 The security overview indicates whether {% ifversion fpt or ghes > 3.1 or ghec %}security{% endif %}{% ifversion ghae %}{% data variables.product.prodname_GH_advanced_security %}{% endif %} features are enabled for repositories owned by your organization and consolidates alerts for each feature.{% ifversion fpt or ghes > 3.1 or ghec %} Security features include {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, as well as {% data variables.product.prodname_dependabot_alerts %}.{% endif %} For more information about {% data variables.product.prodname_GH_advanced_security %} features, see "[About {% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security)."{% ifversion fpt or ghes > 3.1 or ghec %} For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."{% endif %}
 
diff --git a/data/reusables/actions/workflow-dispatch-inputs.md b/data/reusables/actions/workflow-dispatch-inputs.md
@@ -15,10 +15,14 @@ on:
         - info
         - warning
         - debug {% endif %}
+      print_tags:
+        description: 'True to print to STDOUT'
+        required: true {% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5511 %}
+        type: boolean {% endif %}
       tags:
         description: 'Test scenario tags'
-        required: false {% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5511 %}
-        type: boolean
+        required: true {% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5511 %}
+        type: string
       environment:
         description: 'Environment to run tests against'
         type: environment
@@ -27,7 +31,7 @@ on:
 jobs:
   print-tag:
     runs-on: ubuntu-latest
-
+    if: {% raw %} ${{ github.event.inputs.print_tags == 'true' }} {% endraw %}
     steps:
       - name: Print the input tag to STDOUT
         run: echo {% raw %} The tag is ${{ github.event.inputs.tag }} {% endraw %}
diff --git a/data/reusables/actions/workflows/section-run-on-specific-branches-or-tags.md b/data/reusables/actions/workflows/section-run-on-specific-branches-or-tags.md
@@ -5,7 +5,7 @@ Use the `branches` filter when you want to include branch name patterns or when
 
 Use the `tags` filter when you want to include tag name patterns or when you want to both include and exclude tag names patterns. Use the `tags-ignore` filter when you only want to exclude tag name patterns. You cannot use both the `tags` and `tags-ignore` filters for the same event in a workflow.
 
-If you define only `tags`/`tag-ignore` or only `branches`/`branches-ignore`, the workflow won't run for events affecting the undefined Git ref. If you define neither  `tags`/`tag-ignore` or `branches`/`branches-ignore`, the workflow will run for events affecting either branches or tags. If you define both `branches`/`branches-ignore` and [`paths`](#onpushpull_requestpull_request_targetpathspaths-ignore), the workflow will only run when both filters are satisfied.
+If you define only `tags`/`tags-ignore` or only `branches`/`branches-ignore`, the workflow won't run for events affecting the undefined Git ref. If you define neither  `tags`/`tags-ignore` or `branches`/`branches-ignore`, the workflow will run for events affecting either branches or tags. If you define both `branches`/`branches-ignore` and [`paths`](#onpushpull_requestpull_request_targetpathspaths-ignore), the workflow will only run when both filters are satisfied.
 
 The `branches`, `branches-ignore`, `tags`, and `tags-ignore` keywords accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch or tag name. If a name contains any of these characters and you want a literal match, you need to *escape* each of these special characters with `\`. For more information about glob patterns, see the "[Filter pattern cheat sheet](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)."
 
diff --git a/data/reusables/dotcom_billing/pricing_cal.md b/data/reusables/dotcom_billing/pricing_cal.md
diff --git a/data/reusables/dotcom_billing/pricing_calculator/pricing_cal_actions.md b/data/reusables/dotcom_billing/pricing_calculator/pricing_cal_actions.md
@@ -0,0 +1 @@
+To estimate the costs for consumptive services, you can use the {% data variables.product.prodname_dotcom %} [pricing calculator](https://github.com/pricing/calculator?feature=actions).
diff --git a/data/reusables/dotcom_billing/pricing_calculator/pricing_cal_codespaces.md b/data/reusables/dotcom_billing/pricing_calculator/pricing_cal_codespaces.md
@@ -0,0 +1 @@
+To estimate the costs for consumptive services, you can use the {% data variables.product.prodname_dotcom %} [pricing calculator](https://github.com/pricing/calculator?feature=codespaces).
diff --git a/data/reusables/dotcom_billing/pricing_calculator/pricing_cal_packages.md b/data/reusables/dotcom_billing/pricing_calculator/pricing_cal_packages.md
@@ -0,0 +1 @@
+To estimate the costs for consumptive services, you can use the {% data variables.product.prodname_dotcom %} [pricing calculator](https://github.com/pricing/calculator?feature=packages).
diff --git a/lib/site-data.js b/lib/site-data.js
@@ -1,21 +1,48 @@
+import fs from 'fs'
+import os from 'os'
 import path from 'path'
 import flat from 'flat'
 import { get, set } from 'lodash-es'
 import languages from './languages.js'
 import dataDirectory from './data-directory.js'
 import encodeBracketedParentheses from './encode-bracketed-parentheses.js'
 
-const loadSiteDataFromDir = (dir) => ({
-  site: {
-    data: dataDirectory(path.join(dir, 'data'), {
-      preprocess: (dataString) => encodeBracketedParentheses(dataString.trimEnd()),
-      ignorePatterns: [/README\.md$/],
-    }),
-  },
+const TEMP_DIRECTORY = process.env.RUNNER_TEMP || os.tmpdir()
+
+function diskMemoize(prefix, fn) {
+  const useCache = process.env.NODE_ENV !== 'development'
+  return (dir) => {
+    const cacheFileName = `${prefix}.${dir.replace(/[^\w]+/g, '-').toLowerCase() || 'en'}.json`
+    if (useCache) {
+      try {
+        return JSON.parse(fs.readFileSync(cacheFileName, 'utf-8'))
+      } catch (err) {
+        if (!(err.code === 'ENOENT' || err instanceof SyntaxError)) throw err
+      }
+    }
+
+    const result = fn(dir)
+    if (useCache) {
+      fs.writeFileSync(cacheFileName, JSON.stringify(result), 'utf-8')
+      console.log(`Disk-cache miss on ${cacheFileName}`, new Date())
+    }
+    return result
+  }
+}
+
+const loadSiteDataFromDir = diskMemoize(path.join(TEMP_DIRECTORY, 'docs-site-data'), (dir) => {
+  return {
+    site: {
+      data: dataDirectory(path.join(dir, 'data'), {
+        preprocess: (dataString) => encodeBracketedParentheses(dataString.trimEnd()),
+        ignorePatterns: [/README\.md$/],
+      }),
+    },
+  }
 })
 
 export default function loadSiteData() {
-  // load english site data
+  // load English site data
   const siteData = {
     en: loadSiteDataFromDir(languages.en.dir),
   }
diff --git a/package.json b/package.json
@@ -210,7 +210,7 @@
     "translation-check": "start-server-and-test translation-check-server 4002 translation-check-test",
     "translation-check-server": "cross-env NODE_ENV=test PORT=4002 node server.mjs",
     "translation-check-test": "script/i18n/test-html-pages.js",
-    "test": "cross-env NODE_OPTIONS='--max_old_space_size=8192 --experimental-vm-modules' jest --logHeapUsage",
+    "test": "cross-env NODE_OPTIONS='--max_old_space_size=4096 --experimental-vm-modules' jest --logHeapUsage",
     "test-watch": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --watch --notify --notifyMode=change --coverage",
     "tsc": "tsc --noEmit"
   },
diff --git a/script/warm-before-tests.mjs b/script/warm-before-tests.mjs
@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+
+// [start-readme]
+//
+// It runs the warmServer() function because that function can do things
+// like writing to disk as a caching mechanism.
+// When jest runs tests, it starts multiple concurrent processes,
+// even if it runs it serially (`--runInBand`) so it's highly likely
+// that two concurrent processes both attempt to writing to
+// the same exact file. By running this script before anything
+// begins, we can be certain that files that should have been created
+// are created.
+//
+// [end-readme]
+
+import warmServer from '../lib/warm-server.js'
+
+main()
+
+async function main() {
+  await warmServer()
+}
diff --git a/tests/content/category-pages.js b/tests/content/category-pages.js
@@ -17,13 +17,7 @@ const slugger = new GithubSlugger()
 const contentDir = path.join(__dirname, '../../content')
 
 describe('category pages', () => {
-  let siteData
-
-  beforeAll(async () => {
-    // Load the English site data
-    const allSiteData = await loadSiteData()
-    siteData = allSiteData.en.site
-  })
+  const siteData = loadSiteData().en.site
 
   const walkOptions = {
     globs: ['*/index.md', 'enterprise/*/index.md'],
diff --git a/tests/content/glossary.js b/tests/content/glossary.js
@@ -1,10 +1,7 @@
 import loadSiteData from '../../lib/site-data.js'
 
 describe('glossaries', () => {
-  let glossaries
-  beforeAll(async () => {
-    glossaries = (await loadSiteData()).en.site.data.glossaries
-  })
+  const glossaries = loadSiteData().en.site.data.glossaries
 
   test('are broken into external, internal, and candidates', async () => {
     const keys = Object.keys(glossaries)
@@ -41,7 +38,7 @@ describe('glossaries', () => {
   })
 
   test('non-English external glossary is in correct order', async () => {
-    const vals = (await loadSiteData()).ja.site.data.glossaries.external
+    const vals = loadSiteData().ja.site.data.glossaries.external
     vals.forEach((val, i) => {
       expect(val.term.localeCompare(vals[i + 1], 'ja')).toBeGreaterThan(0)
     })
diff --git a/tests/content/site-data-references.js b/tests/content/site-data-references.js
@@ -11,17 +11,12 @@ import { jest } from '@jest/globals'
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
 
+const siteData = loadSiteData()
+const pages = (await loadPages()).filter((page) => page.languageCode === 'en')
+
 describe('data references', () => {
   jest.setTimeout(60 * 1000)
 
-  let data, pages
-
-  beforeAll(async () => {
-    data = await loadSiteData()
-    pages = await loadPages()
-    pages = pages.filter((page) => page.languageCode === 'en')
-  })
-
   test('every data reference found in English content files is defined and has a value', () => {
     let errors = []
     expect(pages.length).toBeGreaterThan(0)
@@ -30,7 +25,7 @@ describe('data references', () => {
       const file = path.join('content', page.relativePath)
       const pageRefs = getDataReferences(page.markdown)
       pageRefs.forEach((key) => {
-        const value = get(data.en, key)
+        const value = get(siteData.en, key)
         if (typeof value !== 'string') errors.push({ key, value, file })
       })
     })
@@ -50,7 +45,7 @@ describe('data references', () => {
         const { data: metadata } = frontmatter(fileContents, { filepath: page.fullPath })
         const metadataRefs = getDataReferences(JSON.stringify(metadata))
         metadataRefs.forEach((key) => {
-          const value = get(data.en, key)
+          const value = get(siteData.en, key)
           if (typeof value !== 'string') errors.push({ key, value, metadataFile })
         })
       })
@@ -62,7 +57,7 @@ describe('data references', () => {
 
   test('every data reference found in English reusable files is defined and has a value', async () => {
     let errors = []
-    const allReusables = data.en.site.data.reusables
+    const allReusables = siteData.en.site.data.reusables
     const reusables = Object.values(allReusables)
     expect(reusables.length).toBeGreaterThan(0)
 
@@ -78,7 +73,7 @@ describe('data references', () => {
         const reusableRefs = getDataReferences(JSON.stringify(reusablesPerFile))
 
         reusableRefs.forEach((key) => {
-          const value = get(data.en, key)
+          const value = get(siteData.en, key)
           if (typeof value !== 'string') errors.push({ key, value, reusableFile })
         })
       })
@@ -90,7 +85,7 @@ describe('data references', () => {
 
   test('every data reference found in English variable files is defined and has a value', async () => {
     let errors = []
-    const allVariables = data.en.site.data.variables
+    const allVariables = siteData.en.site.data.variables
     const variables = Object.values(allVariables)
     expect(variables.length).toBeGreaterThan(0)
 
@@ -106,7 +101,7 @@ describe('data references', () => {
         const variableRefs = getDataReferences(JSON.stringify(variablesPerFile))
 
         variableRefs.forEach((key) => {
-          const value = get(data.en, key)
+          const value = get(siteData.en, key)
           if (typeof value !== 'string') errors.push({ key, value, variableFile })
         })
       })
diff --git a/tests/content/site-data.js b/tests/content/site-data.js
@@ -1,21 +1,17 @@
 import { fileURLToPath } from 'url'
 import path from 'path'
-import fs from 'fs'
 import { get, isPlainObject, has } from 'lodash-es'
 import flat from 'flat'
+import walkSync from 'walk-sync'
 import { ParseError } from 'liquidjs'
 import loadSiteData from '../../lib/site-data.js'
 import patterns from '../../lib/patterns.js'
 import { liquid } from '../../lib/render-content/index.js'
-import walkSync from 'walk-sync'
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
 
 describe('siteData module (English)', () => {
-  let data
-  beforeAll(async () => {
-    data = await loadSiteData()
-  })
+  const data = loadSiteData()
 
   test('makes an object', async () => {
     expect(isPlainObject(data)).toBe(true)
@@ -49,21 +45,6 @@ describe('siteData module (English)', () => {
     expect(reusable.includes('任意のページの左上で')).toBe(true)
   })
 
-  test('backfills missing translated site data with English values', async () => {
-    const newFile = path.join(__dirname, '../../data/newfile.yml')
-    fs.writeFileSync(newFile, 'newvalue: bar')
-    try {
-      const data = loadSiteData()
-      expect(get(data, 'en.site.data.newfile.newvalue')).toEqual('bar')
-      expect(get(data, 'ja.site.data.newfile.newvalue')).toEqual('bar')
-    } finally {
-      // If an error is thrown above, it will still "bubble up"
-      // to the jest reporter, but we still always need to clean up
-      // the temporary file.
-      fs.unlinkSync(newFile)
-    }
-  })
-
   test('all Liquid tags are valid', async () => {
     const dataMap = flat(data)
     for (const key in dataMap) {
diff --git a/tests/unit/liquid.js b/tests/unit/liquid.js
@@ -191,11 +191,7 @@ describe('liquid template parser', () => {
     // Create a fake req so we can test the feature versions middleware
     const req = { language: 'en', query: {} }
 
-    let siteData
-    beforeAll(async () => {
-      const allSiteData = await loadSiteData()
-      siteData = allSiteData.en.site
-    })
+    const siteData = loadSiteData().en.site
 
     test('does not render in FPT because feature is not available in FPT', async () => {
       req.context = {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+To estimate the costs for consumptive services, you can use the {% data variables.product.prodname_dotcom %} [pricing calculator](https://github.com/pricing/calculator?feature=actions).`