Merge branch 'main' into patch-1

content/actions/managing-workflow-runs/reviewing-deployments.md

@@ -13,7 +13,7 @@ versions:
 
 Jobs that reference an environment configured with required reviewers will wait for an approval before starting. While a job is awaiting approval, it has a status of "Waiting". If a job is not approved within 30 days, the workflow run will be automatically canceled.
 
-For more information about environments and required approvals, see "[Environments](/actions/reference/environments)."
+For more information about environments and required approvals, see "[Environments](/actions/reference/environments)." For information about how to review deployments with the REST API, see "[Workflow Runs](/rest/reference/actions#workflow-runs)."
 
 ### Approving or rejecting a job
 

content/actions/reference/environments.md

@@ -56,6 +56,8 @@ Secrets stored in an environment are only available to workflow jobs that refere
 1. Enter a name for the environment, then click **Configure environment**. Environment names are not case sensitive. An environment name may not exceed 255 characters and must be unique within the repository.
 1. Configure any environment protection rules or environment secrets.
 
+You can also create and configure environments through the REST API. For more information, see "[Environments](/rest/reference/repos#environments)" and "[Secrets](/rest/reference/actions#secrets)."
+
 Running a workflow that references an environment that does not exist will create an environment with the referenced name. The newly created environment will not have any protection rules or secrets configured. Anyone that can edit workflows in the repository can create environments via a workflow file, but only repository admins can configure the environment.
 
 ### Referencing an environment
@@ -77,3 +79,5 @@ Deleting an environment will delete all secrets and protection rules associated
 {% data reusables.github-actions.sidebar-environment %}
 1. Next the the environment that you want to delete, click {% octicon "trashcan" aria-label="The trashcan icon" %}.
 2. Click **I understand, delete this environment**.
+
+You can also delete environments through the REST API. For more information, see "[Environments](/rest/reference/repos#environments)."

content/admin/configuration/configuring-code-scanning-for-your-appliance.md

