jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-05 21:04:17 -05:00
Code Issues Projects Releases Wiki Activity

Merge branch 'main' into graphql-schema-update

Browse Source
This commit is contained in:
Rachael Sewell
2021-09-09 18:04:47 -07:00
committed by GitHub
parent 361b273d1a 43eb14dbb1
commit 72b8ad0d0c
608 changed files with 390 additions and 15279 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/docs-review-collect.yml vendored
View File

@@ -7,7 +7,7 @@ name: Add docs-reviewers request to the docs-content review board
on:
workflow_dispatch:
schedule:
- cron: '25 4 * * *'
- cron: '50 */6 * * *'
jobs:
add-requests-to-board:

27
.github/workflows/repo-freeze-reminders.yml vendored
View File

@@ -1,27 +0,0 @@
name: Repo Freeze Reminders
# **What it does**: This reminds us that the repository is frozen for deploys.
# **Why we have it**: To remind us to turn off the freeze after the freeze period is over.
# **Who does it impact**: Docs engineering.
on:
schedule:
- cron: '9 11 * * *' # once per day around 11:09am UTC
env:
FREEZE: ${{ secrets.FREEZE }}
jobs:
check-freezer:
name: Remind about deployment freezes
runs-on: ubuntu-latest
if: github.repository == 'github/docs-internal'
steps:
- name: Send Slack notification if repo is frozen
uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
if: ${{ env.FREEZE == 'true' }}
with:
channel: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
color: info
text: All repo-sync runs will fail for ${{ github.repository }} because the repo is currently frozen!

10
.github/workflows/staging-deploy-pr-docker.yml vendored
View File

@@ -20,6 +20,8 @@ env:
jobs:
prepare:
env:
HEROKU_API_KEY: ${{ secrets.HEROKU_API_TOKEN }}
if: >-
${{
github.event.workflow_run.conclusion == 'success' &&
@@ -127,14 +129,18 @@ jobs:
}
- name: Build, tag, push, and release the Docker image
env:
HEROKU_API_KEY: ${{ secrets.HEROKU_API_TOKEN }}
run: |
docker image build --target production_early_access -t registry.heroku.com/${{ steps.create-app.outputs.app_name}}/web .
heroku container:login
docker push registry.heroku.com/${{ steps.create-app.outputs.app_name }}/web
heroku container:release web --app=${{ steps.create-app.outputs.app_name }}
# This command will fail for a brand new app since they don't have a
# process type yet so we need to scale after `heroku container:release`.
- name: Scale Heroku App size
run: |
heroku ps:scale --app=${{ steps.create-app.outputs.app_name}} web=1:Standard-2X
# https://devcenter.heroku.com/articles/container-registry-and-runtime#getting-a-docker-image-id
- name: Get Docker Image ID
id: image-id

30
.github/workflows/staging-deploy-pr.yml vendored
View File

@@ -276,13 +276,35 @@ jobs:
}
- name: Mark the deployment as inactive if timed out
if: ${{ steps.deploy.outcome == 'cancelled' }}
uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d
if: ${{ steps.deploy.outcome == 'cancelled' }}
env:
DEPLOYMENT_ID: ${{ steps.deploy.outputs.deploymentId }}
LOG_URL: ${{ steps.deploy.outputs.logUrl }}
with:
script: |
// TODO: Find the relevant deployment
// TODO: Create a new deployment status for it as "inactive"
return 'TODO'
const { DEPLOYMENT_ID, LOG_URL } = process.env
const { owner, repo } = context.repo
if (!DEPLOYMENT_ID) {
throw new Error('A deployment wasn't created before a timeout occurred!')
}
await github.repos.createDeploymentStatus({
owner,
repo,
deployment_id: DEPLOYMENT_ID,
state: 'error',
description: 'The deployment step timed out. See workflow logs.',
log_url: LOG_URL,
// The 'ant-man' preview is required for `state` values of 'inactive', as well as
// the use of the `log_url`, `environment_url`, and `auto_inactive` parameters.
// The 'flash' preview is required for `state` values of 'in_progress' and 'queued'.
mediaType: {
previews: ['ant-man', 'flash'],
},
})
console.log('⏲️ Deployment status: error - The deployment timed out...')
- name: Create failure status
uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d

BIN
assets/images/help/classroom/download-grades.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 80 KiB

2
content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md
View File

@@ -49,7 +49,7 @@ Repositories owned by an organization can grant more granular access. For more i
7. Select the collaborator's username from the drop-down menu.
![Collaborator list drop-down menu](/assets/images/help/repository/repo-settings-collab-autofill.png)
8. Click **Add collaborator**.
![Add button](/assets/images/help/repository/repo-settings-collab-add.png)
!["Add collaborator" button](/assets/images/help/repository/repo-settings-collab-add.png)
{% endif %}
{% ifversion fpt %}
9. The user will receive an email inviting them to the repository. Once they accept your invitation, they will have collaborator access to your repository.

6
content/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md
View File

@@ -67,7 +67,7 @@ You can use Markdown to format your message. For more information, see "[About w
{% ifversion ghes > 2.22 or ghae %}
## Creating a mandatory message
You can create a mandatory message that {% data variables.product.product_name %} will show to all users the first time they sign in after you save the message. The message appears in a pop-up window that the user must dismiss before the user can use {% data variables.product.product_location %}.
You can create a mandatory message that {% data variables.product.product_name %} will show to all users the first time they sign in after you save the message. The message appears in a pop-up window that the user must dismiss before the user can use {% data variables.product.product_location %}.
Mandatory messages have a variety of uses.
@@ -89,9 +89,9 @@ Each time a user sees a mandatory message, an audit log event is created. The ev
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.messages-tab %}
1. To the right of "Mandatory message", click **Add message**.
![Add message button](/assets/images/enterprise/site-admin-settings/add-mandatory-message-button.png)
![Add mandatory message button](/assets/images/enterprise/site-admin-settings/add-mandatory-message-button.png)
1. Under "Mandatory message", in the text box, type your message.
![Add message button](/assets/images/enterprise/site-admin-settings/mandatory-message-text-box.png)
![Mandatory message text box](/assets/images/enterprise/site-admin-settings/mandatory-message-text-box.png)
{% data reusables.enterprise_site_admin_settings.message-preview-save %}
{% endif %}

4
content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md
View File

