Merge branch 'main' into all-contributors/add-jeffmcaffer

Author: janiceilene

README.md

@@ -1,6 +1,6 @@
 ## GitHub Docs <!-- omit in toc -->
 
-This repository contains the documentation website code and Markdown source files for docs.github.com.
+This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com).
 
 GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.
 

content/packages/publishing-and-managing-packages/about-github-packages.md

@@ -185,7 +185,7 @@ For more information, see:
 
 ### Managing packages
 
-You can a delete a version of a private package on {% data variables.product.product_name %} or using the GraphQL API. When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting a package](/packages/publishing-and-managing-packages/deleting-a-package)" and "[Forming calls with GraphQL](/v4/guides/forming-calls/)."
+You can delete a version of a private package on {% data variables.product.product_name %} or using the GraphQL API. When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting a package](/packages/publishing-and-managing-packages/deleting-a-package)" and "[Forming calls with GraphQL](/v4/guides/forming-calls/)."
 
 You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)."
 

content/rest/overview/endpoints-available-for-github-apps.md

@@ -11,7 +11,7 @@ versions:
 
 You must use an installation access token to access endpoints using your {% data variables.product.prodname_github_app %}. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)."
 
-{% for thing in rest.operationsEnabledForApps[currentVersion] %}
+{% for thing in rest.operationsEnabledForGitHubApps[currentVersion] %}
 {% assign category = thing[0] %}
 {% assign operations = thing[1] %}
 {% if operations.size > 0 %}

lib/rest.js

@@ -1,9 +1,8 @@
 const { chain, get, union, flatten, groupBy } = require('lodash')
 const { supported } = require('./enterprise-server-releases')
 const operations = require('@github/rest-api-operations')
-// TODO need to update this to the new versions in coordination with openAPI
-const { oldVersions } = require('./old-versions-utils')
-const allVersions = oldVersions
+const { getOldVersionFromNewVersion } = require('./old-versions-utils')
+const allVersions = Object.keys(require('./all-versions'))
 
 // This list is generated for use in the tests,
 // so we can verify that the names of the markdown files
@@ -18,16 +17,16 @@ const categories = union(dotcomCategories, enterpriseCategories)
 
 // Attach convenience properties to each operation that can't easily be created in Liquid
 allVersions.forEach(currentVersion => {
-  operations[currentVersion].forEach(operation => {
+  operations[getOldVersionFromNewVersion(currentVersion)].forEach(operation => {
     operation.hasRequiredPreviews = get(operation, 'x-github.previews', []).some(preview => preview.required)
   })
 })
 
-// This is a collection of operations that have `enabledForApps = true`
+// This is a collection of operations that have `enabledForGitHubApps = true`
 // It's grouped by resource title to make rendering easier
-const operationsEnabledForApps = allVersions.reduce((acc, currentVersion) => {
-  acc[currentVersion] = chain(operations[currentVersion] || [])
-    .filter(operation => operation['x-github'].enabledForApps)
+const operationsEnabledForGitHubApps = allVersions.reduce((acc, currentVersion) => {
+  acc[currentVersion] = chain(operations[getOldVersionFromNewVersion(currentVersion)] || [])
+    .filter(operation => operation['x-github'].enabledForGitHubApps)
     .orderBy('category')
     .value()
   acc[currentVersion] = groupBy(acc[currentVersion], 'category')
@@ -37,5 +36,5 @@ const operationsEnabledForApps = allVersions.reduce((acc, currentVersion) => {
 module.exports = {
   categories,
   operations,
-  operationsEnabledForApps
+  operationsEnabledForGitHubApps
 }

tests/rendering/rest.js

@@ -40,6 +40,12 @@ describe('REST references docs', () => {
     expect(operation.description).toContain('GitHub Enterprise')
   })
 
+  test('loads operations enabled for GitHub Apps', async () => {
+    const operations = await getJSON('/en/free-pro-team@latest/rest/overview/endpoints-available-for-github-apps?json=rest.operationsEnabledForGitHubApps')
+    expect(operations['free-pro-team@latest'].actions.length).toBeGreaterThan(0)
+    expect(operations['enterprise-server@2.22'].actions.length).toBeGreaterThan(0)
+  })
+
   test('no wrongly detected AppleScript syntax highlighting in schema data', async () => {
     const { operations } = require('../../lib/rest')
     expect(JSON.stringify(operations).includes('hljs language-applescript')).toBe(false)