@@ -42,7 +42,6 @@ For the users of {% data variables.product.product_location %} to be able to ena
 ![Checkbox to enable or disable {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png)
 {% data reusables.enterprise_management_console.save-settings %}
 
-
 ### Running {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_actions %}
 
 #### Setting up a self-hosted runner
@@ -89,3 +88,25 @@ The {% data variables.product.prodname_codeql_runner %} is a command-line tool t
 1. Under "{% data variables.product.prodname_advanced_security %}", unselect **{% data variables.product.prodname_code_scanning_capc %}**.
 ![Checkbox to enable or disable {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/management-console/code-scanning-disable.png)
 {% data reusables.enterprise_management_console.save-settings %}
+
+### Enabling or disabling {% data variables.product.prodname_code_scanning %} via the administrative shell (SSH)
+
+You can enable or disable {% data variables.product.prodname_code_scanning %} programmatically on {% data variables.product.product_location %}. For example, you can enable {% data variables.product.prodname_code_scanning %} with your infrastructure-as-code tooling when you deploy an instance for staging or disaster recovery.
+
+For more information about the administrative shell and command-line utilities for {% data variables.product.prodname_ghe_server %}, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" and "[Command-line utilities](/admin/configuration/command-line-utilities#ghe-config)."
+
+1. SSH into {% data variables.product.product_location %}.
+1. Enable {% data variables.product.prodname_code_scanning %}.
+    ```shell
+    ghe-config app.minio.enabled true
+    ghe-config app.code-scanning.enabled true
+    ```
+2. Optionally, disable {% data variables.product.prodname_code_scanning %}.
+    ```shell
+    ghe-config app.minio.enabled false
+    ghe-config app.code-scanning.enabled false
+    ```
+3. Apply the configuration.
+    ```shell
+  ghe-config-apply
+  ```

content/graphql/guides/index.md

@@ -20,3 +20,5 @@ versions:
 {% link_in_list /using-the-explorer %}
 
 {% link_in_list /managing-enterprise-accounts %}
+
+{% link_in_list /using-the-graphql-api-for-discussions %}

content/rest/reference/repos.md

@@ -152,6 +152,15 @@ You can communicate that a transient environment no longer exists by setting its
   {% if operation.subcategory == 'deployments' %}{% include rest_operation %}{% endif %}
 {% endfor %}
 
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
+## Environments
+
+The Environments API allows you to create, configure, and delete environments. For more information about environments, see "[Environments](/actions/reference/environments)."
+{% for operation in currentRestOperations %}
+  {% if operation.subcategory == 'environments' %}{% include rest_operation %}{% endif %}
+{% endfor %}
+{% endif %}
+
 ## Forks
 
 {% for operation in currentRestOperations %}

data/reusables/actions/about-secrets.md

@@ -1 +1 @@
-Encrypted secrets allow you to store sensitive information, such as access tokens, in your repository or organization.
+Encrypted secrets allow you to store sensitive information, such as access tokens, in your repository, repository environments, or organization.

data/reusables/pages/new-or-existing-repo.md

@@ -1,5 +1,5 @@
 If your site is an independent project, you can create a new repository to store your site's source code. If your site is associated with an existing project, you can add the source code {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}to that project's repository, in a `/docs` folder on the default branch or on a different branch.{% else %}for your site to a `gh-pages` branch or a `docs` folder on the `master` branch in that project's repository.{% endif %} For example, if you're creating a site to publish documentation for a project that's already on {% data variables.product.product_name %}, you may want to store the source code for the site in the same repository as the project.
 
-{% if currentVersion == "free-pro-team@latest" %}If the account that owns the repository uses {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_free_team %}, the repository must be public.{% endif %}
+{% if currentVersion == "free-pro-team@latest" %}If the account that owns the repository uses {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_free_team %} for organizations, the repository must be public.{% endif %}
 
 If you want to create a site in an existing repository, skip to the "[Creating your site](#creating-your-site)" section.

data/reusables/webhooks/check_run_properties.md

@@ -6,6 +6,7 @@ Key | Type | Description
 `check_run[conclusion]`|`string` | The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`,  {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}`action_required` or `stale`{% else %}or `action_required`{% endif %}. This value will be `null` until the check run has `completed`.
 `check_run[name]`|`string` | The name of the check run.
 `check_run[check_suite][id]`|`integer` | The id of the check suite that this check run is part of.
-`check_run[check_suite][pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
+`check_run[check_suite][pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
+`deployment`|`object`| A deployment to a repository environment. This will only be populated if the check run was created by a {% data variables.product.prodname_actions %} workflow job that references an environment.{% endif %}
 `requested_action`|`object` | The action requested by the user.
 `requested_action[identifier]`|`string` | The integrator reference of the action requested by the user.

includes/scroll-button.html

@@ -0,0 +1,3 @@
+<button class="arrow-for-scrolling-top" id="js-scroll-top">
+    {% octicon "chevron-up" %}
+</button>

javascripts/index.js

@@ -2,6 +2,7 @@
 import '../stylesheets/index.scss'
 import displayPlatformSpecificContent from './display-platform-specific-content'
 import explorer from './explorer'
+import scrollUp from './scroll-up'
 import search from './search'
 import nav from './nav'
 import browserDateFormatter from 'browser-date-formatter'
@@ -23,6 +24,7 @@ import airgapLinks from './airgap-links'
 document.addEventListener('DOMContentLoaded', async () => {
   displayPlatformSpecificContent()
   explorer()
+  scrollUp()
   search()
   nav()
   browserDateFormatter()

javascripts/scroll-up.js

@@ -0,0 +1,22 @@
+export default function () {
+  // function to scroll up to page top
+  const PageTopBtn = document.getElementById('js-scroll-top')
+  if (!PageTopBtn) return
+
+  PageTopBtn.addEventListener('click', (e) => {
+    window.scrollTo({
+      top: 0,
+      behavior: 'smooth'
+    })
+  })
+
+  // show scroll button only when display is scroll down
+  window.addEventListener('scroll', function () {
+    const y = document.documentElement.scrollTop // get the height from page top
+    if (y < 100) {
+      PageTopBtn.classList.remove('show')
+    } else if (y >= 100) {
+      PageTopBtn.classList.add('show')
+    }
+  })
+}

layouts/default.html

@@ -15,6 +15,7 @@
       {% endif %}
       {% include support-section %}
       {% include small-footer %}
+      {% include scroll-button %}
     </main>
   </body>
 </html>

lib/rest/static/decorated/ghes-2.22.json

@@ -28669,12 +28669,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       }
     ],
     "x-codeSamples": [
@@ -28748,12 +28749,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       }
     ],
     "x-codeSamples": [
@@ -28826,12 +28828,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       },
       {
         "name": "per_page",
@@ -28925,12 +28928,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       }
     ],
     "x-codeSamples": [
@@ -29003,12 +29007,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       },
       {
         "name": "filter",
@@ -29117,12 +29122,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       }
     ],
     "x-codeSamples": [
@@ -29195,12 +29201,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       }
     ],
     "x-codeSamples": [
@@ -29273,12 +29280,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       }
     ],
     "x-codeSamples": [

lib/rest/static/decorated/ghes-3.0.json

@@ -33009,12 +33009,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       }
     ],
     "x-codeSamples": [
@@ -33088,12 +33089,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       }
     ],
     "x-codeSamples": [
@@ -33166,12 +33168,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       },
       {
         "name": "per_page",
@@ -33265,12 +33268,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       }
     ],
     "x-codeSamples": [
@@ -33343,12 +33347,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       },
       {
         "name": "filter",
@@ -33457,12 +33462,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       }
     ],
     "x-codeSamples": [
@@ -33535,12 +33541,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       }
     ],
     "x-codeSamples": [
@@ -33613,12 +33620,13 @@
       },
       {
         "name": "run_id",
+        "description": "The id of the workflow run",
         "in": "path",
         "required": true,
         "schema": {
           "type": "integer"
         },
-        "descriptionHTML": ""
+        "descriptionHTML": "<p>The id of the workflow run</p>"
       }
     ],
     "x-codeSamples": [

lib/webhooks/static/dotcom/check_run.completed.payload.json

@@ -190,7 +190,20 @@
           }
         }
       }
-    ]
+    ],
+    "deployment": {
+      "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728",
+      "id": 326191728,
+      "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=",
+      "task": "deploy",
+      "original_environment": "lab",
+      "environment": "lab",
+      "description": null,
+      "created_at": "2021-02-18T08:22:48Z",
+      "updated_at": "2021-02-18T09:47:16Z",
+      "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses",
+      "repository_url": "https://api.github.com/repos/Codertocat/Hello-World"
+    }
   },
   "repository": {
     "id": 186853002,

lib/webhooks/static/dotcom/check_run.created.payload.json

@@ -190,7 +190,20 @@
           }
         }
       }
-    ]
+    ],
+    "deployment": {
+      "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728",
+      "id": 326191728,
+      "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=",
+      "task": "deploy",
+      "original_environment": "lab",
+      "environment": "lab",
+      "description": null,
+      "created_at": "2021-02-18T08:22:48Z",
+      "updated_at": "2021-02-18T09:47:16Z",
+      "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses",
+      "repository_url": "https://api.github.com/repos/Codertocat/Hello-World"
+    }
   },
   "repository": {
     "id": 186853002,

lib/webhooks/static/dotcom/check_run.rerequested.payload.json

@@ -95,7 +95,20 @@
     },
     "pull_requests": [
 
-    ]
+    ],
+    "deployment": {
+      "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728",
+      "id": 326191728,
+      "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=",
+      "task": "deploy",
+      "original_environment": "lab",
+      "environment": "lab",
+      "description": null,
+      "created_at": "2021-02-18T08:22:48Z",
+      "updated_at": "2021-02-18T09:47:16Z",
+      "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses",
+      "repository_url": "https://api.github.com/repos/Codertocat/Hello-World"
+    }
   },
   "repository": {
     "id": 526,

stylesheets/index.scss

@@ -47,6 +47,7 @@ $marketing-font-path: "/dist/fonts/";
 @import "search.scss";
 @import "overrides.scss";
 @import "sidebar.scss";
+@import "scroll-button.scss";
 @import "explorer.scss";
 // from https://unpkg.com/highlight.js@9.15.8/styles/github.css
 @import "syntax-highlighting.scss";

stylesheets/scroll-button.scss

@@ -0,0 +1,18 @@
+button.arrow-for-scrolling-top {
+    opacity: 0;
+    transition: 1s;
+    background-color: #0367d6;
+    color: #fff;
+    position: fixed;
+    bottom: 10px;
+    right: 10px;
+    display: block;
+    width: 40px;
+    height: 40px;
+    border-radius: 50%;
+    &.show {
+        opacity: 1;
+        border: none;
+        transition: 1s;
+    }
+}