@@ -34,8 +34,8 @@ You can check how many seats your license includes and how many of them are curr
{% data reusables.enterprise-accounts.license-tab %}
The "{% data variables.product.prodname_GH_advanced_security %}" section shows details of the current usage.
![{% data variables.product.prodname_GH_advanced_security %} in enterprise licensing settings](/assets/images/help/enterprises/enterprise-licensing-tab-ghas.png)
If you run out of seats, the section will be red. You should either reduce your use of {% data variables.product.prodname_GH_advanced_security %} or purchase more seats. For more information, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security#getting-the-most-out-of-github-advanced-security)."
![{% data variables.product.prodname_GH_advanced_security %} in enterprise licensing settings](/assets/images/help/enterprises/enterprise-licensing-tab-ghas-no-seats.png)
If you run out of seats, the section will be red and show "Limit exceeded". You should either reduce your use of {% data variables.product.prodname_GH_advanced_security %} or purchase more seats. For more information, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security#getting-the-most-out-of-github-advanced-security)."
![{% data variables.product.prodname_GH_advanced_security %} in enterprise licensing settings showing "Limit exceeded"](/assets/images/help/enterprises/enterprise-licensing-tab-ghas-no-seats.png)
4. Optionally, to see a detailed breakdown of usage per organization, in the left sidebar, click **Billing**.
![Billing tab in the enterprise account settings sidebar](/assets/images/help/business-accounts/settings-billing-tab.png)
In the "{% data variables.product.prodname_GH_advanced_security %}" section you can see the number of committers and unique committers for each organization.

2
content/code-security/security-advisories/editing-a-security-advisory.md
View File

@@ -37,7 +37,7 @@ If you believe you should be credited for a security advisory, please contact th
11. Optionally, edit the "Credits" for the security advisory.
![Credits for a security advisory](/assets/images/help/security/security-advisory-credits.png)
12. Click **Update security advisory**.
![Add button](/assets/images/help/security/update-advisory-button.png)
!["Update security advisory" button](/assets/images/help/security/update-advisory-button.png)
13. The people listed in the "Credits" section will receive an email or web notification inviting them to accept credit. If a person accepts, their username will be publicly visible once the security advisory is published.
## Further reading

40
content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md
View File

@@ -12,13 +12,13 @@ topics:
- Codespaces
---
## Introduction
This guide shows you how to set up your C# (.NET) project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template.
### Prerequisites
### Prerequisites
- You should have an existing C# (.NET) project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/dotnet-quickstart.
- You must have {% data variables.product.prodname_codespaces %} enabled for your organization.
@@ -27,18 +27,18 @@ This guide shows you how to set up your C# (.NET) project in {% data variables.p
1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
![New codespace button](/assets/images/help/codespaces/new-codespace-button.png)
![New codespace button](/assets/images/help/codespaces/new-codespace-button.png)
If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including .NET. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including .NET. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed.
You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed.
{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
## Step 2: Add a dev container to your codespace from a template
## Step 2: Add a dev container to your codespace from a template
The default codespaces container comes with the latest .NET version and common tools preinstalled. However, we encourage you to set up a custom container so you can tailor the tools and scripts that run as part of codespace creation to your project's needs and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository.
@@ -71,7 +71,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr
"name": "C# (.NET)",
"build": {
"dockerfile": "Dockerfile",
"args": {
"args": {
// Update 'VARIANT' to pick a .NET Core version: 2.1, 3.1, 5.0
"VARIANT": "5.0",
// Options
@@ -101,7 +101,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr
// dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
// * macOS/Linux terminal:
// dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
//
//
// 2. Uncomment these 'remoteEnv' lines:
// "remoteEnv": {
// "ASPNETCORE_Kestrel__Certificates__Default__Password": "SecurePwdGoesHere",
@@ -166,17 +166,17 @@ RUN if [ "$INSTALL_AZURE_CLI" = "true" ]; then bash /tmp/library-scripts/azcli-d
You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container.
## Step 3: Modify your devcontainer.json file
## Step 3: Modify your devcontainer.json file
With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and restore your project dependencies when your codespace launches.
1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it.
1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it.
!["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png)
![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png)
2. Update your the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project.
```json{:copy}
```json{:copy}
"extensions": [
"ms-dotnettools.csharp",
"streetsidesoftware.code-spell-checker",
@@ -185,7 +185,7 @@ With your dev container added and a basic understanding of what everything does,
3. Uncomment the `postCreateCommand` to restore dependencies as part of the codespace setup process.
```json{:copy}
```json{:copy}
// Use 'postCreateCommand' to run commands after the container is created.
"postCreateCommand": "dotnet restore",
```
@@ -195,22 +195,22 @@ With your dev container added and a basic understanding of what everything does,
Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container.
5. Check your changes were successfully applied by verifying the "Code Spell Checker" extension was installed.
![Extensions list](/assets/images/help/codespaces/dotnet-extensions.png)
![Extensions list](/assets/images/help/codespaces/dotnet-extensions.png)
## Step 4: Run your application
In the previous section, you used the `postCreateCommand` to install a set of packages via the `dotnet restore` command. With our dependencies now installed, we can run our application.
1. Run your application by pressing `F5` or entering `dotnet watch run` in your terminal.
2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses.
2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses.
![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png)
## Step 5: Commit your changes
{% data reusables.codespaces.committing-link-to-procedure %}
{% data reusables.codespaces.committing-link-to-procedure %}
## Next steps

24
content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md
View File

@@ -11,13 +11,13 @@ topics:
- Codespaces
---
## Introduction
This guide shows you how to set up your Java project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template.
### Prerequisites
### Prerequisites
- You should have an existing Java project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-java
- You must have {% data variables.product.prodname_codespaces %} enabled for your organization.
@@ -26,18 +26,18 @@ This guide shows you how to set up your Java project in {% data variables.produc
1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
![New codespace button](/assets/images/help/codespaces/new-codespace-button.png)
![New codespace button](/assets/images/help/codespaces/new-codespace-button.png)
If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Java, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Java, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed.
You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed.
{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
## Step 2: Add a dev container to your codespace from a template
## Step 2: Add a dev container to your codespace from a template
The default codespaces container comes with the latest Java version, package managers (Maven, Gradle), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository.
@@ -81,12 +81,12 @@ The newly added `devcontainer.json` file defines a few properties that are descr
},
// Set *default* container specific settings.json values on container create.
"settings": {
"settings": {
"terminal.integrated.shell.linux": "/bin/bash",
"java.home": "/docker-java-home",
"maven.executable.path": "/usr/local/sdkman/candidates/maven/current/bin/mvn"
},
// Add the IDs of extensions you want installed when the container is created.
"extensions": [
"vscjava.vscode-java-pack"
@@ -146,13 +146,13 @@ RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/shar
You can use the Dockerfile to add additional container layers to specify OS packages, Java versions, or global packages we want included in our Dockerfile.
## Step 3: Modify your devcontainer.json file
## Step 3: Modify your devcontainer.json file
With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches.
1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to expand the `.devcontainer` folder to see it.
!["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png)
![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png)
2. Add the following lines to your `devcontainer.json` file after `extensions`.
@@ -174,7 +174,7 @@ In the previous section, you used the `postCreateCommand` to install a set of pa
1. Run your application by pressing `F5`.
2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses.
2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses.
![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png)

26
content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md
View File

@@ -15,13 +15,13 @@ topics:
- JavaScript
---
## Introduction
This guide shows you how to set up your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template.
### Prerequisites
### Prerequisites
- You should have an existing JavaScript, Node.js, or TypeScript project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-node
- You must have {% data variables.product.prodname_codespaces %} enabled for your organization.
@@ -30,22 +30,22 @@ This guide shows you how to set up your JavaScript, Node.js, or TypeScript proje
1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
![New codespace button](/assets/images/help/codespaces/new-codespace-button.png)
![New codespace button](/assets/images/help/codespaces/new-codespace-button.png)
If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed.
You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed.
{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
## Step 2: Add a dev container to your codespace from a template
## Step 2: Add a dev container to your codespace from a template
The default codespaces container will support running Node.js projects like [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) out of the box. By setting up a custom container you can customize the tools and scripts that run as part of codespace creation and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository.
To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)".
To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)".
{% data reusables.codespaces.command-palette-container %}
3. For this example, click **Node.js**. If you need additional features you can select any container that’s specific to Node or a combination of tools such as Node and MongoDB.
@@ -77,7 +77,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr
},
// Set *default* container specific settings.json values on container create.
"settings": {
"settings": {
"terminal.integrated.shell.linux": "/bin/bash"
},
@@ -131,13 +131,13 @@ FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}
You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our Dockerfile.
## Step 3: Modify your devcontainer.json file
## Step 3: Modify your devcontainer.json file
With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install npm when your codespace launches and make a list of ports inside the container available locally.
1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to expand the `.devcontainer` folder to see it.
!["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png)
![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png)
2. Add the following lines to your `devcontainer.json` file after `extensions`:
@@ -161,13 +161,13 @@ In the previous section, you used the `postCreateCommand` to installing a set of
![npm start in terminal](/assets/images/help/codespaces/codespaces-npmstart.png)
2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses.
2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses.
![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png)
## Step 5: Commit your changes
{% data reusables.codespaces.committing-link-to-procedure %}
{% data reusables.codespaces.committing-link-to-procedure %}
## Next steps

40
content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md
View File

@@ -14,13 +14,13 @@ topics:
- Python
---
## Introduction
This guide shows you how to set up your Python project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template.
### Prerequisites
### Prerequisites
- You should have an existing Python project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/python-quickstart.
- You must have {% data variables.product.prodname_codespaces %} enabled for your organization.
@@ -29,24 +29,24 @@ This guide shows you how to set up your Python project in {% data variables.prod
1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
![New codespace button](/assets/images/help/codespaces/new-codespace-button.png)
![New codespace button](/assets/images/help/codespaces/new-codespace-button.png)
If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed.
You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed.
{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
## Step 2: Add a dev container to your codespace from a template
## Step 2: Add a dev container to your codespace from a template
The default codespaces container comes with the latest Python version, package managers (pip, Miniconda), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository.
To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
{% data reusables.codespaces.command-palette-container %}
@@ -75,7 +75,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr
"build": {
"dockerfile": "Dockerfile",
"context": "..",
"args": {
"args": {
// Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9
"VARIANT": "3",
// Options
@@ -85,7 +85,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr
},
// Set *default* container specific settings.json values on container create.
"settings": {
"settings": {
"terminal.integrated.shell.linux": "/bin/bash",
"python.pythonPath": "/usr/local/bin/python",
"python.linting.enabled": true,
@@ -157,17 +157,17 @@ RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/l
You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container.
## Step 3: Modify your devcontainer.json file
## Step 3: Modify your devcontainer.json file
With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches.
1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it.
1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it.
!["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png)
![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png)
2. Update the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project.
```json{:copy}
```json{:copy}
"extensions": [
"ms-python.python",
"cstrap.flask-snippets",
@@ -177,7 +177,7 @@ With your dev container added and a basic understanding of what everything does,
3. Uncomment the `postCreateCommand` to auto-install requirements as part of the codespaces setup process.
```json{:copy}
```json{:copy}
// Use 'postCreateCommand' to run commands after the container is created.
"postCreateCommand": "pip3 install --user -r requirements.txt",
```
@@ -187,16 +187,16 @@ With your dev container added and a basic understanding of what everything does,
Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container.
5. Check your changes were successfully applied by verifying the Code Spell Checker and Flask Snippet extensions were installed.
![Extensions list](/assets/images/help/codespaces/python-extensions.png)
![Extensions list](/assets/images/help/codespaces/python-extensions.png)
## Step 4: Run your application
In the previous section, you used the `postCreateCommand` to install a set of packages via pip3. With your dependencies now installed, you can run your application.
1. Run your application by pressing `F5` or entering `python -m flask run` in the codespace terminal.
2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses.
2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses.
![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png)

2
content/developers/apps/managing-github-apps/suspending-a-github-app-installation.md
View File

@@ -18,6 +18,8 @@ The integrator who owns and maintains a GitHub app, also called a GitHub App own
People who have installed a GitHub App, also called installation owners, can only suspend or unsuspend a GitHub App through their app's installation settings. Installation owners cannot use the API to suspend or unsuspend their app installation.
If an installation has been suspended by the {% data variables.product.prodname_github_app %} owner, installation owners cannot unsuspend their installations of the {% data variables.product.prodname_github_app %}. However, installation owners can change other settings, such as repository selection, while the app is suspended.
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.github_apps %}

4
content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md
View File

@@ -14,7 +14,7 @@ shortTitle: Manage discussions
Organization owners can choose the permissions required to create a discussion for repositories owned by the organization. For more information, see "[Managing discussion creation for repositories in your organization](/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization)."
As a discussions maintainer, you can create community resources to encourage discussions that are aligned with the overall project goal and maintain a friendly open forum for collaborators. Creating a code of conduct or contribution guidelines for collaborators to follow will help facilitate a collaborative and productive forum. For more information on creating community resources, see "[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)," and "[Setting guidelines for repository contributors](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)."
As a discussions maintainer, you can create community resources to encourage discussions that are aligned with the overall project goal and maintain a friendly open forum for collaborators. Creating a code of conduct or contribution guidelines for collaborators to follow will help facilitate a collaborative and productive forum. For more information on creating community resources, see "[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)," and "[Setting guidelines for repository contributors](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)."
When a discussion yields an idea or bug that is ready to be worked on, you can create a new issue from a discussion. For more information, see "[Creating an issue](/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-discussion)."
@@ -62,7 +62,7 @@ Editing a pinned discussion will not change the discussion's category. For more
{% data reusables.discussions.discussions-tab %}
{% data reusables.discussions.click-discussion-in-list %}
1. In the right sidebar, click {% octicon "pencil" aria-label="The pencil icon" %} **Edit pinned discussion**.
!["Pin discussion" in right sidebar for discussion](/assets/images/help/discussions/click-edit-pinned-discussion.png)
!["Edit pinned discussion" in right sidebar for discussion](/assets/images/help/discussions/click-edit-pinned-discussion.png)
1. Customize the look of the pinned discussion.
![Customization options for a pinned discussion](/assets/images/help/discussions/customize-pinned-discussion.png)
1. Click **Pin discussion**.

9
content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding.md
View File

@@ -79,8 +79,15 @@ You can add, edit, or delete autograding tests for an existing assignment. If yo
1. At the bottom of the page, click **Update assignment**.
!["Update assignment" button at the bottom of the page](/assets/images/help/classroom/assignments-click-update-assignment.png)
## Viewing logs from autograding tests
## Viewing and downloading results from autograding tests
### Download autograding results
You can also download a CSV of your students' autograding scores via the "Download" button. This will generate and download a CSV containing a link to the student's repository, their {% data variables.product.prodname_dotcom %} handle, roster identifier, submission timestamp, and autograding score.
!["Download" button selected showing "Download grades highlighted" and an additional option to "Download repositories"](/assets/images/help/classroom/download-grades.png)
### View individual logs
{% data reusables.classroom.sign-into-github-classroom %}
{% data reusables.classroom.click-classroom-in-list %}
{% data reusables.classroom.click-assignment-in-list %}

2
content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md
View File

@@ -56,7 +56,7 @@ To change the default branch, your repository must have more than one branch. Fo
1. Click **Update**.
!["Update" button after choosing a new default branch](/assets/images/help/repository/repository-options-defaultbranch-update.png)
1. Read the warning, then click **I understand, update the default branch.**
!["Update" button after choosing a new default branch](/assets/images/help/repository/repository-options-defaultbranch-i-understand.png)
!["I understand, update the default branch." button to perform the update](/assets/images/help/repository/repository-options-defaultbranch-i-understand.png)
{% else %}

6
content/github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-oauth-apps.md
View File

@@ -83,6 +83,12 @@ When you authorize an {% data variables.product.prodname_oauth_app %} for your p
If you belong to any organizations that enforce SAML single sign-on, you must have an active SAML session for each organization each time you authorize an {% data variables.product.prodname_oauth_app %}.
{% note %}
**Note:** If you are encountering errors authenticating to an organization that enforces SAML single sign-on, you may need to revoke the OAuth App from your [account settings page](https://github.com/settings/applications) and repeat the authentication flow to reauthorize the app.
{% endnote %}
## Further reading
- "[About {% data variables.product.prodname_oauth_app %} access restrictions](/articles/about-oauth-app-access-restrictions)"

4
content/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise.md
View File

@@ -28,9 +28,9 @@ Enterprise owners and billing managers automatically have a support entitlement.
3. Under "Settings", click **Support**.
![Support menu item](/assets/images/help/enterprises/settings-support.png)
4. Under "Add support member", start typing the name or username of the person you want to give a support entitlement. Click their name in the list of matches.
![Add support entitlement](/assets/images/help/enterprises/settings-support-entitlement-search.png)
![Add support entitlement search](/assets/images/help/enterprises/settings-support-entitlement-search.png)
5. Click **Add support entitlement**.
![Add support entitlement](/assets/images/help/enterprises/settings-support-add-entitlement.png)
![Add support entitlement button](/assets/images/help/enterprises/settings-support-add-entitlement.png)
## Removing a support entitlement from an enterprise member

8
content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md
View File

@@ -271,6 +271,14 @@ You can tell {% data variables.product.product_name %} to ignore (or escape) Mar
For more information, see Daring Fireball's "[Markdown Syntax](https://daringfireball.net/projects/markdown/syntax#backslash)."
## Hiding content with comments
You can tell {% data variables.product.product_name %} to hide content from the rendered Markdown by placing the content in an HTML comment.
<pre>
&lt;!-- This content will not appear in the rendered Markdown --&gt;
</pre>
## Further reading
- [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/)

2
content/github/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md
View File

@@ -18,7 +18,7 @@ versions:
5. To review your reply, click **Preview**.
![Add a saved reply](/assets/images/help/settings/saved-replies-preview.png)
6. Click **Add saved reply**.
![Add a saved reply](/assets/images/help/settings/saved-replies-add-button.png)
!["Add saved reply" button](/assets/images/help/settings/saved-replies-add-button.png)
## Further reading

8
content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md
View File

@@ -75,7 +75,13 @@ Follow similar steps to remove a sort.
## Group
In table layout, you can group items by a custom field value. You cannot group by fields that contain {% data variables.product.company_short %} data (such as: title, assignees, repository, labels, milestone). When items are grouped, if you drag an item to a new group, the value of that group is applied. For example, if you group by `Status` and then drag an item with a status of `In progress` to the `Done` group, the status of the item will switch to `Done`.
In the table layout, you can group items by a custom field value. When items are grouped, if you drag an item to a new group, the value of that group is applied. For example, if you group by `Status` and then drag an item with a status of `In progress` to the `Done` group, the status of the item will switch to `Done`.
{% note %}
**Note:** Currently, you cannot group by title, assignees, repository or labels.
{% endnote %}
1. {% data reusables.projects.open-command-palette %}
2. Start typing "Group by" or the name of the field you want to group by.

2
content/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization.md
View File

@@ -120,7 +120,7 @@ To allow {% data variables.product.prodname_dependabot %} to access a private {%
1. Under "{% data variables.product.prodname_dependabot %} private repository access", click **Add private repositories** or **Add internal and private repositories**.
![Add repositories button](/assets/images/help/organizations/dependabot-private-repository-access.png)
1. Start typing the name of the repository you want to allow.
![Add repositories button](/assets/images/help/organizations/dependabot-private-repo-choose.png)
![Repository search field with filtered dropdown](/assets/images/help/organizations/dependabot-private-repo-choose.png)
1. Click the repository you want to allow.
1. Optionally, to remove a repository from the list, to the right of the repository, click {% octicon "x" aria-label="The X icon" %}.

2
content/rest/reference/repos.md
View File

@@ -167,7 +167,7 @@ Note that the `repo_deployment` [OAuth scope](/developers/apps/scopes-for-oauth-
### Inactive deployments
When you set the state of a deployment to `success`, then all prior non-transient, non-production environment deployments in the same repository to the same environment name will become `inactive`. To avoid this, you can set `auto_inactive` to `false` when creating the deployment status.
When you set the state of a deployment to `success`, then all prior non-transient, non-production environment deployments in the same repository with the same environment name will become `inactive`. To avoid this, you can set `auto_inactive` to `false` when creating the deployment status.
You can communicate that a transient environment no longer exists by setting its `state` to `inactive`. Setting the `state` to `inactive` shows the deployment as `destroyed` in {% data variables.product.prodname_dotcom %} and removes access to it.

4
lib/search/indexes/github-docs-2.22-cn-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:7bb9984ffbccfaa6a75952242d1690577742db4c6e0f404103326068b255321c
size 506433
oid sha256:c88630dd76dff2668b2f3743b5b490f4907a4a3b9fd8b3c23eb58fc057a55fa2
size 506622

4
lib/search/indexes/github-docs-2.22-cn.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:92a662ddd4c8a9061e0ebc6d9bba67349b42d76726fcd1e4f010f15bc777a1a7
size 802095
oid sha256:a2775d5ed380bf1ca5e194f14c004c0f0048644337fa4468048ab27ceaa751fe
size 802218

4
lib/search/indexes/github-docs-2.22-de-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:355b990180d6d4df98d51156ee5ebbe4dc1b27ee9620fe74303cdb81808d4050
size 469303
oid sha256:b6978f4a9142f28d3d8bb8f836264329127992a193aacf8d6961e1687b8c6020
size 469305

4
lib/search/indexes/github-docs-2.22-de.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:c912b1991a122726a568e154f7557adeab2cf2a0707992bad5036d29e803abb2
size 2077927
oid sha256:4f5cd5cb0457be9e223c77448b82486ba7ccc80272d4407c25d00231b91408b5
size 2077234

4
lib/search/indexes/github-docs-2.22-en-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:bb0ac53b62b7b3a155165fb16c16917ffd9fbfd1d914f5d8af8e4d9be49cb76e
size 432070
oid sha256:b827481189fbfd0d8df8fa8c0bf3df19d2e83ddd5c8805de20aae6f16304f2e3
size 432720

4
lib/search/indexes/github-docs-2.22-en.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:81cad3f957aca266e257e6c2e06c23ef9889fde43b5a6a180276d00127f2214f
size 1695914
oid sha256:3ec9f7ea178e0982859b742a3d58ccedc15220bd13bcaccee764d2e7e3016171
size 1696549

4
lib/search/indexes/github-docs-2.22-es-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:29d54947d92debd1a6805091bff616e949657dd19da4f73a66b9ab5517d88a23
size 280146
oid sha256:2c57f871f6918219fddc5bc3491bb218ad26876c5f3661a00bb52f7c4bcb7d61
size 280158

4
lib/search/indexes/github-docs-2.22-es.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:71bd6a4f37c94185ee567ecaced39438e6cf59665d4e5946740c43d597e21317
size 1066987
oid sha256:039da5347cf968d8ffcfca2411f586f67acf88920b17d757f3cb70119313135d
size 1067543

4
lib/search/indexes/github-docs-2.22-ja-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:623c2eee9bca84d804161d761c6ee0cd4dafa4b6bc6b1fe92a12053d91ec0d69
size 528672
oid sha256:8cec884ab1504d1582f3b6fd9f67a9fa65f8b26924a9fc42cd1f60fac6c11e1b
size 528606

4
lib/search/indexes/github-docs-2.22-ja.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:df7e39d611b05c59bbf551946308f0949cccf54d58547d785c08dfa241ae80a0
size 2796004
oid sha256:2cdaf03877f24b0201c290e96a27cd91a7dcb42c2c86f8be9c44b9febe0b49b9
size 2796119

4
lib/search/indexes/github-docs-2.22-pt-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:c3f87cae41909b37c6ff25d4b4191c505630d9c87dc2c2208e97aa76ad9e2f35
size 443533
oid sha256:5930b3b0234030c8fd47ad8c8c82f061bccb87d18e91f3154fd4991902893d7b
size 443529

4
lib/search/indexes/github-docs-2.22-pt.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:c8a1c52a5c9a02fa8098ca2ca20d9aea2e9f2a2651f77533766a10b6a75f06c9
size 1851936
oid sha256:285fdd1fe7e283bcf15a5152eab2fc93d628778bccd41a06d71652057d952af0
size 1851478

4
lib/search/indexes/github-docs-3.0-cn-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:b731088e61cf1914455d7cb41324517170a2ba1f025e1d066a8e3614fd405bec
size 524506
oid sha256:ad1a42e398732f8d0bcf9ec562ec8629bb9f3c31c6e8bea97c80c359ecce219f
size 524571

4
lib/search/indexes/github-docs-3.0-cn.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:25bfe341d0abd737e1fade43bbeed6fefdc5635f48c0bbcff4ad91d3b3bd16f2
size 833489
oid sha256:a42ae770cdc4b514d2a785d26851a7464d469adafd3c2f1995a631222f9fe3b4
size 833047

4
lib/search/indexes/github-docs-3.0-de-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:b46139f879928ac5d15ab4c9a67a5b659aab5fc292755c13f7debd145f743a64
size 490435
oid sha256:d7378f7d8e2fffdf251775391aec5bd388c64cfb144af3a514088074df615679
size 490096

4
lib/search/indexes/github-docs-3.0-de.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:24ea7d4c8f290c307ba01c56feac626da3afad4354a7100b81693d90601fc982
size 2178920
oid sha256:22de51888da4084c7de578f669aadf8a4d9931340c56a3913530930afc14481f
size 2177584

4
lib/search/indexes/github-docs-3.0-en-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:4e3d600722da04fda418fce36ef5c5ba166c56c2cad8a3cb84e0084b997566bb
size 451329
oid sha256:50fddffa9e421bc81779c2f6204821a58a8a65ef5578748a5957f7c4ea0a7306
size 452229

4
lib/search/indexes/github-docs-3.0-en.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:a799184e5e183056bad65c0b24e330a1ac5368b703cb241b2356bb4acc69ac1c
size 1769923
oid sha256:fdd51e4a53711083c64bb51b4e211c71908a7b046a8a68246ccf2d468b187e78
size 1771524

4
lib/search/indexes/github-docs-3.0-es-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:7c4e80f35431405a1e03671b0b7484b849f0aa66616360ebb7c70ef1d306551c
size 278052
oid sha256:e70fb14cead18608b6458f3d00096cf90968597b5e8783933678a41d7c7dd9bd
size 278110

4
lib/search/indexes/github-docs-3.0-es.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:a22eaa57d2e52a8be6c5247f357a93657e29625ea17e3848c50d8e97bbdb0ec2
size 1055970
oid sha256:ba962891016c72a7b36ea1febc5071d2bb1451f5255d6d1b0e39c839b66aa161
size 1055479

4
lib/search/indexes/github-docs-3.0-ja-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:08059e3d389ee5b704c06b738f50e12c89d468dd4f67a9ea62f221506973bf90
size 550473
oid sha256:81d8a37cf48169f3abcd287ccc0f3ff32d869af0e3966fb277654d4bf5a5f039
size 550348

4
lib/search/indexes/github-docs-3.0-ja.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:72d7d9639734b7ad097ce63c14bb7d5db232156508e585844d6aa26cd0ee657b
size 2911981
oid sha256:ebead40ec36664fe4b8f74bec935851b826a4e520fc477ad5df15a53339a3337
size 2913342

4
lib/search/indexes/github-docs-3.0-pt-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:e4421fa2dc7b417714c38c3c67a8f9625a643c8081e275de0baf0312adf13ceb
size 464714
oid sha256:5da57c499ec3892438e8e7184e34792c2f28fc50d2922b2a9a9a38bdbdc3c534
size 464636

4
lib/search/indexes/github-docs-3.0-pt.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:706e0ed2d180417fa7534cd214608000227d9752a7e5ea8d884304079612ada1
size 1938424
oid sha256:2aca67e18f0349f07baef62c10ca30e480998b0eb6c78dab9b18689646ef51ba
size 1937942

4
lib/search/indexes/github-docs-3.1-cn-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:7dcef02c607dcc2fd0c0918dbc7325a02ec45efe49717ca1ddd537f43961398a
size 534093
oid sha256:abd3faa6c970c7c889031badd928fc0fdd5ea26a063e6534563e6a92f6283831
size 534218

4
lib/search/indexes/github-docs-3.1-cn.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:8abaf35ac86d58b39c3bd5f3185e1863eda0e65fd78a27a2bf03fb52d065ba77
size 845440
oid sha256:7ac50ada4c0217b2c9b4a8b886621767bd9c4f6a89f35d27cc78768697cc0f3d
size 845750

4
lib/search/indexes/github-docs-3.1-de-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:e2bf87c7699b6baa4d9be10454b61abc94d75d5480df6aa87bdacded28497e2d
size 497245
oid sha256:3e6ee335e4c32e5e0d8bff75d2b0dd081ed506b190e392d55de8253e4298f4e8
size 497696

4
lib/search/indexes/github-docs-3.1-de.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:889d57f102b10ad57e5ebd17859098dd9d4049eb88382fe8d195d5f2bcc76110
size 2220713
oid sha256:7ccc5497a4daf67e772bef0a130e6c5c0b0b9f0a6a2e0182168216aa65a78340
size 2223120

4
lib/search/indexes/github-docs-3.1-en-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:2b77191656ee9ac48102c6873dd06048d3096bd52ae03b8f358667158322a980
size 459802
oid sha256:9360ce8d0f964ff75c24556a193182fc6d3e3ee528b955f757d35f269375fbca
size 460772

4
lib/search/indexes/github-docs-3.1-en.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:7623e17bf87a6083b475399f80167d894568f4656947d3ee6e63ea07b6b40bf5
size 1805062
oid sha256:3ca199e0aa4954028e699dc080d6a2a8c6b5b1c1a0f0c851229f98c580600ca9
size 1805945

4
lib/search/indexes/github-docs-3.1-es-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:cd7c0c17ca7085310002582ebe524caab1b6a6e1a93e7602170a9b135796abed
size 278501
oid sha256:e77a57e76cf449fe323a0eed596f4c0bdbc398aeb05bfa74a94c6611c87c261b
size 278457

4
lib/search/indexes/github-docs-3.1-es.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:f8d18d1c5dc31f8e17076b127fc4111273769cf17a522e82e53a9c7b816cddb2
size 1056644
oid sha256:25165b73815dc13fa6352b536cb1b90594b6eb28e91d2c597012224dba1a1365
size 1056830

4
lib/search/indexes/github-docs-3.1-ja-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:568a18708d968fed423c67cc061c9d57bae6483c8c3245246116a5c002cb5f01
size 559196
oid sha256:cb0d405f07bebabdae0f848cd1635161d1e9bc4372eaeee2dda3f273b8d39cc1
size 559036

4
lib/search/indexes/github-docs-3.1-ja.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:ddb70db365447165040636eacf9f06f4debe9da9a938c6435103657a1f137d63
size 2965370
oid sha256:c54a19d4fd7bf108a1a9ec81ff8b6118e82722c299f3b7575bb0d1974560876d
size 2966253

4
lib/search/indexes/github-docs-3.1-pt-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:5c39430770583012f2e068961c575fa12aa64a57805e8156fa40bbf80ac2ab4a
size 472264
oid sha256:8754cd31086397bccf0b275f3852f7eb48cdabeaed07ab74a1785575ef00cecd
size 472305

4
lib/search/indexes/github-docs-3.1-pt.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:e4dfb5505a051222e4a92ea51d92441c05661511aa7940db97f6f6aa37cb6d30
size 1972096
oid sha256:106927d929964455db4f0062d124027c4c432a8648d0c91273a9689bc760c9ca
size 1971887

3
lib/search/indexes/github-docs-3.2-cn-records.json.br Normal file
View File

@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:1a2a11fc5b6a6bd713786ae87e1a65e452de479b94cebcd4713b7bb859750cc8
size 539742

3
lib/search/indexes/github-docs-3.2-cn.json.br Normal file
View File

@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:bc753820b1b2bdaf96d5ab54b15f5caa95687feefe5be3a47847c77cb2cabe52
size 852932

3
lib/search/indexes/github-docs-3.2-de-records.json.br Normal file
View File

@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:8999d8cc3ad09241ec61773d2e6b2dd185ede6e39bb4c2190a76003029cf7c9c
size 501742

3
lib/search/indexes/github-docs-3.2-de.json.br Normal file
View File

@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:6d357aa4463040d3b16b816bb55d40801c5288650814a269f4359ccde94746e5
size 2244366

4
lib/search/indexes/github-docs-3.2-en-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:c9e081ba6daf47ca89d5cabb9fc98c81b2556012cc36add7ac5818c218d81fd2
size 469609
oid sha256:3ae9d97294c2d52fe8352cfff6d7a49875c71b7b2d9887240b4e6a7c4a6d76fc
size 469538

2
lib/search/indexes/github-docs-3.2-en.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:8e56c64c3a0cfc9bdab263058f4b3212c56aa97b2b37d38ba1893adf31e77635
oid sha256:2215d619fb311588dc78a3e13538e3ecb86d93c3c7af3342b2900847f1e73d3b
size 1838131

3
lib/search/indexes/github-docs-3.2-es-records.json.br Normal file
View File

@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:e6b0a0c1b8ab4857cd692bcf932c269214a3ed5f2b92f33a6de6db0666ade588
size 278350

3
lib/search/indexes/github-docs-3.2-es.json.br Normal file
View File

@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:a80837b013ee14f71074ae95abfd0fbe753a13ecb000fef39a4a4b6c399455b2
size 1057071

3
lib/search/indexes/github-docs-3.2-ja-records.json.br Normal file
View File

@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:4bc172ea8c8dab3f8334184bb36027f134b8cb9b2e145533e1fd033b9432b454
size 564877

3
lib/search/indexes/github-docs-3.2-ja.json.br Normal file
View File

@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:066831ff714429573bea083e6f45418831af42b32aca9bf0f4748ea58d585d8e
size 2998042

3
lib/search/indexes/github-docs-3.2-pt-records.json.br Normal file
View File

@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:e6f6cfce878ea66e068682eb67ac85c02c70a7d1fe6f0bf7b82bc33e77740c0f
size 476924

3
lib/search/indexes/github-docs-3.2-pt.json.br Normal file
View File

@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:dec7f40c48d1767072a0e45a06395a8d7aca348f03af7fbcaf7719a6ae9e4ace
size 1994460

4
lib/search/indexes/github-docs-dotcom-cn-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:948df58cc77b8cb5de724049c3276be3e7c23f343d2d1c540d1b42417e891763
size 709967
oid sha256:8213079114149b25ea09880e4f1a9b32319c9e6cb12a03482868ac588f91ede8
size 709956

4
lib/search/indexes/github-docs-dotcom-cn.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:b3af68616e0a812403d6eb29e006bd35aac453995c5c45a80131ae20e54f4de1
size 969482
oid sha256:415432a50b29b796eb30d594d542472a5b1c04448dfec6f0b9afa461bceb8c8b
size 968891

4
lib/search/indexes/github-docs-dotcom-de-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:2d42259227fe10ebae621618e381e5d2e3254c15eec7a87d16de7908b7abc2b6
size 647583
oid sha256:b915c3fc0573caae66035fbafb34eb9818fd40661f0a39898b77eece2af20e0b
size 647562

4
lib/search/indexes/github-docs-dotcom-de.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:bf58c7aba8d97ca8f1fb5ef107c6850fd319420e92f702643a4ae163c5be3495
size 2900961
oid sha256:56bf4ca637ef1dbe4b129d08a206041cb0b8b8e3577bc77884d41b62188033ac
size 2900896

4
lib/search/indexes/github-docs-dotcom-en-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:4359096f56cd90fb58103ef2360fc090477b22f90da08c7deedaa067a7f736e2
size 624961
oid sha256:d196f9c7756b9886e5933d26c73fc13d7a523c7992711c3e16a432c0512d2f94
size 625647

4
lib/search/indexes/github-docs-dotcom-en.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:19ea745b368c7611d19304785980a207c6a9a7a82379ebc806ea4107eab3bb80
size 2382638
oid sha256:2b9171a7f0b4e94cd7941727f1a5edc74a02a33100525896826f7ed510a66627
size 2383103

4
lib/search/indexes/github-docs-dotcom-es-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:7b080fa9fa2d0e5261f90b804501a87f98981bace97354cda4c3e2a3b273cdb0
size 306734
oid sha256:5a3409dc69739f27392559a49ba28037232f6b9569ce89922cee32af130a4987
size 306417

4
lib/search/indexes/github-docs-dotcom-es.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:63f424f5bf7a5fb438a417ffd86dbd3640ae36302ada5daa9571342b1324c323
size 1088661
oid sha256:4a3960fbebc7a56079d4055a09145fae57a0c58a83449951d163d136d92282cf
size 1088356

4
lib/search/indexes/github-docs-dotcom-ja-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:6dff7e7ac52450dc1df4ff6d69bbc78fa7dcb628c3ceb69930a755cae6859d91
size 738353
oid sha256:1fddad2f0bb41bd26898defb8340d2595d6266e5e178baf955e2f2eb2ced2c48
size 738740

4
lib/search/indexes/github-docs-dotcom-ja.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:81604439a004e8fd1a97bcbd81a202a198afe6d427fb77c2e61b732336d11506
size 3850840
oid sha256:4ad93f6ec7201f2350ca4710d06a57d072cabd0aba683856b2974ea532417e40
size 3851921

4
lib/search/indexes/github-docs-dotcom-pt-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:7f285b114a9570f448fa118243b430350c1b8caf0081049c173328f16925aaea
size 621270
oid sha256:941b860f4e048fac2f8d0b82e8670e8ab12957562dd1b71a0b3ca3b07b7e59d4
size 621675

4
lib/search/indexes/github-docs-dotcom-pt.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:e749acee66c93e270cbaf90c0a9f7e196efcdddd9286c9badec6c40c86cd5179
size 2551339
oid sha256:8484e29c9069ff79423ee1f333ca2a13007d49a2a265e648bda2aea39fe0058d
size 2552951

4
lib/search/indexes/github-docs-ghae-cn-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:a1c1b21df518d2fc1c3ce63dd92faf9b43abf0e2018038c89727e132c315054c
size 413987
oid sha256:e4f97c2912bf217933fac43fb54426e921b6426c6a5559446d9686dd99b67dcf
size 414560

4
lib/search/indexes/github-docs-ghae-cn.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:05f06381bc99123b6d628f4ab4b27996f72a17729cb8d77d1e886bb4ed9cd2d1
size 630520
oid sha256:7e580e998160c45051eb6d04abd385ecc4837adb05ccca271512073f2909deff
size 631102

4
lib/search/indexes/github-docs-ghae-de-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:fd67479a52777d96790170d28517cb0fb7ce5c5f369c42b8a29458be5554d8c5
size 390887
oid sha256:bd0774b2ecb79f098adba89bcb0c99419ef00aaeeaf654288c0ac5d3606cee36
size 390597

4
lib/search/indexes/github-docs-ghae-de.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:d0464436b7115120c8e96b48ccbc2d5e0299cbf4e95ccf34b6cc21063565668c
size 1698506
oid sha256:95403bdac8a14343aff0ccc7cdfe2a6d3b2272189f7849ddec28a84f3c12eab1
size 1698002

4
lib/search/indexes/github-docs-ghae-en-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:fb7ae124d39cac3f0cfe79f4b8cfdd800c327b672f7566cca58ef0a9c71bb2fa
size 361222
oid sha256:72874c7787d5dc687bd693045455450d4a9f6cfa72426b29acc3ef637da54c2d
size 360968

4
lib/search/indexes/github-docs-ghae-en.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:aa054755d5887a5c23a1904d91b72e41de6831dadf653164e0d890045429fee2
size 1355681
oid sha256:2df420e4e21612d2d9845c6eec1a0986ee9a8720fbab52b17acda36885c7eb95
size 1355140

4
lib/search/indexes/github-docs-ghae-es-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:1371fd2b83a90d158a48c89165066cec8a178d9f8231420c11578d4c57683603
size 200670
oid sha256:8df1fc40c8bf95301061cea22e7309028c22455e696933b16dc500876de2423a
size 200650

4
lib/search/indexes/github-docs-ghae-es.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:3d3f1d52e716f227c0a3f3f52b8844f9ee175e202c57ae6f3d9cb65defdf2e1d
size 718327
oid sha256:5cf7c31077cf6d6d76f99e81664c92412543cd4b467823096ca483e776716195
size 717873

4
lib/search/indexes/github-docs-ghae-ja-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:d87c67a203031450ea645ea0104b83f23404fe30e5341a1e6eb564ba1144d5b2
size 435820
oid sha256:2c35bacf76d95820518440a095f2be3462c81886502a5b5e3940538995b73cdd
size 435272

4
lib/search/indexes/github-docs-ghae-ja.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:489c96422469418d549b0afe6b30ddc27f132c1a0f6f14cb85e54cbbbbadabdc
size 2219136
oid sha256:071f0c303c64a5e5e7d3f5d008e926088f57394be187e13423e320d6c770452f
size 2216859

4
lib/search/indexes/github-docs-ghae-pt-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:6616699dd1c75bb92f29bd6c34d83e30fea1103f49fb98f3f452ed503bace575
size 371851
oid sha256:fead09126527247ead95babf1fd3759262f6d60909cc49872ffceb75c6ad6d40
size 371427

4
lib/search/indexes/github-docs-ghae-pt.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:9c9cd82dc0e94da243ac72662a7578119278ce7de2b7646d5338764ab1020098
size 1497462
oid sha256:f086d6d79306f8923cefcb8e873a8224a29382cb37ba1572d13a5e11fd86c4fe
size 1495858

44
lib/webhooks/README.md Normal file
View File

@@ -0,0 +1,44 @@
# Webhooks
## About this directory
* `lib/webhooks/index.js` is human-editable.
* `lib/rest/static/**/*.payload.json` are manually edited and copied. When a new GHES release is created, the static webhook files from the previous version's directory are copied to a new version directory.
## Editable files
* `lib/webhooks/index.js` consumes the static JSON files in `lib/webhooks/static` and exports the data used by the REST middleware contextualizer.
## Static files
Generated by `script/rest/update-files.js`:
* `lib/rest/static/dereferenced` - dereferenced OpenAPI schema file for each version of GitHub
* `lib/rest/static/decorated` - files generated from the dereferenced OpenAPI schema with the Markdown descriptions rendered in HTML
## Rendering docs
When the server starts, `middleware/contextualizers/webhooks.js` accesses the data exported from the static webhook JSON files, fetches the data for the current version and requested path, and adds it to the `context` object. The added property is:
* `req.context.webhookPayloadsForCurrentVersion` - all webhook payloads with a version matching the current version
Markdown files in `content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md` use Liquid to display the webhook payloads in `req.context.webhookPayloadsForCurrentVersion`. For example `{{ webhookPayloadsForCurrentVersion.user.created }}` references the payload file `user.created.payload.json` for the version being viewed.
**Note** Payload files either contain the webhook action type or no action type at all. For example, `user.created.payload.json` is the webhook `user` with the action type of `created`. Not all webhooks have action types. If a file exists with no action type (e.g., `user.payload.json`) and the action types (e.g., `user.created.payload.json` and `user.deleted.payload.json`), the entry in the context for the file with no action type will be `default`. For example, for the three static file mentioned, the object would be:
```
{
user: {
default: "STRING VALUE",
created: "STRING VALUE",
deleted: "STRING VALUE"
}
}
```
If no action types exist, and only `user.payload.json` exists, the object would be:
```
{
user: "STRING VALUE"
}

7
lib/webhooks/index.js
View File

@@ -19,7 +19,12 @@ versions.forEach((version) => {
walk(versionSubdir, { includeBasePath: true }).forEach((payloadFile) => {
// payload file: /path/to/check_run.completed.payload.json
// payload path: check_run.completed
const payloadPath = path.basename(payloadFile).replace('.payload.json', '')
let payloadPath = path.basename(payloadFile).replace('.payload.json', '')
if (!payloadPath.includes('.') && payloadsPerVersion[payloadPath]) {
// append the key `default` to the payload path to
// prevent overwriting existing object
payloadPath = `${payloadPath}.default`
}
set(
payloadsPerVersion,
payloadPath,

7
script/deployment/deploy-to-staging.js
View File

@@ -2,6 +2,7 @@
import sleep from 'await-sleep'
import got from 'got'
import Heroku from 'heroku-client'
import { setOutput } from '@actions/core'
import createStagingAppName from './create-staging-app-name.js'
const SLEEP_INTERVAL = 5000
@@ -106,6 +107,12 @@ export default async function deployToStaging({
// Store this ID for later updating
deploymentId = deployment.id
// Set some output variables for workflow steps that run after this script
if (process.env.GITHUB_ACTIONS) {
setOutput('deploymentId', deploymentId)
setOutput('logUrl', logUrl)
}
await octokit.repos.createDeploymentStatus({
owner,
repo,

2
script/rest/utils/create-code-samples.js
View File

@@ -158,6 +158,7 @@ function getExampleParamValue(name, schema) {
// TODO: figure out the right behavior here
if (schema.oneOf && schema.oneOf[0].type) return getExampleParamValue(name, schema.oneOf[0])
if (schema.anyOf && schema.anyOf[0].type) return getExampleParamValue(name, schema.anyOf[0])
if (!schema.type) return 'any'
switch (schema.type) {
case 'string':
@@ -173,5 +174,6 @@ function getExampleParamValue(name, schema) {
case 'array':
return [getExampleParamValue(name, schema.items)]
}
throw new Error(`Unknown data type in schema:, ${JSON.stringify(schema, null, 2)}`)
}

Some files were not shown because too many files have changed in this diff Show More