diff --git a/.github/workflows/test-translations.yml b/.github/workflows/test-translations.yml new file mode 100644 index 0000000000..f5412aa74b --- /dev/null +++ b/.github/workflows/test-translations.yml @@ -0,0 +1,63 @@ +name: Translations tests + +# **What it does**: Runs our translation tests on cron. +# **Why we have it**: We want to know if translations act up, but they are in separate repositories. +# **Who does it impact**: Docs engineering. + +on: + workflow_dispatch: + schedule: + - cron: '35 16 * * *' # Run once per day at 16:35 UTC / 9:35 PST + +permissions: + contents: read + pull-requests: read + +# This allows a subsequently queued workflow run to interrupt previous runs +concurrency: + group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}' + cancel-in-progress: true + +jobs: + test: + if: github.repository == 'github/docs-internal' + runs-on: ubuntu-20.04-xl + timeout-minutes: 60 + steps: + - name: Check out repo + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 + + - name: Setup node + uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048 + with: + node-version: '16.17.0' + cache: npm + + - name: Install dependencies + run: npm ci + + - name: Cache nextjs build + uses: actions/cache@48af2dc4a9e8278b89d7fa154b955c30c6aaab09 + with: + path: .next/cache + key: ${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }} + + - name: Run build script + run: npm run build + + - name: Run tests + run: npm test -- tests/translations + + send-slack-notification-on-failure: + needs: [test] + runs-on: ubuntu-20.04-xl + if: ${{ failure() }} + steps: + - name: Send Slack notification if workflow failed + uses: someimportantcompany/github-actions-slack-message@f8d28715e7b8a4717047d23f48c39827cacad340 + if: ${{ failure() }} + with: + channel: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }} + bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }} + color: failure + text: Translations test failure. See https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }} diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index a3bd592e2d..76ecff7919 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -11,7 +11,6 @@ on: permissions: contents: read - # Needed for the 'trilom/file-changes-action' action pull-requests: read # This allows a subsequently queued workflow run to interrupt previous runs @@ -37,17 +36,7 @@ jobs: strategy: fail-fast: false matrix: - test-group: - [ - content, - graphql, - meta, - rendering, - routing, - unit, - linting, - translations, - ] + test-group: [content, graphql, meta, rendering, routing, unit, linting] steps: - name: Install a local Elasticsearch for testing # For the sake of saving time, only run this step if the test-group diff --git a/components/release-notes/GHESReleaseNotes.tsx b/components/release-notes/GHESReleaseNotes.tsx index 080772dd88..3325ca02c1 100644 --- a/components/release-notes/GHESReleaseNotes.tsx +++ b/components/release-notes/GHESReleaseNotes.tsx @@ -11,10 +11,12 @@ import { GHESReleaseNotesContextT } from './types' import { GHESReleaseNotePatch } from './GHESReleaseNotePatch' import styles from './PatchNotes.module.scss' +import { PlainLink } from './PlainLink' type Props = { context: GHESReleaseNotesContextT } + export function GHESReleaseNotes({ context }: Props) { const router = useRouter() const { currentProduct } = useMainContext() @@ -59,16 +61,24 @@ export function GHESReleaseNotes({ context }: Props) { {releases.map((release) => { const releaseLink = `/${router.locale}/${currentVersion.plan}@${release.version}/${currentProduct?.id}/release-notes` + // Use client-side router link component only if it's a supported release. + // Otherwise, it will trigger a NextJS data XHR fetch for releases + // that are deprecated when in fact you should load it regularly + // so it's read as a proxy from the archive. + const LinkComponent = currentVersion.releases.includes(release.version) + ? Link + : PlainLink + if (!release.patches || release.patches.length === 0) { return (
  • - {release.version} - +
    • ) } @@ -86,7 +96,7 @@ export function GHESReleaseNotes({ context }: Props) { return (
  • - @@ -95,7 +105,7 @@ export function GHESReleaseNotes({ context }: Props) { {release.patches.length}{' '} {release.patches.length === 1 ? 'release' : 'releases'} - +
    • ) })} diff --git a/components/release-notes/PlainLink.tsx b/components/release-notes/PlainLink.tsx new file mode 100644 index 0000000000..c05191bc1d --- /dev/null +++ b/components/release-notes/PlainLink.tsx @@ -0,0 +1,15 @@ +import type { ReactNode } from 'react' + +type PlainLinkProps = { + href: string + children: ReactNode + className?: string +} + +export function PlainLink({ href, className, children }: PlainLinkProps) { + return ( + + {children} + + ) +} diff --git a/components/release-notes/types.ts b/components/release-notes/types.ts index 514deba2c9..ebd53f079f 100644 --- a/components/release-notes/types.ts +++ b/components/release-notes/types.ts @@ -3,6 +3,7 @@ export type CurrentVersion = { planTitle: string versionTitle: string currentRelease: string + releases: string[] } export type GHESMessage = { diff --git a/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md b/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md index 6233696e7e..1f27d3db5c 100644 --- a/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md +++ b/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md @@ -4,6 +4,7 @@ shortTitle: Manage access with runner groups intro: You can use policies to limit access to self-hosted runners that have been added to an organization or enterprise. redirect_from: - /actions/hosting-your-own-runners/managing-access-to-self-hosted-runners +miniTocMaxHeadingLevel: 3 versions: fpt: '*' ghes: '*' @@ -15,6 +16,10 @@ type: tutorial {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% ifversion target-runner-groups %} +For information on how to route jobs to runners in a specific group, see "[Choosing runners in a group](/actions/using-jobs/choosing-the-runner-for-a-job#choosing-runners-in-a-group)." +{% endif %} + ## About runner groups {% data reusables.actions.about-runner-groups %} {% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups).{% endif %} @@ -71,3 +76,5 @@ type: tutorial {% data reusables.actions.removing-a-runner-group %} {% endif %} + +{% data reusables.actions.section-using-unique-names-for-runner-groups %} diff --git a/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md b/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md index 5d1ed73046..c984702305 100644 --- a/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md @@ -13,7 +13,7 @@ shortTitle: Label runners {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -For information on how to use labels to route jobs to specific types of self-hosted runners, see "[Using self-hosted runners in a workflow](/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow)." +For information on how to use labels to route jobs to specific types of self-hosted runners, see "[Using self-hosted runners in a workflow](/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow)." {% ifversion target-runner-groups %}You can also route jobs to runners in a specific group. For more information, see "[Targeting runners in a group](/actions/using-jobs/choosing-the-runner-for-a-job#targeting-runners-in-a-group)."{% endif %} {% data reusables.actions.self-hosted-runner-management-permissions-required %} diff --git a/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md b/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md index 97c4628d94..5255ee9629 100644 --- a/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md +++ b/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md @@ -3,6 +3,7 @@ title: Controlling access to larger runners shortTitle: 'Control access to {% data variables.actions.hosted_runner %}s' intro: 'You can use policies to limit access to {% data variables.actions.hosted_runner %}s that have been added to an organization or enterprise.' product: '{% data reusables.gated-features.hosted-runners %}' +miniTocMaxHeadingLevel: 3 versions: feature: actions-hosted-runners type: tutorial @@ -29,6 +30,8 @@ type: tutorial {% endif %} +{% data reusables.actions.section-using-unique-names-for-runner-groups %} + ## Changing the access policy of a runner group {% data reusables.actions.hosted-runner-security-admonition %} diff --git a/content/actions/using-github-hosted-runners/using-larger-runners.md b/content/actions/using-github-hosted-runners/using-larger-runners.md index b0f14df4a0..c93e08c819 100644 --- a/content/actions/using-github-hosted-runners/using-larger-runners.md +++ b/content/actions/using-github-hosted-runners/using-larger-runners.md @@ -28,13 +28,13 @@ When you add a {% data variables.actions.hosted_runner %} to an organization, yo ## Architectural overview of {% data variables.actions.hosted_runner %}s -The {% data variables.actions.hosted_runner %}s are managed at the organization level, where they are arranged into groups that can contain multiple instances of the runner. They can also be created at the enterprise level and shared with organizations in the hierarchy. Once you've created a group, you can then add a runner to the group and update your workflows to target the label assigned to the {% data variables.actions.hosted_runner %}. You can also control which repositories are permitted to send jobs to the group for processing. For more information about groups, see "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." +The {% data variables.actions.hosted_runner %}s are managed at the organization level, where they are arranged into groups that can contain multiple instances of the runner. They can also be created at the enterprise level and shared with organizations in the hierarchy. Once you've created a group, you can then add a runner to the group and update your workflows to target either the group name or the label assigned to the {% data variables.actions.hosted_runner %}. You can also control which repositories are permitted to send jobs to the group for processing. For more information about groups, see "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." In the following diagram, a class of hosted runner named `ubuntu-20.04-16core` has been defined with customized hardware and operating system configuration. ![Diagram explaining {% data variables.actions.hosted_runner %}](/assets/images/hosted-runner.png) -1. Instances of this runner are automatically created and added to a group called `ubuntu-20.04-16core`. +1. Instances of this runner are automatically created and added to a group called `grp-ubuntu-20.04-16core`. 2. The runners have been assigned the label `ubuntu-20.04-16core`. 3. Workflow jobs use the `ubuntu-20.04-16core` label in their `runs-on` key to indicate the type of runner they need to execute the job. 4. {% data variables.product.prodname_actions %} checks the runner group to see if your repository is authorized to send jobs to the runner. @@ -99,14 +99,25 @@ You can add a {% data variables.actions.hosted_runner %} to an organization, whe ## Running jobs on your runner -Once your runner type has been defined, you can update your workflow YAML files to send jobs to your newly created runner instances for processing. In this example, a runner group is populated with Ubuntu 16-core runners, which have been assigned the label `ubuntu-20.04-16core`. If you have a runner matching this label, the `check-bats-version` job then uses the `runs-on` key to target that runner whenever the job is run: +Once your runner type has been defined, you can update your workflow YAML files to send jobs to your newly created runner instances for processing. You can use runner groups or labels to define where your jobs run. + +Only owner or administrator accounts can see the runner settings. Non-administrative users can contact the organization administrator to find out which runners are enabled. Your organization administrator can create new runners and runner groups, as well as configure permissions to specify which repositories can access a runner group. + +### Using groups to control where jobs are run + +{% data reusables.actions.jobs.example-runs-on-groups %} + +### Using labels to control where jobs are run + +In this example, a runner group is populated with Ubuntu 16-core runners, which have also been assigned the label `ubuntu-20.04-16core`. The `runs-on` key sends the job to any available runner with a matching label: ```yaml name: learn-github-actions on: [push] jobs: check-bats-version: - runs-on: ubuntu-20.04-16core + runs-on: + labels: ubuntu-20.04-16core steps: - uses: {% data reusables.actions.action-checkout %} - uses: {% data reusables.actions.action-setup-node %} @@ -116,7 +127,33 @@ jobs: - run: bats -v ``` -To find out which runners are enabled for your repository and organization, you must contact your organization admin. Your organization admin can create new runners and runner groups, as well as configure permissions to specify which repositories can access a runner group. +### Using labels and groups to control where jobs are run + +{% data reusables.actions.jobs.example-runs-on-labels-and-groups %} + +### Using multiple labels + +You can specify multiple labels that need to be matched for a job to run on a runner. A runner will need to match all labels to be eligible to run the job. + +In this example, a runner will need to match all three of the labels to run the job: + +```yaml +name: learn-github-actions +on: [push] +jobs: + check-bats-version: + runs-on: + labels: [ ubuntu-20.04-16core, gpu, qa ] + steps: + - uses: {% data reusables.actions.action-checkout %} + - uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '14' + - run: npm install -g bats + - run: bats -v +``` + +{% data reusables.actions.section-using-unique-names-for-runner-groups %} ## Managing access to your runners diff --git a/content/actions/using-jobs/choosing-the-runner-for-a-job.md b/content/actions/using-jobs/choosing-the-runner-for-a-job.md index 672d326e5d..34f82c6d41 100644 --- a/content/actions/using-jobs/choosing-the-runner-for-a-job.md +++ b/content/actions/using-jobs/choosing-the-runner-for-a-job.md @@ -2,12 +2,12 @@ title: Choosing the runner for a job shortTitle: Choose the runner for a job intro: Define the type of machine that will process a job in your workflow. +miniTocMaxHeadingLevel: 3 versions: fpt: '*' ghes: '*' ghae: '*' ghec: '*' -miniTocMaxHeadingLevel: 4 --- {% data reusables.actions.enterprise-beta %} diff --git a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md index ca865d3bdf..9393626b1e 100644 --- a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md +++ b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md @@ -185,6 +185,7 @@ An overview of some of the most common actions that are recorded as events in th | `remove_member` | Triggered when a {% data variables.product.product_name %} user is [removed from a repository as a collaborator](/articles/removing-a-collaborator-from-a-personal-repository). | `remove_topic` | Triggered when a repository owner removes a topic from a repository. | `rename` | Triggered when [a repository is renamed](/articles/renaming-a-repository). +| `staff_unlock` | Triggered when an enterprise owner or {% data variables.contact.github_support %} (with permission from a repository administrator) temporarily unlocked the repository. The visibility of the repository isn't changed. | `transfer` | Triggered when [a repository is transferred](/articles/how-to-transfer-a-repository). | `transfer_start` | Triggered when a repository transfer is about to occur. | `unarchived` | Triggered when a repository owner unarchives a repository. diff --git a/content/code-security/security-overview/about-the-security-overview.md b/content/code-security/security-overview/about-the-security-overview.md index c763b80753..b0a48cb627 100644 --- a/content/code-security/security-overview/about-the-security-overview.md +++ b/content/code-security/security-overview/about-the-security-overview.md @@ -41,7 +41,7 @@ The application security team at your company can use the security overview for In the security overview, you can view, sort, and filter alerts to understand the security risks in your organization and in specific repositories. The security summary is highly interactive, allowing you to investigate specific categories of information, based on qualifiers like alert risk level, alert type, and feature enablement. You can also apply multiple filters to focus on narrower areas of interest. For example, you can identify private repositories that have a high number of {% data variables.product.prodname_dependabot_alerts %} or repositories that have no {% data variables.product.prodname_code_scanning %} alerts. For more information, see "[Filtering alerts in the security overview](/code-security/security-overview/filtering-alerts-in-the-security-overview)." -{% ifversion security-overview-views %} +{% ifversion security-overview-alert-views %} In the security overview, there are dedicated views for each type of security alert, such as Dependabot, code scanning, and secret scanning alerts. You can use these views to limit your analysis to a specific set of alerts, and narrow the results further with a range of filters specific to each view. For example, in the secret scanning alert view, you can use the `Secret type` filter to view only secret scanning alerts for a specific secret, like a GitHub {% data variables.product.pat_generic %}. At the repository level, you can use the security overview to assess the specific repository's current security status, and configure any additional security features not yet in use on the repository. diff --git a/content/code-security/security-overview/filtering-alerts-in-the-security-overview.md b/content/code-security/security-overview/filtering-alerts-in-the-security-overview.md index 14bb132945..673f117c04 100644 --- a/content/code-security/security-overview/filtering-alerts-in-the-security-overview.md +++ b/content/code-security/security-overview/filtering-alerts-in-the-security-overview.md @@ -108,7 +108,7 @@ Available in the organization-level overview. | -------- | -------- | | topic:TOPIC-NAME | Displays repositories that are classified with *TOPIC-NAME*. | -{% ifversion security-overview-views %} +{% ifversion security-overview-alert-views %} ## Filter by severity diff --git a/content/code-security/security-overview/viewing-the-security-overview.md b/content/code-security/security-overview/viewing-the-security-overview.md index 899fcc3ea4..c61f198f3e 100644 --- a/content/code-security/security-overview/viewing-the-security-overview.md +++ b/content/code-security/security-overview/viewing-the-security-overview.md @@ -30,7 +30,7 @@ shortTitle: View the security overview 1. To view aggregate information about alert types, click **Show more**. ![Show more button](/assets/images/help/organizations/security-overview-show-more-button.png) {% data reusables.organizations.filter-security-overview %} -{% ifversion security-overview-views %} +{% ifversion security-overview-alert-views %} {% data reusables.organizations.security-overview-feature-specific-page %} ![Screenshot of the code scanning-specific page](/assets/images/help/organizations/security-overview-code-scanning-alerts.png) diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md index 704456d6fe..479d8831f6 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md @@ -686,6 +686,7 @@ For more information, see "[Managing the publication of {% data variables.produc | `set_actions_fork_pr_approvals_policy` | Triggered when the setting for requiring approvals for workflows from public forks is changed. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks)."{% endif %} | `set_actions_retention_limit` | Triggered when the retention period for {% data variables.product.prodname_actions %} artifacts and logs is changed. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% ifversion fpt or ghes or ghec %} | `set_fork_pr_workflows_policy` | Triggered when the policy for workflows on private repository forks is changed. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %} +| `staff_unlock` | Triggered when an enterprise owner or {% data variables.contact.github_support %} (with permission from a repository administrator) temporarily unlocked the repository. The visibility of the repository isn't changed. | `transfer` | Triggered when [a repository is transferred](/articles/how-to-transfer-a-repository). | `transfer_start` | Triggered when a repository transfer is about to occur. | `unarchived` | Triggered when a repository admin unarchives a repository.{% ifversion fpt or ghes or ghec %} diff --git a/content/rest/codespaces/organizations.md b/content/rest/codespaces/organizations.md index 73dea8ccd4..d8537378c0 100644 --- a/content/rest/codespaces/organizations.md +++ b/content/rest/codespaces/organizations.md @@ -11,8 +11,6 @@ topics: miniTocMaxHeadingLevel: 3 --- -{% data reusables.codespaces.codespaces-api-beta-note %} - ## About the Codespaces organizations API The {% data variables.product.prodname_codespaces %} organizations API enables diff --git a/content/support/learning-about-github-support/about-github-support.md b/content/support/learning-about-github-support/about-github-support.md index 04082b58ee..f5d6525f05 100644 --- a/content/support/learning-about-github-support/about-github-support.md +++ b/content/support/learning-about-github-support/about-github-support.md @@ -122,7 +122,7 @@ Enterprise owners can also add support entitlements to members of organizations {% ifversion fpt or ghec %} ## Granting {% data variables.contact.github_support %} temporary access to a private repository -If {% data variables.contact.github_support %} needs to access a private repository to address your support request, the owner of the repository will receive an email with a link to accept or decline temporary access. The owner will have 20 days to accept or decline the request before the request expires. If the owner accepts the request, {% data variables.contact.github_support %} will have access the repository for five days. +If {% data variables.contact.github_support %} needs to access a private repository to address your support request, the owner of the repository will receive an email with a link to accept or decline temporary access. The owner will have 20 days to accept or decline the request before the request expires. If the owner accepts the request, {% data variables.contact.github_support %} will have access the repository for five days. During this window, {% data variables.contact.github_support %} staff with the required privileges can unlock the repository for up to two hours at a time, and will relock the repository if the work is completed early. All {% data variables.contact.github_support %} staff access generates audit log events, and the visibility of the repository is not affected at any time. {% data variables.contact.github_support %} will never access your private repositories without your explicit consent. For more information, see the [Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service#3-access). {% endif %} diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index 368d299d1d..e621358568 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -446,6 +446,21 @@ Always use "dev container" (or, where clarification is needed, its longer form " Use "development container configuration files" to refer to all of the files in the `.devcontainer` directory (plus the `.devcontainer.json` if that's being used rather than `devcontainer.json` in the `.devcontainer` directory). Don't refer to these as "development container files" or "devcontainer files" to avoid this being taken as referring to `devcontainer.json` files. "Development container configuration files" refers to all of the files that can be used to configure a dev container, including `Dockerfile` and `docker-compose.yml` files. Don't use "the development container configuration file" (singular) when referring specifically to a `devcontainer.json` file. Instead refer to this file by its name. +### Personal access tokens + +GitHub has two types of personal access tokens: + +- Fine-grained personal access tokens: Offer granular control over repository access and permissions +- Personal access tokens (classic): Use scopes and grant access to all repositories that the token owner can access + +You should use variables to refer to these types of tokens, as well as to personal access tokens in general: + +- Use `{% data variables.product.pat_generic %}` or `{% data variables.product.pat_generic_caps %}` to refer to personal access tokens in general. +- Use `{% data variables.product.pat_v2 %}` or `{% data variables.product.pat_v2_caps %}` to refer to fine-grained personal access tokens. +- Use `{% data variables.product.pat_v1 %}`, `{% data variables.product.pat_v1_plural %}`, `{% data variables.product.pat_v1_caps %}`, or `{% data variables.product.pat_v1_caps_plural %}` to refer to personal access tokens (classic). + +For more information about GitHub's personal access tokens, see "[Creating a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#about-personal-access-tokens)." + ## Punctuation Follow standard American English punctuation rules. For more guidance, see “[Punctuation](https://docs.microsoft.com/style-guide/punctuation)” in the Microsoft Style Guide. diff --git a/data/features/security-overview-alert-views.yml b/data/features/security-overview-alert-views.yml new file mode 100644 index 0000000000..b0eecb70f5 --- /dev/null +++ b/data/features/security-overview-alert-views.yml @@ -0,0 +1,6 @@ +# Reference: #5503. +# Documentation for the security overview individual views for each type of security alert +versions: + ghes: '> 3.4' + ghae: '>= 3.5' + ghec: '*' diff --git a/data/features/security-overview-views.yml b/data/features/security-overview-views.yml deleted file mode 100644 index 72e6f27460..0000000000 --- a/data/features/security-overview-views.yml +++ /dev/null @@ -1,6 +0,0 @@ -# Reference: #5503. -# Documentation for the security overview individual views -versions: - ghes: '> 3.4' - ghae: '>= 3.5' - ghec: '*' diff --git a/data/features/target-runner-groups.yml b/data/features/target-runner-groups.yml new file mode 100644 index 0000000000..1605cf958b --- /dev/null +++ b/data/features/target-runner-groups.yml @@ -0,0 +1,7 @@ +# Reference: #8268 +# Restrict workflow using runner group names +versions: + fpt: '*' + ghec: '*' + ghes: '>= 3.8' + ghae: '>= 3.8' diff --git a/data/reusables/actions/jobs/example-runs-on-groups.md b/data/reusables/actions/jobs/example-runs-on-groups.md new file mode 100644 index 0000000000..2d84d1ac8f --- /dev/null +++ b/data/reusables/actions/jobs/example-runs-on-groups.md @@ -0,0 +1,17 @@ +In this example, Ubuntu 16-core runners have been added to a group called `ubuntu-runners`. The `runs-on` key sends the job to any available runner in the `ubuntu-runners` group: + +```yaml +name: learn-github-actions +on: [push] +jobs: + check-bats-version: + runs-on: + group: ubuntu-runners + steps: + - uses: {% data reusables.actions.action-checkout %} + - uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '14' + - run: npm install -g bats + - run: bats -v +``` diff --git a/data/reusables/actions/jobs/example-runs-on-labels-and-groups.md b/data/reusables/actions/jobs/example-runs-on-labels-and-groups.md new file mode 100644 index 0000000000..56c3646393 --- /dev/null +++ b/data/reusables/actions/jobs/example-runs-on-labels-and-groups.md @@ -0,0 +1,20 @@ +When you combine groups and labels, the runner must meet both requirements to be eligible to run the job. + +In this example, a runner group called `ubuntu-runners` is populated with Ubuntu 16-core runners, which have also been assigned the label `ubuntu-20.04-16core`. The `runs-on` key combines `group` and `labels` so that the job is routed to any available runner within the group that also has a matching label: + +```yaml +name: learn-github-actions +on: [push] +jobs: + check-bats-version: + runs-on: + group: ubuntu-runners + labels: ubuntu-20.04-16core + steps: + - uses: {% data reusables.actions.action-checkout %} + - uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '14' + - run: npm install -g bats + - run: bats -v +``` diff --git a/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md b/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md index 1a46d87713..23a85fc242 100644 --- a/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md +++ b/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md @@ -1,5 +1,12 @@ -Use `jobs..runs-on` to define the type of machine to run the job on. {% ifversion fpt or ghec %}The machine can be either a {% data variables.product.prodname_dotcom %}-hosted runner or a self-hosted runner.{% endif %} You can provide `runs-on` as a single string or as an array of strings. If you specify an array of strings, your workflow will run on a self-hosted runner whose labels match all of the specified `runs-on` values, if available. If you would like to run your workflow on multiple machines, use [`jobs..strategy`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategy). +Use `jobs..runs-on` to define the type of machine to run the job on. +{% ifversion fpt or ghec %}- The destination machine can be either a [{% data variables.product.prodname_dotcom %}-hosted runner](#choosing-github-hosted-runners), [{% data variables.actions.hosted_runner %}](#choosing-runners-in-a-group), or a [self-hosted runner](#choosing-self-hosted-runners).{% else %} +- The destination machine can be a [self-hosted runner](#choosing-self-hosted-runners).{% endif %} +{% ifversion target-runner-groups %}- You can target runners based on the labels assigned to them, or their group membership, or a combination of these.{% else %} +- You can target runners based on the labels assigned to them.{% endif %} +- You can provide `runs-on` as a single string or as an array of strings. +- If you specify an array of strings, your workflow will execute on any runner that matches all of the specified `runs-on` values. +- If you would like to run your workflow on multiple machines, use [`jobs..strategy`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategy). {% ifversion fpt or ghec or ghes %} {% data reusables.actions.enterprise-github-hosted-runners %} @@ -34,3 +41,21 @@ runs-on: [self-hosted, linux] ``` For more information, see "[About self-hosted runners](/github/automating-your-workflow-with-github-actions/about-self-hosted-runners)" and "[Using self-hosted runners in a workflow](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)." + +{% ifversion target-runner-groups %} + +### Choosing runners in a group + +You can use `runs-on` to target runner groups, so that the job will execute on any runner that is a member of that group. For more granular control, you can also combine runner groups with labels. + +Runner groups can only have [{% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/using-larger-runners) or [self-hosted runners](/actions/hosting-your-own-runners) as members. + +#### Example: Using groups to control where jobs are run + +{% data reusables.actions.jobs.example-runs-on-groups %} + +#### Example: Combining groups and labels + +{% data reusables.actions.jobs.example-runs-on-labels-and-groups %} + +{% endif %} \ No newline at end of file diff --git a/data/reusables/actions/section-using-unique-names-for-runner-groups.md b/data/reusables/actions/section-using-unique-names-for-runner-groups.md new file mode 100644 index 0000000000..db66a70838 --- /dev/null +++ b/data/reusables/actions/section-using-unique-names-for-runner-groups.md @@ -0,0 +1,34 @@ + +{% ifversion target-runner-groups %}{% ifversion ghec or ghae or ghes %} +## Using unique names for runner groups + +{% data variables.product.prodname_actions %} requires that runner group names must be unique at the organization level. This means that an organization will no longer be able to create a runner group with the same name as one in the enterprise. In addition, users will see a warning banner on any runner groups that share the same name as a group in the enterprise, suggesting that the organization group should be renamed. + +To avoid ambiguity, a workflow will fail if there are duplicate runner groups in the organization and enterprise. To address this, you can either rename one of your runner groups in the organization or enterprise, or you can update your workflow file to add a prefix to the runner group name: + +- `org/` or `organization/` +- `ent/` or `enterprise/` + +### Example: Using prefixes to differentiate runner groups + +For example, if you have a runner group named `my-group` in the organization and another named `my-group` in the enterprise, you can update your workflow file to use `org/my-group` or `ent/my-group` to differentiate between the two. + +Using `org/`: + +```yaml +runs-on: + group: org/my-group + labels: [ self-hosted, label-1 ] +``` + +Using `ent/`: + +```yaml +runs-on: + group: ent/my-group + labels: [ self-hosted, label-1 ] +``` + +{% endif %} + +{% endif %} diff --git a/data/reusables/codespaces/codespaces-api-beta-note.md b/data/reusables/codespaces/codespaces-api-beta-note.md deleted file mode 100644 index 3d0b4a27eb..0000000000 --- a/data/reusables/codespaces/codespaces-api-beta-note.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note %} - -**Note**: The {% data variables.product.prodname_github_codespaces %} API is currently in public beta and subject to change. - -{% endnote %} diff --git a/lib/redirects/static/client-side-rest-api-redirects.json b/lib/redirects/static/client-side-rest-api-redirects.json index c8d9dca371..7821ca859c 100644 --- a/lib/redirects/static/client-side-rest-api-redirects.json +++ b/lib/redirects/static/client-side-rest-api-redirects.json @@ -846,6 +846,8 @@ "/rest/codespaces#get-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user", "/rest/codespaces#update-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user", "/rest/codespaces#delete-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user", + "/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user", + "/rest/codespaces/codespaces#get-details-about-a-codespace-export": "/rest/codespaces/codespaces#get-details-about-a-codespace-export", "/rest/codespaces#list-machine-types-for-a-codespace": "/rest/codespaces/machines#list-machine-types-for-a-codespace", "/rest/codespaces#start-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user", "/rest/codespaces#stop-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user", @@ -1005,6 +1007,10 @@ "/rest/apps#check-an-authorization": "/rest/apps/oauth-applications#check-an-authorization", "/rest/apps#reset-an-authorization": "/rest/apps/oauth-applications#reset-an-authorization", "/rest/apps#revoke-an-authorization-for-an-application": "/rest/apps/oauth-applications#revoke-an-authorization-for-an-application", + "/rest/enterprise-admin/announcement#get-the-global-announcement-banner": "/rest/enterprise-admin/announcement#get-the-global-announcement-banner", + "/rest/enterprise-admin#announcement": "/rest/enterprise-admin/announcement", + "/rest/enterprise-admin/announcement#set-the-global-announcement-banner": "/rest/enterprise-admin/announcement#set-the-global-announcement-banner", + "/rest/enterprise-admin/announcement#remove-the-global-announcement-banner": "/rest/enterprise-admin/announcement#remove-the-global-announcement-banner", "/rest/enterprise-admin#get-license-information": "/rest/enterprise-admin/license#get-license-information", "/rest/enterprise-admin#get-statistics": "/rest/enterprise-admin/admin-stats#get-statistics", "/rest/enterprise-admin#get-comment-statistics": "/rest/enterprise-admin/admin-stats#get-comment-statistics", diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index b40d14777a..6a19266b59 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -158613,6 +158613,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -160337,6 +160343,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -161941,6 +161953,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -164103,6 +164121,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -165708,6 +165732,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -167670,6 +167700,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -169404,6 +169440,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -171005,6 +171047,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -172654,6 +172702,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -174326,6 +174380,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -176318,6 +176378,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -177979,6 +178045,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -182022,6 +182094,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -184094,6 +184172,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -185851,6 +185935,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -338449,6 +338539,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -338690,6 +338797,18 @@ "name": "secret_scanning_push_protection_enabled_for_new_repositories", "in": "body", "description": "

    Whether secret scanning push protection is automatically enabled for new repositories.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

    " + }, + { + "type": "boolean", + "name": "secret_scanning_push_protection_custom_link_enabled", + "in": "body", + "description": "

    Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.

    " + }, + { + "type": "string", + "name": "secret_scanning_push_protection_custom_link", + "in": "body", + "description": "

    If secret_scanning_push_protection_custom_link_enabled is true, the URL that will be displayed to contributors who are blocked from pushing a secret.

    " } ], "enabledForGitHubApps": true, @@ -339160,6 +339279,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ diff --git a/lib/rest/static/decorated/ghec.json b/lib/rest/static/decorated/ghec.json index 0e25325962..b71f3c9058 100644 --- a/lib/rest/static/decorated/ghec.json +++ b/lib/rest/static/decorated/ghec.json @@ -159063,6 +159063,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -160787,6 +160793,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -162391,6 +162403,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -164553,6 +164571,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -166158,6 +166182,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -168120,6 +168150,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -169854,6 +169890,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -171455,6 +171497,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -173104,6 +173152,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -174776,6 +174830,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -176768,6 +176828,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -178429,6 +178495,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -182472,6 +182544,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -184544,6 +184622,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -186301,6 +186385,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -339834,6 +339924,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -340075,6 +340182,18 @@ "name": "secret_scanning_push_protection_enabled_for_new_repositories", "in": "body", "description": "

    Whether secret scanning push protection is automatically enabled for new repositories.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

    " + }, + { + "type": "boolean", + "name": "secret_scanning_push_protection_custom_link_enabled", + "in": "body", + "description": "

    Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.

    " + }, + { + "type": "string", + "name": "secret_scanning_push_protection_custom_link", + "in": "body", + "description": "

    If secret_scanning_push_protection_custom_link_enabled is true, the URL that will be displayed to contributors who are blocked from pushing a secret.

    " } ], "enabledForGitHubApps": true, @@ -340545,6 +340664,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 795989d7da..7b70a457dc 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -252115,6 +252115,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -252826,6 +252843,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index c7a6179db0..5bc20a80ed 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -56833,6 +56833,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -57111,6 +57128,14 @@ "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "description": "Whether secret scanning push protection is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." + }, + "secret_scanning_push_protection_custom_link": { + "type": "string", + "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." } } }, @@ -57524,6 +57549,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -72016,6 +72058,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -95596,6 +95644,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -97812,6 +97866,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -217088,6 +217148,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -219040,6 +219106,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -220636,6 +220708,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -380005,6 +380083,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -381601,6 +381685,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -446451,6 +446541,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -448586,6 +448682,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -450182,6 +450284,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -454060,6 +454168,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -455828,6 +455942,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -456369,6 +456489,10 @@ "codespaces" ], "operationId": "codespaces/export-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user" + }, "parameters": [ { "name": "codespace_name", @@ -456668,6 +456792,10 @@ "codespaces" ], "operationId": "codespaces/get-export-details-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export" + }, "parameters": [ { "name": "codespace_name", @@ -458398,6 +458526,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -460254,6 +460388,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -531074,6 +531214,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", @@ -537526,8 +537670,8 @@ }, "check-run-completed": { "post": { - "summary": "Check run completed", - "description": "The status of the check run is completed.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run was completed, and a conclusion is available.", "operationId": "check-run/completed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" @@ -537596,7 +537740,6 @@ "application/json": { "schema": { "title": "Check Run Completed Event", - "description": "The status of the check run is now `completed`.", "type": "object", "properties": { "action": { @@ -542029,7 +542172,7 @@ }, "check-run-created": { "post": { - "summary": "Check run created", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "A new check run was created.", "operationId": "check-run/created", "externalDocs": { @@ -542099,7 +542242,6 @@ "application/json": { "schema": { "title": "Check Run Created Event", - "description": "A new check run was created.", "type": "object", "properties": { "action": { @@ -546532,7 +546674,8 @@ }, "check-suite-completed": { "post": { - "summary": "Check suite completed", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, see the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", "operationId": "check-suite/completed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" @@ -563115,7 +563258,8 @@ }, "commit-comment-created": { "post": { - "summary": "Commit comment created", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, see the `pull_request_review_comment` event. For activity relating to issue comments, see the `issue_comment` event. For activity relating to discussion comments, see the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", "operationId": "commit-comment/created", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#commit-comment" @@ -563184,7 +563328,6 @@ "application/json": { "schema": { "title": "commit_comment created event", - "description": "A commit comment is created. The type of activity is specified in the `action` property. ", "type": "object", "properties": { "action": { @@ -582189,7 +582332,8 @@ }, "deploy-key-created": { "post": { - "summary": "Deploy key created", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was created.", "operationId": "deploy-key/created", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -584181,7 +584325,8 @@ }, "deploy-key-deleted": { "post": { - "summary": "Deploy key deleted", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see \"[the GraphQL documentation](https://docs.github.com/graphql/reference/objects#deploykey)\" and \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was deleted.", "operationId": "deploy-key/deleted", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -750186,7 +750331,8 @@ }, "member-added": { "post": { - "summary": "Member added", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", "operationId": "member/added", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -750255,7 +750401,6 @@ "application/json": { "schema": { "title": "member added event", - "description": "Activity related to repository collaborators. The type of activity is specified in the action property.", "type": "object", "properties": { "action": { @@ -752248,7 +752393,8 @@ }, "member-edited": { "post": { - "summary": "Member edited", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", "operationId": "member/edited", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -754324,7 +754470,8 @@ }, "member-removed": { "post": { - "summary": "Member removed", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", "operationId": "member/removed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -756364,7 +756511,8 @@ }, "membership-added": { "post": { - "summary": "Membership added", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", "operationId": "membership/added", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -758482,7 +758630,8 @@ }, "membership-removed": { "post": { - "summary": "Membership removed", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", "operationId": "membership/removed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -760601,8 +760750,8 @@ }, "merge-group-checks-requested": { "post": { - "summary": "Status checks requested for a merge group", - "description": "This event occurs when status checks are requested for a merge group. This typically happens when a merge group is formed by the merge queue because a pull request was queued.\nWhen you receive this event, you'll be expected to perform checks on the head SHA and report status back using check runs or commit statuses.", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.\n\n**Note**: The pull request merge queue feature is currently in limited private beta and subject to change.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", "operationId": "merge-group/checks-requested", "tags": [ "merge-queue" @@ -799469,8 +799618,7 @@ }, "ping": { "post": { - "summary": "Ping event", - "description": "When you create a new webhook, we'll send you a simple ping event to let you know you've set up the webhook correctly. This event isn't stored so it isn't retrievable via the Events API endpoint.", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", "operationId": "ping", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#ping" @@ -799538,7 +799686,6 @@ "content": { "application/json": { "schema": { - "description": "The webhooks ping payload", "type": "object", "properties": { "hook": { @@ -837307,7 +837454,8 @@ }, "pull-request-assigned": { "post": { - "summary": "Pull request assigned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was assigned to a user.", "operationId": "pull-request/assigned", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -842385,7 +842533,8 @@ }, "pull-request-auto-merge-disabled": { "post": { - "summary": "Pull request auto merge disabled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", "operationId": "pull-request/auto-merge-disabled", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -847360,7 +847509,8 @@ }, "pull-request-auto-merge-enabled": { "post": { - "summary": "Pull request auto merge enabled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", "operationId": "pull-request/auto-merge-enabled", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -852335,7 +852485,8 @@ }, "pull-request-closed": { "post": { - "summary": "Pull request closed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", "operationId": "pull-request/closed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -858545,7 +858696,8 @@ }, "pull-request-converted-to-draft": { "post": { - "summary": "Pull request converted to draft", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", "operationId": "pull-request/converted-to-draft", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -864726,7 +864878,8 @@ }, "pull-request-demilestoned": { "post": { - "summary": "Pull request demilestoned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was removed from a milestone.", "operationId": "pull-request/demilestoned", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -869973,7 +870126,8 @@ }, "pull-request-edited": { "post": { - "summary": "Pull request edited", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The title or body of a pull request was edited.", "operationId": "pull-request/edited", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -875017,7 +875171,8 @@ }, "pull-request-labeled": { "post": { - "summary": "Pull request labeled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was added to a pull request.", "operationId": "pull-request/labeled", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -880042,7 +880197,8 @@ }, "pull-request-locked": { "post": { - "summary": "Pull request locked", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/locked", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -885022,7 +885178,8 @@ }, "pull-request-milestoned": { "post": { - "summary": "Pull request milestoned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was added to a milestone.", "operationId": "pull-request/milestoned", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -890269,7 +890426,8 @@ }, "pull-request-opened": { "post": { - "summary": "Pull request opened", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was created", "operationId": "pull-request/opened", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -896384,7 +896542,8 @@ }, "pull-request-ready-for-review": { "post": { - "summary": "Pull request ready for review", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", "operationId": "pull-request/ready-for-review", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -902566,7 +902725,8 @@ }, "pull-request-reopened": { "post": { - "summary": "Pull request reopened", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously closed pull request was reopened.", "operationId": "pull-request/reopened", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -908749,7 +908909,8 @@ }, "pull-request-review-comment-created": { "post": { - "summary": "Pull request review comment created", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was created.", "operationId": "pull-request-review-comment/created", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment" @@ -913938,7 +914099,8 @@ }, "pull-request-review-comment-deleted": { "post": { - "summary": "Pull request review comment deleted", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was deleted.", "operationId": "pull-request-review-comment/deleted", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment" @@ -919111,7 +919273,8 @@ }, "pull-request-review-comment-edited": { "post": { - "summary": "Pull request review comment edited", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The content of a comment on a pull request diff was changed.", "operationId": "pull-request-review-comment/edited", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment" @@ -924304,7 +924467,8 @@ }, "pull-request-review-dismissed": { "post": { - "summary": "Pull request review dismissed", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was dismissed.", "operationId": "pull-request-review/dismissed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review" @@ -929334,7 +929498,8 @@ }, "pull-request-review-edited": { "post": { - "summary": "Pull request review edited", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The body comment on a pull request review was edited.", "operationId": "pull-request-review/edited", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review" @@ -934294,7 +934459,8 @@ }, "pull-request-review-request-removed": { "post": { - "summary": "Pull request review request removed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A request for review by a person or team was removed from a pull request.", "operationId": "pull-request/review-request-removed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -944408,7 +944574,8 @@ }, "pull-request-review-requested": { "post": { - "summary": "Pull request review requested", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", "operationId": "pull-request/review-requested", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -954495,7 +954662,8 @@ }, "pull-request-review-submitted": { "post": { - "summary": "Pull request review submitted", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was submitted.", "operationId": "pull-request-review/submitted", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review" @@ -959526,7 +959694,8 @@ }, "pull-request-review-thread-resolved": { "post": { - "summary": "Pull request review thread resolved", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request review comment threads, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment thread on a pull request was marked as resolved.", "operationId": "pull-request-review-thread/resolved", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-thread" @@ -964655,7 +964824,8 @@ }, "pull-request-review-thread-unresolved": { "post": { - "summary": "Pull request review thread unresolved", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously resolved comment thread on a pull request was marked as unresolved.", "operationId": "pull-request-review-thread/unresolved", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-thread" @@ -969760,7 +969930,8 @@ }, "pull-request-synchronize": { "post": { - "summary": "Pull request synchronize", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch, new commits were pushed to the head branch, or the base branch was changed.", "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -974743,7 +974914,8 @@ }, "pull-request-unassigned": { "post": { - "summary": "Pull request unassigned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A user was unassigned from a pull request.", "operationId": "pull-request/unassigned", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -979824,7 +979996,8 @@ }, "pull-request-unlabeled": { "post": { - "summary": "Pull request unlabeled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was removed from a pull request.", "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -984848,7 +985021,8 @@ }, "pull-request-unlocked": { "post": { - "summary": "Pull request unlocked", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/unlocked", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -1055930,7 +1056104,8 @@ }, "security-advisory-performed": { "post": { - "summary": "Security advisory performed", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A security advisory was published to the GitHub community, the metadata or description of a security advisory was changed, or the security advisory was withdrawn.", "operationId": "security-advisory/performed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1058031,7 +1058206,8 @@ }, "security-advisory-published": { "post": { - "summary": "Security advisory published", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A security advisory was published to the GitHub community.", "operationId": "security-advisory/published", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1060132,7 +1060308,8 @@ }, "security-advisory-updated": { "post": { - "summary": "Security advisory updated", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed, or the security advisory was withdrawn.", "operationId": "security-advisory/updated", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1062233,7 +1062410,8 @@ }, "security-advisory-withdrawn": { "post": { - "summary": "Security advisory withdrawn", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", "operationId": "security-advisory/withdrawn", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" diff --git a/lib/rest/static/dereferenced/ghec.deref.json b/lib/rest/static/dereferenced/ghec.deref.json index c38443c241..8a64dc3579 100644 --- a/lib/rest/static/dereferenced/ghec.deref.json +++ b/lib/rest/static/dereferenced/ghec.deref.json @@ -57844,6 +57844,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -58122,6 +58139,14 @@ "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "description": "Whether secret scanning push protection is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." + }, + "secret_scanning_push_protection_custom_link": { + "type": "string", + "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." } } }, @@ -58535,6 +58560,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -73582,6 +73624,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -97803,6 +97851,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -100019,6 +100073,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -220583,6 +220643,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -222535,6 +222601,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -224131,6 +224203,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -383500,6 +383578,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -385096,6 +385180,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -454165,6 +454255,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -456300,6 +456396,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -457896,6 +457998,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -461774,6 +461882,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -463542,6 +463656,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -464083,6 +464203,10 @@ "codespaces" ], "operationId": "codespaces/export-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user" + }, "parameters": [ { "name": "codespace_name", @@ -464382,6 +464506,10 @@ "codespaces" ], "operationId": "codespaces/get-export-details-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export" + }, "parameters": [ { "name": "codespace_name", @@ -466112,6 +466240,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -467968,6 +468102,12 @@ }, "location": { "description": "The Azure region where this codespace is located.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], "type": "string", "examples": [ "WestUs2" @@ -538788,6 +538928,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", @@ -545240,8 +545384,8 @@ }, "check-run-completed": { "post": { - "summary": "Check run completed", - "description": "The status of the check run is completed.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run was completed, and a conclusion is available.", "operationId": "check-run/completed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" @@ -545310,7 +545454,6 @@ "application/json": { "schema": { "title": "Check Run Completed Event", - "description": "The status of the check run is now `completed`.", "type": "object", "properties": { "action": { @@ -549743,7 +549886,7 @@ }, "check-run-created": { "post": { - "summary": "Check run created", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "A new check run was created.", "operationId": "check-run/created", "externalDocs": { @@ -549813,7 +549956,6 @@ "application/json": { "schema": { "title": "Check Run Created Event", - "description": "A new check run was created.", "type": "object", "properties": { "action": { @@ -554246,7 +554388,8 @@ }, "check-suite-completed": { "post": { - "summary": "Check suite completed", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, see the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", "operationId": "check-suite/completed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" @@ -570829,7 +570972,8 @@ }, "commit-comment-created": { "post": { - "summary": "Commit comment created", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, see the `pull_request_review_comment` event. For activity relating to issue comments, see the `issue_comment` event. For activity relating to discussion comments, see the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", "operationId": "commit-comment/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#commit-comment" @@ -570898,7 +571042,6 @@ "application/json": { "schema": { "title": "commit_comment created event", - "description": "A commit comment is created. The type of activity is specified in the `action` property. ", "type": "object", "properties": { "action": { @@ -589903,7 +590046,8 @@ }, "deploy-key-created": { "post": { - "summary": "Deploy key created", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was created.", "operationId": "deploy-key/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -591895,7 +592039,8 @@ }, "deploy-key-deleted": { "post": { - "summary": "Deploy key deleted", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see \"[the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey)\" and \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was deleted.", "operationId": "deploy-key/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -757900,7 +758045,8 @@ }, "member-added": { "post": { - "summary": "Member added", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", "operationId": "member/added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -757969,7 +758115,6 @@ "application/json": { "schema": { "title": "member added event", - "description": "Activity related to repository collaborators. The type of activity is specified in the action property.", "type": "object", "properties": { "action": { @@ -759962,7 +760107,8 @@ }, "member-edited": { "post": { - "summary": "Member edited", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", "operationId": "member/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -762038,7 +762184,8 @@ }, "member-removed": { "post": { - "summary": "Member removed", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", "operationId": "member/removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -764078,7 +764225,8 @@ }, "membership-added": { "post": { - "summary": "Membership added", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", "operationId": "membership/added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -766196,7 +766344,8 @@ }, "membership-removed": { "post": { - "summary": "Membership removed", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", "operationId": "membership/removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -768315,8 +768464,8 @@ }, "merge-group-checks-requested": { "post": { - "summary": "Status checks requested for a merge group", - "description": "This event occurs when status checks are requested for a merge group. This typically happens when a merge group is formed by the merge queue because a pull request was queued.\nWhen you receive this event, you'll be expected to perform checks on the head SHA and report status back using check runs or commit statuses.", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.\n\n**Note**: The pull request merge queue feature is currently in limited private beta and subject to change.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", "operationId": "merge-group/checks-requested", "tags": [ "merge-queue" @@ -807183,8 +807332,7 @@ }, "ping": { "post": { - "summary": "Ping event", - "description": "When you create a new webhook, we'll send you a simple ping event to let you know you've set up the webhook correctly. This event isn't stored so it isn't retrievable via the Events API endpoint.", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", "operationId": "ping", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#ping" @@ -807252,7 +807400,6 @@ "content": { "application/json": { "schema": { - "description": "The webhooks ping payload", "type": "object", "properties": { "hook": { @@ -845021,7 +845168,8 @@ }, "pull-request-assigned": { "post": { - "summary": "Pull request assigned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was assigned to a user.", "operationId": "pull-request/assigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -850099,7 +850247,8 @@ }, "pull-request-auto-merge-disabled": { "post": { - "summary": "Pull request auto merge disabled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", "operationId": "pull-request/auto-merge-disabled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -855074,7 +855223,8 @@ }, "pull-request-auto-merge-enabled": { "post": { - "summary": "Pull request auto merge enabled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", "operationId": "pull-request/auto-merge-enabled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -860049,7 +860199,8 @@ }, "pull-request-closed": { "post": { - "summary": "Pull request closed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", "operationId": "pull-request/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -866259,7 +866410,8 @@ }, "pull-request-converted-to-draft": { "post": { - "summary": "Pull request converted to draft", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", "operationId": "pull-request/converted-to-draft", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -872440,7 +872592,8 @@ }, "pull-request-demilestoned": { "post": { - "summary": "Pull request demilestoned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was removed from a milestone.", "operationId": "pull-request/demilestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -877687,7 +877840,8 @@ }, "pull-request-edited": { "post": { - "summary": "Pull request edited", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The title or body of a pull request was edited.", "operationId": "pull-request/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -882731,7 +882885,8 @@ }, "pull-request-labeled": { "post": { - "summary": "Pull request labeled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was added to a pull request.", "operationId": "pull-request/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -887756,7 +887911,8 @@ }, "pull-request-locked": { "post": { - "summary": "Pull request locked", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -892736,7 +892892,8 @@ }, "pull-request-milestoned": { "post": { - "summary": "Pull request milestoned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was added to a milestone.", "operationId": "pull-request/milestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -897983,7 +898140,8 @@ }, "pull-request-opened": { "post": { - "summary": "Pull request opened", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was created", "operationId": "pull-request/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -904098,7 +904256,8 @@ }, "pull-request-ready-for-review": { "post": { - "summary": "Pull request ready for review", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", "operationId": "pull-request/ready-for-review", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -910280,7 +910439,8 @@ }, "pull-request-reopened": { "post": { - "summary": "Pull request reopened", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously closed pull request was reopened.", "operationId": "pull-request/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -916463,7 +916623,8 @@ }, "pull-request-review-comment-created": { "post": { - "summary": "Pull request review comment created", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was created.", "operationId": "pull-request-review-comment/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment" @@ -921652,7 +921813,8 @@ }, "pull-request-review-comment-deleted": { "post": { - "summary": "Pull request review comment deleted", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was deleted.", "operationId": "pull-request-review-comment/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment" @@ -926825,7 +926987,8 @@ }, "pull-request-review-comment-edited": { "post": { - "summary": "Pull request review comment edited", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The content of a comment on a pull request diff was changed.", "operationId": "pull-request-review-comment/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment" @@ -932018,7 +932181,8 @@ }, "pull-request-review-dismissed": { "post": { - "summary": "Pull request review dismissed", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was dismissed.", "operationId": "pull-request-review/dismissed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review" @@ -937048,7 +937212,8 @@ }, "pull-request-review-edited": { "post": { - "summary": "Pull request review edited", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The body comment on a pull request review was edited.", "operationId": "pull-request-review/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review" @@ -942008,7 +942173,8 @@ }, "pull-request-review-request-removed": { "post": { - "summary": "Pull request review request removed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A request for review by a person or team was removed from a pull request.", "operationId": "pull-request/review-request-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -952122,7 +952288,8 @@ }, "pull-request-review-requested": { "post": { - "summary": "Pull request review requested", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", "operationId": "pull-request/review-requested", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -962209,7 +962376,8 @@ }, "pull-request-review-submitted": { "post": { - "summary": "Pull request review submitted", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was submitted.", "operationId": "pull-request-review/submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review" @@ -967240,7 +967408,8 @@ }, "pull-request-review-thread-resolved": { "post": { - "summary": "Pull request review thread resolved", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request review comment threads, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment thread on a pull request was marked as resolved.", "operationId": "pull-request-review-thread/resolved", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-thread" @@ -972369,7 +972538,8 @@ }, "pull-request-review-thread-unresolved": { "post": { - "summary": "Pull request review thread unresolved", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously resolved comment thread on a pull request was marked as unresolved.", "operationId": "pull-request-review-thread/unresolved", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-thread" @@ -977474,7 +977644,8 @@ }, "pull-request-synchronize": { "post": { - "summary": "Pull request synchronize", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch, new commits were pushed to the head branch, or the base branch was changed.", "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -982457,7 +982628,8 @@ }, "pull-request-unassigned": { "post": { - "summary": "Pull request unassigned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A user was unassigned from a pull request.", "operationId": "pull-request/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -987538,7 +987710,8 @@ }, "pull-request-unlabeled": { "post": { - "summary": "Pull request unlabeled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was removed from a pull request.", "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -992562,7 +992735,8 @@ }, "pull-request-unlocked": { "post": { - "summary": "Pull request unlocked", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/unlocked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -1063644,7 +1063818,8 @@ }, "security-advisory-performed": { "post": { - "summary": "Security advisory performed", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A security advisory was published to the GitHub community, the metadata or description of a security advisory was changed, or the security advisory was withdrawn.", "operationId": "security-advisory/performed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1065745,7 +1065920,8 @@ }, "security-advisory-published": { "post": { - "summary": "Security advisory published", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A security advisory was published to the GitHub community.", "operationId": "security-advisory/published", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1067846,7 +1068022,8 @@ }, "security-advisory-updated": { "post": { - "summary": "Security advisory updated", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed, or the security advisory was withdrawn.", "operationId": "security-advisory/updated", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1069947,7 +1070124,8 @@ }, "security-advisory-withdrawn": { "post": { - "summary": "Security advisory withdrawn", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", "operationId": "security-advisory/withdrawn", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 0de3783c26..60fb9de0c2 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -29784,6 +29784,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/get-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.3/rest/enterprise-admin/announcement#get-the-global-announcement-banner" + }, "responses": { "200": { "description": "Response", @@ -29848,6 +29852,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/set-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.3/rest/enterprise-admin/announcement#set-the-global-announcement-banner" + }, "requestBody": { "required": true, "content": { @@ -29950,6 +29958,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/remove-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.3/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" + }, "responses": { "204": { "description": "Response" @@ -441468,6 +441480,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.3/rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index 9f85c305da..2a12c323e9 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -27779,6 +27779,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/get-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.4/rest/enterprise-admin/announcement#get-the-global-announcement-banner" + }, "responses": { "200": { "description": "Response", @@ -27843,6 +27847,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/set-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.4/rest/enterprise-admin/announcement#set-the-global-announcement-banner" + }, "requestBody": { "required": true, "content": { @@ -27945,6 +27953,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/remove-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.4/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" + }, "responses": { "204": { "description": "Response" @@ -461942,6 +461954,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.4/rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", diff --git a/lib/rest/static/dereferenced/ghes-3.5.deref.json b/lib/rest/static/dereferenced/ghes-3.5.deref.json index e307cb4005..7805d2607b 100644 --- a/lib/rest/static/dereferenced/ghes-3.5.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.5.deref.json @@ -27779,6 +27779,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/get-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.5/rest/enterprise-admin/announcement#get-the-global-announcement-banner" + }, "responses": { "200": { "description": "Response", @@ -27843,6 +27847,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/set-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.5/rest/enterprise-admin/announcement#set-the-global-announcement-banner" + }, "requestBody": { "required": true, "content": { @@ -27945,6 +27953,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/remove-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.5/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" + }, "responses": { "204": { "description": "Response" @@ -469837,6 +469849,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.5/rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", diff --git a/lib/rest/static/dereferenced/ghes-3.6.deref.json b/lib/rest/static/dereferenced/ghes-3.6.deref.json index 892d7443fb..a0a258ebde 100644 --- a/lib/rest/static/dereferenced/ghes-3.6.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.6.deref.json @@ -27861,6 +27861,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/get-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/announcement#get-the-global-announcement-banner" + }, "responses": { "200": { "description": "Response", @@ -27925,6 +27929,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/set-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/announcement#set-the-global-announcement-banner" + }, "requestBody": { "required": true, "content": { @@ -28027,6 +28035,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/remove-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" + }, "responses": { "204": { "description": "Response" @@ -485587,6 +485599,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", diff --git a/lib/rest/static/dereferenced/ghes-3.7.deref.json b/lib/rest/static/dereferenced/ghes-3.7.deref.json index 82e688900d..efdeb282f0 100644 --- a/lib/rest/static/dereferenced/ghes-3.7.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.7.deref.json @@ -27882,6 +27882,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/get-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.7/rest/enterprise-admin/announcement#get-the-global-announcement-banner" + }, "responses": { "200": { "description": "Response", @@ -27946,6 +27950,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/set-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.7/rest/enterprise-admin/announcement#set-the-global-announcement-banner" + }, "requestBody": { "required": true, "content": { @@ -28048,6 +28056,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/remove-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.7/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" + }, "responses": { "204": { "description": "Response" @@ -490245,6 +490257,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.7/rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", @@ -498709,8 +498725,8 @@ }, "check-run-completed": { "post": { - "summary": "Check run completed", - "description": "The status of the check run is completed.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.7/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.7/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run was completed, and a conclusion is available.", "operationId": "check-run/completed", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" @@ -498795,7 +498811,6 @@ "application/json": { "schema": { "title": "Check Run Completed Event", - "description": "The status of the check run is now `completed`.", "type": "object", "properties": { "action": { @@ -503228,7 +503243,7 @@ }, "check-run-created": { "post": { - "summary": "Check run created", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.7/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.7/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "A new check run was created.", "operationId": "check-run/created", "externalDocs": { @@ -503314,7 +503329,6 @@ "application/json": { "schema": { "title": "Check Run Created Event", - "description": "A new check run was created.", "type": "object", "properties": { "action": { @@ -507747,7 +507761,8 @@ }, "check-suite-completed": { "post": { - "summary": "Check suite completed", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.7/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.7/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, see the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", "operationId": "check-suite/completed", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" @@ -524442,7 +524457,8 @@ }, "commit-comment-created": { "post": { - "summary": "Commit comment created", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-server@3.7/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, see the `pull_request_review_comment` event. For activity relating to issue comments, see the `issue_comment` event. For activity relating to discussion comments, see the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", "operationId": "commit-comment/created", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#commit-comment" @@ -524527,7 +524543,6 @@ "application/json": { "schema": { "title": "commit_comment created event", - "description": "A commit comment is created. The type of activity is specified in the `action` property. ", "type": "object", "properties": { "action": { @@ -543644,7 +543659,8 @@ }, "deploy-key-created": { "post": { - "summary": "Deploy key created", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.7/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-server@3.7/rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was created.", "operationId": "deploy-key/created", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -545652,7 +545668,8 @@ }, "deploy-key-deleted": { "post": { - "summary": "Deploy key deleted", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.7/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see \"[the GraphQL documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#deploykey)\" and \"[Deploy keys](https://docs.github.com/enterprise-server@3.7/rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was deleted.", "operationId": "deploy-key/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -701610,7 +701627,8 @@ }, "member-added": { "post": { - "summary": "Member added", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.7/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.7/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", "operationId": "member/added", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -701695,7 +701713,6 @@ "application/json": { "schema": { "title": "member added event", - "description": "Activity related to repository collaborators. The type of activity is specified in the action property.", "type": "object", "properties": { "action": { @@ -703688,7 +703705,8 @@ }, "member-edited": { "post": { - "summary": "Member edited", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.7/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.7/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", "operationId": "member/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -705780,7 +705798,8 @@ }, "member-removed": { "post": { - "summary": "Member removed", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.7/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.7/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", "operationId": "member/removed", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -707836,7 +707855,8 @@ }, "membership-added": { "post": { - "summary": "Membership added", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.7/organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.7/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", "operationId": "membership/added", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -709970,7 +709990,8 @@ }, "membership-removed": { "post": { - "summary": "Membership removed", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.7/organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.7/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", "operationId": "membership/removed", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -712105,8 +712126,8 @@ }, "merge-group-checks-requested": { "post": { - "summary": "Status checks requested for a merge group", - "description": "This event occurs when status checks are requested for a merge group. This typically happens when a merge group is formed by the merge queue because a pull request was queued.\nWhen you receive this event, you'll be expected to perform checks on the head SHA and report status back using check runs or commit statuses.", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-server@3.7/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.\n\n**Note**: The pull request merge queue feature is currently in limited private beta and subject to change.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", "operationId": "merge-group/checks-requested", "tags": [ "merge-queue" @@ -747149,8 +747170,7 @@ }, "ping": { "post": { - "summary": "Ping event", - "description": "When you create a new webhook, we'll send you a simple ping event to let you know you've set up the webhook correctly. This event isn't stored so it isn't retrievable via the Events API endpoint.", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", "operationId": "ping", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#ping" @@ -747234,7 +747254,6 @@ "content": { "application/json": { "schema": { - "description": "The webhooks ping payload", "type": "object", "properties": { "hook": { @@ -785355,7 +785374,8 @@ }, "pull-request-assigned": { "post": { - "summary": "Pull request assigned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was assigned to a user.", "operationId": "pull-request/assigned", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -790449,7 +790469,8 @@ }, "pull-request-auto-merge-disabled": { "post": { - "summary": "Pull request auto merge disabled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", "operationId": "pull-request/auto-merge-disabled", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -795440,7 +795461,8 @@ }, "pull-request-auto-merge-enabled": { "post": { - "summary": "Pull request auto merge enabled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", "operationId": "pull-request/auto-merge-enabled", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -800431,7 +800453,8 @@ }, "pull-request-closed": { "post": { - "summary": "Pull request closed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", "operationId": "pull-request/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -806657,7 +806680,8 @@ }, "pull-request-converted-to-draft": { "post": { - "summary": "Pull request converted to draft", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", "operationId": "pull-request/converted-to-draft", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -812854,7 +812878,8 @@ }, "pull-request-demilestoned": { "post": { - "summary": "Pull request demilestoned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was removed from a milestone.", "operationId": "pull-request/demilestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -818117,7 +818142,8 @@ }, "pull-request-edited": { "post": { - "summary": "Pull request edited", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The title or body of a pull request was edited.", "operationId": "pull-request/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -823177,7 +823203,8 @@ }, "pull-request-labeled": { "post": { - "summary": "Pull request labeled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was added to a pull request.", "operationId": "pull-request/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -828218,7 +828245,8 @@ }, "pull-request-locked": { "post": { - "summary": "Pull request locked", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.7/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -833214,7 +833242,8 @@ }, "pull-request-milestoned": { "post": { - "summary": "Pull request milestoned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was added to a milestone.", "operationId": "pull-request/milestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -838477,7 +838506,8 @@ }, "pull-request-opened": { "post": { - "summary": "Pull request opened", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was created", "operationId": "pull-request/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -844608,7 +844638,8 @@ }, "pull-request-ready-for-review": { "post": { - "summary": "Pull request ready for review", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", "operationId": "pull-request/ready-for-review", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -850806,7 +850837,8 @@ }, "pull-request-reopened": { "post": { - "summary": "Pull request reopened", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously closed pull request was reopened.", "operationId": "pull-request/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -857005,7 +857037,8 @@ }, "pull-request-review-comment-created": { "post": { - "summary": "Pull request review comment created", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.7/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was created.", "operationId": "pull-request-review-comment/created", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment" @@ -862210,7 +862243,8 @@ }, "pull-request-review-comment-deleted": { "post": { - "summary": "Pull request review comment deleted", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.7/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was deleted.", "operationId": "pull-request-review-comment/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment" @@ -867399,7 +867433,8 @@ }, "pull-request-review-comment-edited": { "post": { - "summary": "Pull request review comment edited", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.7/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The content of a comment on a pull request diff was changed.", "operationId": "pull-request-review-comment/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment" @@ -872608,7 +872643,8 @@ }, "pull-request-review-dismissed": { "post": { - "summary": "Pull request review dismissed", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.7/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was dismissed.", "operationId": "pull-request-review/dismissed", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review" @@ -877654,7 +877690,8 @@ }, "pull-request-review-edited": { "post": { - "summary": "Pull request review edited", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.7/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The body comment on a pull request review was edited.", "operationId": "pull-request-review/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review" @@ -882630,7 +882667,8 @@ }, "pull-request-review-request-removed": { "post": { - "summary": "Pull request review request removed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A request for review by a person or team was removed from a pull request.", "operationId": "pull-request/review-request-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -892760,7 +892798,8 @@ }, "pull-request-review-requested": { "post": { - "summary": "Pull request review requested", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", "operationId": "pull-request/review-requested", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -902863,7 +902902,8 @@ }, "pull-request-review-submitted": { "post": { - "summary": "Pull request review submitted", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.7/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was submitted.", "operationId": "pull-request-review/submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review" @@ -907910,7 +907950,8 @@ }, "pull-request-review-thread-resolved": { "post": { - "summary": "Pull request review thread resolved", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request review comment threads, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.7/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment thread on a pull request was marked as resolved.", "operationId": "pull-request-review-thread/resolved", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-thread" @@ -913055,7 +913096,8 @@ }, "pull-request-review-thread-unresolved": { "post": { - "summary": "Pull request review thread unresolved", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.7/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously resolved comment thread on a pull request was marked as unresolved.", "operationId": "pull-request-review-thread/unresolved", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-thread" @@ -918176,7 +918218,8 @@ }, "pull-request-synchronize": { "post": { - "summary": "Pull request synchronize", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch, new commits were pushed to the head branch, or the base branch was changed.", "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -923175,7 +923218,8 @@ }, "pull-request-unassigned": { "post": { - "summary": "Pull request unassigned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A user was unassigned from a pull request.", "operationId": "pull-request/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -928272,7 +928316,8 @@ }, "pull-request-unlabeled": { "post": { - "summary": "Pull request unlabeled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was removed from a pull request.", "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -933312,7 +933357,8 @@ }, "pull-request-unlocked": { "post": { - "summary": "Pull request unlocked", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.7/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/unlocked", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -1006811,7 +1006857,8 @@ }, "security-advisory-performed": { "post": { - "summary": "Security advisory performed", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-server@3.7/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.7/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A security advisory was published to the GitHub community, the metadata or description of a security advisory was changed, or the security advisory was withdrawn.", "operationId": "security-advisory/performed", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1008928,7 +1008975,8 @@ }, "security-advisory-published": { "post": { - "summary": "Security advisory published", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-server@3.7/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.7/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A security advisory was published to the GitHub community.", "operationId": "security-advisory/published", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1011045,7 +1011093,8 @@ }, "security-advisory-updated": { "post": { - "summary": "Security advisory updated", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-server@3.7/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.7/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed, or the security advisory was withdrawn.", "operationId": "security-advisory/updated", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1013162,7 +1013211,8 @@ }, "security-advisory-withdrawn": { "post": { - "summary": "Security advisory withdrawn", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-server@3.7/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.7/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", "operationId": "security-advisory/withdrawn", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 22f6efb70c..cdc5a9b176 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -17079,6 +17079,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/get-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/enterprise-admin/announcement#get-the-global-announcement-banner" + }, "responses": { "200": { "description": "Response", @@ -17143,6 +17147,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/set-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/enterprise-admin/announcement#set-the-global-announcement-banner" + }, "requestBody": { "required": true, "content": { @@ -17245,6 +17253,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/remove-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" + }, "responses": { "204": { "description": "Response" @@ -45818,6 +45830,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -46509,6 +46538,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -412710,6 +412756,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", @@ -418931,8 +418981,8 @@ }, "check-run-completed": { "post": { - "summary": "Check run completed", - "description": "The status of the check run is completed.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/github-ae@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run was completed, and a conclusion is available.", "operationId": "check-run/completed", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" @@ -419001,7 +419051,6 @@ "application/json": { "schema": { "title": "Check Run Completed Event", - "description": "The status of the check run is now `completed`.", "type": "object", "properties": { "action": { @@ -423357,7 +423406,7 @@ }, "check-run-created": { "post": { - "summary": "Check run created", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/github-ae@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "A new check run was created.", "operationId": "check-run/created", "externalDocs": { @@ -423427,7 +423476,6 @@ "application/json": { "schema": { "title": "Check Run Created Event", - "description": "A new check run was created.", "type": "object", "properties": { "action": { @@ -427783,7 +427831,8 @@ }, "check-suite-completed": { "post": { - "summary": "Check suite completed", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/github-ae@latest/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, see the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", "operationId": "check-suite/completed", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" @@ -443827,7 +443876,8 @@ }, "commit-comment-created": { "post": { - "summary": "Commit comment created", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/github-ae@latest/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, see the `pull_request_review_comment` event. For activity relating to issue comments, see the `issue_comment` event. For activity relating to discussion comments, see the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", "operationId": "commit-comment/created", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#commit-comment" @@ -443896,7 +443946,6 @@ "application/json": { "schema": { "title": "commit_comment created event", - "description": "A commit comment is created. The type of activity is specified in the `action` property. ", "type": "object", "properties": { "action": { @@ -462285,7 +462334,8 @@ }, "deploy-key-created": { "post": { - "summary": "Deploy key created", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/github-ae@latest/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/github-ae@latest/rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was created.", "operationId": "deploy-key/created", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -464200,7 +464250,8 @@ }, "deploy-key-deleted": { "post": { - "summary": "Deploy key deleted", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/github-ae@latest/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see \"[the GraphQL documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#deploykey)\" and \"[Deploy keys](https://docs.github.com/github-ae@latest/rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was deleted.", "operationId": "deploy-key/deleted", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -614766,7 +614817,8 @@ }, "member-added": { "post": { - "summary": "Member added", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/github-ae@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/github-ae@latest/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", "operationId": "member/added", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -614835,7 +614887,6 @@ "application/json": { "schema": { "title": "member added event", - "description": "Activity related to repository collaborators. The type of activity is specified in the action property.", "type": "object", "properties": { "action": { @@ -616751,7 +616802,8 @@ }, "member-edited": { "post": { - "summary": "Member edited", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/github-ae@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/github-ae@latest/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", "operationId": "member/edited", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -618750,7 +618802,8 @@ }, "member-removed": { "post": { - "summary": "Member removed", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/github-ae@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/github-ae@latest/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", "operationId": "member/removed", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -620713,7 +620766,8 @@ }, "membership-added": { "post": { - "summary": "Membership added", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/github-ae@latest/organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/github-ae@latest/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", "operationId": "membership/added", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -622754,7 +622808,8 @@ }, "membership-removed": { "post": { - "summary": "Membership removed", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/github-ae@latest/organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/github-ae@latest/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", "operationId": "membership/removed", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -624796,8 +624851,8 @@ }, "merge-group-checks-requested": { "post": { - "summary": "Status checks requested for a merge group", - "description": "This event occurs when status checks are requested for a merge group. This typically happens when a merge group is formed by the merge queue because a pull request was queued.\nWhen you receive this event, you'll be expected to perform checks on the head SHA and report status back using check runs or commit statuses.", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/github-ae@latest/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.\n\n**Note**: The pull request merge queue feature is currently in limited private beta and subject to change.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", "operationId": "merge-group/checks-requested", "tags": [ "merge-queue" @@ -658352,8 +658407,7 @@ }, "ping": { "post": { - "summary": "Ping event", - "description": "When you create a new webhook, we'll send you a simple ping event to let you know you've set up the webhook correctly. This event isn't stored so it isn't retrievable via the Events API endpoint.", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", "operationId": "ping", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#ping" @@ -658421,7 +658475,6 @@ "content": { "application/json": { "schema": { - "description": "The webhooks ping payload", "type": "object", "properties": { "hook": { @@ -690519,7 +690572,8 @@ }, "pull-request-assigned": { "post": { - "summary": "Pull request assigned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was assigned to a user.", "operationId": "pull-request/assigned", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -695520,7 +695574,8 @@ }, "pull-request-auto-merge-disabled": { "post": { - "summary": "Pull request auto merge disabled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", "operationId": "pull-request/auto-merge-disabled", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -700418,7 +700473,8 @@ }, "pull-request-auto-merge-enabled": { "post": { - "summary": "Pull request auto merge enabled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", "operationId": "pull-request/auto-merge-enabled", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -705316,7 +705372,8 @@ }, "pull-request-closed": { "post": { - "summary": "Pull request closed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", "operationId": "pull-request/closed", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -711449,7 +711506,8 @@ }, "pull-request-converted-to-draft": { "post": { - "summary": "Pull request converted to draft", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", "operationId": "pull-request/converted-to-draft", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -717553,7 +717611,8 @@ }, "pull-request-demilestoned": { "post": { - "summary": "Pull request demilestoned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was removed from a milestone.", "operationId": "pull-request/demilestoned", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -722723,7 +722782,8 @@ }, "pull-request-edited": { "post": { - "summary": "Pull request edited", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The title or body of a pull request was edited.", "operationId": "pull-request/edited", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -727690,7 +727750,8 @@ }, "pull-request-labeled": { "post": { - "summary": "Pull request labeled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was added to a pull request.", "operationId": "pull-request/labeled", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -732638,7 +732699,8 @@ }, "pull-request-locked": { "post": { - "summary": "Pull request locked", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/github-ae@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/locked", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -737541,7 +737603,8 @@ }, "pull-request-milestoned": { "post": { - "summary": "Pull request milestoned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was added to a milestone.", "operationId": "pull-request/milestoned", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -742711,7 +742774,8 @@ }, "pull-request-opened": { "post": { - "summary": "Pull request opened", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was created", "operationId": "pull-request/opened", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -748749,7 +748813,8 @@ }, "pull-request-ready-for-review": { "post": { - "summary": "Pull request ready for review", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", "operationId": "pull-request/ready-for-review", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -754854,7 +754919,8 @@ }, "pull-request-reopened": { "post": { - "summary": "Pull request reopened", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously closed pull request was reopened.", "operationId": "pull-request/reopened", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -760960,7 +761026,8 @@ }, "pull-request-review-comment-created": { "post": { - "summary": "Pull request review comment created", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/github-ae@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was created.", "operationId": "pull-request-review-comment/created", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment" @@ -766072,7 +766139,8 @@ }, "pull-request-review-comment-deleted": { "post": { - "summary": "Pull request review comment deleted", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/github-ae@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was deleted.", "operationId": "pull-request-review-comment/deleted", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment" @@ -771168,7 +771236,8 @@ }, "pull-request-review-comment-edited": { "post": { - "summary": "Pull request review comment edited", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/github-ae@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The content of a comment on a pull request diff was changed.", "operationId": "pull-request-review-comment/edited", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment" @@ -776284,7 +776353,8 @@ }, "pull-request-review-dismissed": { "post": { - "summary": "Pull request review dismissed", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/github-ae@latest/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was dismissed.", "operationId": "pull-request-review/dismissed", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review" @@ -781237,7 +781307,8 @@ }, "pull-request-review-edited": { "post": { - "summary": "Pull request review edited", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/github-ae@latest/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The body comment on a pull request review was edited.", "operationId": "pull-request-review/edited", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review" @@ -786120,7 +786191,8 @@ }, "pull-request-review-request-removed": { "post": { - "summary": "Pull request review request removed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A request for review by a person or team was removed from a pull request.", "operationId": "pull-request/review-request-removed", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -796080,7 +796152,8 @@ }, "pull-request-review-requested": { "post": { - "summary": "Pull request review requested", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", "operationId": "pull-request/review-requested", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -806013,7 +806086,8 @@ }, "pull-request-review-submitted": { "post": { - "summary": "Pull request review submitted", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/github-ae@latest/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was submitted.", "operationId": "pull-request-review/submitted", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review" @@ -810967,7 +811041,8 @@ }, "pull-request-review-thread-resolved": { "post": { - "summary": "Pull request review thread resolved", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request review comment threads, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request reviews](https://docs.github.com/github-ae@latest/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment thread on a pull request was marked as resolved.", "operationId": "pull-request-review-thread/resolved", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-thread" @@ -816019,7 +816094,8 @@ }, "pull-request-review-thread-unresolved": { "post": { - "summary": "Pull request review thread unresolved", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/github-ae@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously resolved comment thread on a pull request was marked as unresolved.", "operationId": "pull-request-review-thread/unresolved", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-thread" @@ -821047,7 +821123,8 @@ }, "pull-request-synchronize": { "post": { - "summary": "Pull request synchronize", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch, new commits were pushed to the head branch, or the base branch was changed.", "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -825953,7 +826030,8 @@ }, "pull-request-unassigned": { "post": { - "summary": "Pull request unassigned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A user was unassigned from a pull request.", "operationId": "pull-request/unassigned", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -830957,7 +831035,8 @@ }, "pull-request-unlabeled": { "post": { - "summary": "Pull request unlabeled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was removed from a pull request.", "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" @@ -835904,7 +835983,8 @@ }, "pull-request-unlocked": { "post": { - "summary": "Pull request unlocked", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/github-ae@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/unlocked", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" diff --git a/pages/[versionId]/admin/release-notes.tsx b/pages/[versionId]/admin/release-notes.tsx index 3f12f960df..36b6313738 100644 --- a/pages/[versionId]/admin/release-notes.tsx +++ b/pages/[versionId]/admin/release-notes.tsx @@ -1,5 +1,7 @@ import { GetServerSideProps } from 'next' import { Liquid } from 'liquidjs' +import pick from 'lodash/pick' + import { MainContextT, MainContext, getMainContext } from 'components/context/MainContext' import { DefaultLayout } from 'components/DefaultLayout' import { GHAEReleaseNotes } from 'components/release-notes/GHAEReleaseNotes' @@ -27,7 +29,18 @@ export default function ReleaseNotes({ mainContext, ghesContext, ghaeContext }: export const getServerSideProps: GetServerSideProps = async (context) => { const req = context.req as any const res = context.res as any - const currentVersion = req.context.allVersions[req.context.currentVersion] + + // The `req.context.allVersion[X]` entries contains more keys (and values) + // than we need so only pick out the keys that are actually needed + // explicitly in the components served from these props. + const currentVersion = pick(req.context.allVersions[req.context.currentVersion], [ + 'plan', + 'planTitle', + 'versionTitle', + 'currentRelease', + 'releases', + ]) + const { latestPatch = '', latestRelease = '' } = req.context return { props: { diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile.md index 35fe07bfb4..c5373b8c6a 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile.md @@ -14,12 +14,12 @@ versions: ghec: '*' topics: - Profiles -ms.openlocfilehash: edbe34a38c2ab23de22e3b5ea466e35276c6bc35 -ms.sourcegitcommit: fb047f9450b41b24afc43d9512a5db2a2b750a2a +ms.openlocfilehash: e27e14102b4f57e9eb50266c5c271a2f6bb3892c +ms.sourcegitcommit: bf11c3e08cbb5eab6320e0de35b32ade6d863c03 ms.translationtype: HT ms.contentlocale: ja-JP -ms.lasthandoff: 09/10/2022 -ms.locfileid: '146199955' +ms.lasthandoff: 10/27/2022 +ms.locfileid: '148111615' --- 以前の職場、コントリビュートしたプロジェクト、あなたが興味を持っていることなど、他者が知りたいあなたに関する個人情報を略歴に追加できます。 詳細については、「[プロフィールに略歴を追加する](/articles/personalizing-your-profile/#adding-a-bio-to-your-profile)」を参照してください。 @@ -36,7 +36,7 @@ ms.locfileid: '146199955' あなたのプロフィールにアクセスしたユーザは、次の情報も見ることができます。 - あなたが所有している、もしくはコントリビューションしたリポジトリと Gist。 {% ifversion fpt or ghes or ghec %}リポジトリと gist をプロフィールにピン留めすることで、自分の最も優れた作業を紹介できます。 詳細については、「[プロフィールにアイテムをピン留めする](/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile)」を参照してください。{% endif %} -- 星を付けたリポジトリ{% ifversion fpt or ghec %}およびリストに編成したリポジトリ{% endif %}。詳細については、「[星を付けてリポジトリを保存する](/articles/saving-repositories-with-stars/)」を参照してください。 +- 自分が星を付け{% ifversion fpt or ghec %}、リストにまとめ{% endif %}たリポジトリ。 詳細については、「[Star を付けてリポジトリを保存する](/articles/saving-repositories-with-stars/)」を参照してください。 - あなたが最もアクティブな Organization、リポジトリ、Team でのあなたのアクティビティの概要。 詳細については、「[プロフィールでアクティビティの概要を表示する](/articles/showing-an-overview-of-your-activity-on-your-profile)」を参照してください。{% ifversion fpt or ghec %} - アクティビティを強調し、{% data variables.product.prodname_pro %} の使用や {% data variables.product.prodname_arctic_vault %}、{% data variables.product.prodname_sponsors %}、{% data variables.product.company_short %} 開発者プログラムなどのプログラムへの参加を示すバッジとアチーブメント。 詳細については、「[プロフィールをパーソナライズする](/github/setting-up-and-managing-your-github-profile/personalizing-your-profile#displaying-badges-on-your-profile)」を参照してください。{% endif %} diff --git a/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md b/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md index b4203f0a1d..58c6be3da8 100644 --- a/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md +++ b/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md @@ -69,7 +69,7 @@ There are two types of snapshots: | Azure | VM | | Hyper-V | VM | | Google Compute Engine | Disk | -| VMware | VM | +| VMware | VM | ## Upgrading with a hotpatch diff --git a/translations/ja-JP/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md b/translations/ja-JP/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md index 138d9b40d8..6c71f4293a 100644 --- a/translations/ja-JP/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md +++ b/translations/ja-JP/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md @@ -85,6 +85,8 @@ When you configure SAML authentication, {% data variables.product.product_name % 1. Usernames created from email addresses are created from the normalized characters that precede the `@` character. +1. Usernames created from domain accounts are created from the normalized characters after the `\\` separator. + 1. If multiple accounts are normalized into the same {% data variables.product.product_name %} username, only the first user account is created. Subsequent users with the same username won't be able to sign in. {% ifversion ghec %}For more information, see "[Resolving username problems](#resolving-username-problems)."{% endif %} ### Examples of username normalization @@ -97,6 +99,7 @@ When you configure SAML authentication, {% data variables.product.product_name % | The!!Octocat | `the--octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created, because it contains two consecutive dashes. | | The!Octocat | `the-octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created. Although the normalized username is valid, it already exists. | | `The.Octocat@example.com` | `the-octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created. Although the normalized username is valid, it already exists. | +| `internal\\The.Octocat` | `the-octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created. Although the normalized username is valid, it already exists. | | `mona.lisa.the.octocat.from.github.united.states@example.com` | `mona-lisa-the-octocat-from-github-united-states{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created, because it exceeds the 39-character limit. | {% ifversion not ghec %} diff --git a/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md b/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md index 89dd8d1fe5..f24cbdcd6c 100644 --- a/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md +++ b/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md @@ -1,7 +1,7 @@ --- -title: Configuring authentication and provisioning for your enterprise using Azure AD +title: Azure AD を使用して Enterprise の認証とプロビジョニングを設定する shortTitle: Configure with Azure AD -intro: 'You can use a tenant in Azure Active Directory (Azure AD) as an identity provider (IdP) to centrally manage authentication and user provisioning for {% data variables.location.product_location %}.' +intro: 'Azure Active Directory (Azure AD) のテナントを ID プロバイダー (IdP) として使って、{% data variables.location.product_location %} の認証とユーザー プロビジョニングを一元管理できます。' permissions: 'Enterprise owners can configure authentication and provisioning for an enterprise on {% data variables.product.product_name %}.' versions: ghae: '*' @@ -17,63 +17,67 @@ redirect_from: - /admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad - /admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad - /admin/identity-and-access-management/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad +ms.openlocfilehash: 10b6fdaa2014836e7a709bc94920dea6331ed030 +ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 +ms.translationtype: HT +ms.contentlocale: ja-JP +ms.lasthandoff: 10/25/2022 +ms.locfileid: '148107510' --- +## Azure AD を使用した認証とユーザプロビジョニングについて -## About authentication and user provisioning with Azure AD +Azure Active Directory (Azure AD) は、ユーザアカウントと Web アプリケーションへのアクセスを一元管理できる Microsoft のサービスです。 詳細については、Microsoft Docs の「[Azure Active Directory とは](https://docs.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis)」を参照してください。 -Azure Active Directory (Azure AD) is a service from Microsoft that allows you to centrally manage user accounts and access to web applications. For more information, see [What is Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis) in the Microsoft Docs. - -To manage identity and access for {% data variables.product.product_name %}, you can use an Azure AD tenant as a SAML IdP for authentication. You can also configure Azure AD to automatically provision accounts and access membership with SCIM, which allows you to create {% data variables.product.product_name %} users and manage team and organization membership from your Azure AD tenant. +{% data variables.product.product_name %} のアイデンティティとアクセスを管理するために、Azure AD テナントを認証用の SAML IdP として使用できます。 アカウントを自動的にプロビジョニングし、SCIM でメンバーシップにアクセスするように、Azure AD を構成することもできます。これにより、{% data variables.product.product_name %} のユーザーを作成し、Azure AD テナントから Team と Organization のメンバーシップを管理できます。 {% data reusables.scim.ghes-beta-note %} -After you enable SAML SSO and SCIM for {% data variables.product.product_name %} using Azure AD, you can accomplish the following from your Azure AD tenant. +Azure AD を使って {% data variables.product.product_name %} に対して SAML SSO と SCIM を有効にした後、Azure AD テナントから以下を実行できます。 -* Assign the {% data variables.product.product_name %} application on Azure AD to a user account to automatically create and grant access to a corresponding user account on {% data variables.product.product_name %}. -* Unassign the {% data variables.product.product_name %} application to a user account on Azure AD to deactivate the corresponding user account on {% data variables.product.product_name %}. -* Assign the {% data variables.product.product_name %} application to an IdP group on Azure AD to automatically create and grant access to user accounts on {% data variables.product.product_name %} for all members of the IdP group. In addition, the IdP group is available on {% data variables.product.product_name %} for connection to a team and its parent organization. -* Unassign the {% data variables.product.product_name %} application from an IdP group to deactivate the {% data variables.product.product_name %} user accounts of all IdP users who had access only through that IdP group and remove the users from the parent organization. The IdP group will be disconnected from any teams on {% data variables.product.product_name %}. +* Azure AD の {% data variables.product.product_name %} アプリケーションをユーザー アカウントに割り当て、{% data variables.product.product_name %} 上に対応するユーザー アカウントを自動的に作成して、アクセスを許可します。 +* Azure AD 上のユーザー アカウントへの {% data variables.product.product_name %} アプリケーションの割り当てを解除し、{% data variables.product.product_name %} の対応するユーザー アカウントを非アクティブ化します。 +* {% data variables.product.product_name %} アプリケーションを Azure AD の IdP グループに割り当てて、IdP グループのすべてのメンバーに対する {% data variables.product.product_name %} 上のユーザー アカウントを自動的に作成して、アクセスを許可します。 さらに、Team とその親 Organization に接続するために、{% data variables.product.product_name %} で IdP グループを利用できます。 +* IdP グループから {% data variables.product.product_name %} アプリケーションの割り当てを解除すると、その IdP グループを介してのみアクセスしていたすべての IdP ユーザーの {% data variables.product.product_name %} ユーザー アカウントが非アクティブ化され、親 Organization からユーザーが削除されます。 IdP グループは {% data variables.product.product_name %} のどの Team からも切断されます -For more information about managing identity and access for your enterprise on {% data variables.location.product_location %}, see "[Managing identity and access for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise)." For more information about synchronizing teams with IdP groups, see "[Synchronizing a team with an identity provider group](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." +{% data variables.location.product_location %} での Enterprise の ID とアクセスの管理について詳しくは、「[Enterprise の ID とアクセスを管理する](/admin/authentication/managing-identity-and-access-for-your-enterprise)」をご覧ください。 IdP グループとのチームの同期の詳細については、「[チームを ID プロバイダー グループと同期する](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)」を参照してください。 -## Prerequisites +## 前提条件 -- To configure authentication and user provisioning for {% data variables.product.product_name %} using Azure AD, you must have an Azure AD account and tenant. For more information, see the [Azure AD website](https://azure.microsoft.com/free/active-directory) and [Quickstart: Create an Azure Active Directory tenant](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant) in the Microsoft Docs. +- Azure AD を使用して {% data variables.product.product_name %} の認証とユーザプロビジョニングを設定するには、Azure AD アカウントとテナントが必要です。 詳細については、[Azure AD Web サイト](https://azure.microsoft.com/free/active-directory)および Microsoft Docs の「[クイックスタート: Azure Active Directory テナントを作成する](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant)」を参照してください。 {%- ifversion scim-for-ghes %} -- {% data reusables.saml.ghes-you-must-configure-saml-sso %} -{%- endif %} +- {% data reusables.saml.ghes-you-must-configure-saml-sso %} {%- endif %} -- {% data reusables.saml.assert-the-administrator-attribute %} For more information about including the `administrator` attribute in the SAML claim from Azure AD, see [How to: customize claims issued in the SAML token for enterprise applications](https://docs.microsoft.com/azure/active-directory/develop/active-directory-saml-claims-customization) in the Microsoft Docs. +- {% data reusables.saml.assert-the-administrator-attribute %} Azure AD からの SAML 要求に `administrator` 属性を含める方法の詳細については、Microsoft Docs の「[エンタープライズ アプリケーションの SAML トークンで発行された要求のカスタマイズ](https://docs.microsoft.com/azure/active-directory/develop/active-directory-saml-claims-customization)」を参照してください。 - {% data reusables.saml.create-a-machine-user %} -## Configuring authentication and user provisioning with Azure AD +## Azure AD を使用して認証とユーザプロビジョニングを設定する -In your Azure AD tenant, add the application for {% data variables.product.product_name %}, then configure provisioning. +Azure AD テナントで、{% data variables.product.product_name %} 用のアプリケーションを追加してから、プロビジョニングを構成します。 {% ifversion ghae %} -1. In Azure AD, add the {% data variables.enterprise.ae_azure_ad_app_link %} to your tenant and configure single sign-on. For more information, see [Tutorial: Azure Active Directory single sign-on (SSO) integration with {% data variables.product.product_name %}](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial) in the Microsoft Docs. +1. Azure AD で、{% data variables.enterprise.ae_azure_ad_app_link %} をテナントに追加し、シングル サインオンを構成します。 詳しくは、Microsoft Docs の[チュートリアル: Azure Active Directory シングル サインオン (SSO) と {% data variables.product.product_name %} の統合](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial)に関する記事をご覧ください。 -1. In {% data variables.product.product_name %}, enter the details for your Azure AD tenant. +1. {% data variables.product.product_name %} で、Azure AD テナントの詳細を入力します。 - {% data reusables.saml.ae-enable-saml-sso-during-bootstrapping %} - - If you've already configured SAML SSO for {% data variables.location.product_location %} using another IdP and you want to use Azure AD instead, you can edit your configuration. For more information, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise#editing-the-saml-sso-configuration)." + - 別の IdP を使って {% data variables.location.product_location %} の SAML SSO を既に設定しており、その代わりに Azure AD を使う場合は、構成を編集できます。 詳細については、「[エンタープライズ向けの SAML シングル サインオンの構成](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise#editing-the-saml-sso-configuration)」を参照してください。 -1. Enable user provisioning in {% data variables.product.product_name %} and configure user provisioning in Azure AD. For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)." +1. {% data variables.product.product_name %} でユーザプロビジョニングを有効化し、Azure AD でユーザプロビジョニングを設定します。 詳細については、「[エンタープライズ向けのユーザー プロビジョニングの構成](/admin/authentication/configuring-user-provisioning-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)」を参照してください。 {% elsif scim-for-ghes %} -1. In the Azure AD tenant, in the left sidebar, click **Provisioning**. +1. Azure AD テナントの左側のサイドバーで、 **[プロビジョニング]** をクリックします。 -1. Under "Tenant URL", type the full endpoint URL for SCIM on {% data variables.location.product_location %}. For more information, see "[SCIM](/rest/enterprise-admin/scim#scim-endpoint-urls)" in the REST API documentation. +1. [テナント URL] に、{% data variables.location.product_location %} での SCIM の完全なエンドポイント URL を入力します。 詳しくは、REST API のドキュメントの「[SCIM](/rest/enterprise-admin/scim#scim-endpoint-urls)」をご覧ください。 -1. Under "Secret Token", type the {% data variables.product.pat_v1 %} that you created in step 4 of "[Configuring user provisioning with SCIM for your enterprise](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)." +1. [シークレット トークン] に、「[Enterprise 用の SCIM を使用したユーザーのプロビジョニングを構成する](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)」のステップ 4 で作成した {% data variables.product.pat_v1 %} を入力します。 -1. To ensure a successful connection from Azure AD to {% data variables.location.product_location %}, Click **Test Connection**. +1. Azure AD から {% data variables.location.product_location %} への正常な接続を確認するには、 **[テスト接続]** をクリックします。 -1. After you ensure a successful connection, at the top of the page, click **Save**. +1. 接続が成功したことを確認したら、ページの上部にある **[保存]** をクリックします。 {% endif %} diff --git a/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise.md b/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise.md new file mode 100644 index 0000000000..d8d5454fd6 --- /dev/null +++ b/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise.md @@ -0,0 +1,170 @@ +--- +title: Configuring user provisioning with SCIM for your enterprise +shortTitle: Configure user provisioning +intro: 'You can configure System for Cross-domain Identity Management (SCIM) for {% ifversion scim-for-ghes %}{% data variables.location.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}, which automatically provisions user accounts when you assign the application for {% ifversion scim-for-ghes %}your instance{% elsif ghae %}{% data variables.product.product_name %}{% endif %} to a user on your identity provider (IdP).' +permissions: '{% ifversion scim-for-ghes %}Site administrators{% elsif ghae %}Enterprise owners{% endif %} can configure user provisioning for {% ifversion scim-for-ghes %}a {% data variables.product.product_name %} instance{% elsif ghae %}an enterprise on {% data variables.product.product_name %}{% endif %}.' +versions: + ghae: '*' + feature: scim-for-ghes +type: how_to +topics: + - Accounts + - Authentication + - Enterprise + - Identity + - SSO +redirect_from: + - /admin/authentication/configuring-user-provisioning-for-your-enterprise + - /admin/identity-and-access-management/managing-iam-for-your-enterprise/configuring-user-provisioning-for-your-enterprise + - /admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-for-your-enterprise +--- + +{% data reusables.scim.ghes-beta-note %} + +## About user provisioning for {% data variables.product.product_name %} + +{% ifversion ghae %} + +{% data reusables.saml.ae-uses-saml-sso %} For more information, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise)." + +{% endif %} + +{% ifversion scim-for-ghes %}If you use SAML single sign-on (SSO) for {% data variables.location.product_location %}, you{% elsif ghae %}You{% endif %} can configure SCIM to automatically create or suspend user accounts and grant access{% ifversion scim-for-ghes %} to your instance{% elsif ghae %} for {% data variables.product.product_name %}{% endif %} when you assign or unassign the application on your IdP. For more information about SCIM, see [System for Cross-domain Identity Management: Protocol (RFC 7644)](https://tools.ietf.org/html/rfc7644) on the IETF website. + +If you do not configure user provisioning with SCIM, your IdP will not communicate with {% data variables.product.product_name %} automatically when you assign or unassign the application to a user. Without SCIM, {% data variables.product.product_name %} creates a user account using SAML Just-in-Time (JIT) provisioning the first time someone navigates to {% data variables.product.product_name %} and signs in by authenticating through your IdP. + +Configuring provisioning allows your IdP to communicate with {% data variables.location.product_location %} when you assign or unassign the application for {% data variables.product.product_name %} to a user on your IdP. When you assign the application, your IdP will prompt {% data variables.location.product_location %} to create an account and send an onboarding email to the user. When you unassign the application, your IdP will communicate with {% data variables.product.product_name %} to invalidate any SAML sessions and disable the member's account. + +To configure provisioning for your enterprise, you must enable provisioning on {% data variables.product.product_name %}, then install and configure a provisioning application on your IdP. + +{% ifversion scim-for-ghes %} + +The provisioning application on your IdP communicates with {% data variables.product.product_name %} using the SCIM API. For more information, see "[SCIM](/rest/enterprise-admin/scim)" in the REST API documentation. + +{% endif %} + +## About identities and claims + +After an IdP administrator grants a person access to {% data variables.location.product_location %}, the user can authenticate through the IdP to access {% data variables.product.product_name %} using SAML SSO. + +During authentication, {% ifversion scim-for-ghes %}the instance{% elsif ghae %}{% data variables.product.product_name %}{% endif %} attempts to associate the user with a SAML identity. By default, {% ifversion scim-for-ghes %}the instance{% elsif ghae %}{% data variables.product.product_name %}{% endif %} compares the `NameID` claim from the IdP to the account's username. {% data variables.product.product_name %} normalizes the value of `NameID` for the comparison. For more information about username normalization, see "[Username considerations for external authentication](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication#about-username-normalization)." + +If there is no matching username on the instance, the instance creates a new account for the user. If there is an account with a matching username on the instance, the user signs into the account.{% ifversion scim-for-ghes %} {% data variables.product.product_name %} compares the claim from the IdP against all accounts on the instance, regardless of whether the accounts use built-in authentication or are already associated with a SAML identity.{% endif %} + +{% ifversion scim-for-ghes %} + +When using SAML SSO, a site administrator can configure custom user attributes for the instance. A custom username attribute will allow the instance to use a value from the IdP other than `NameID`. {% data variables.product.product_name %} will respect this mapping when SCIM is configured. For more information about mapping user attributes, see "[Configuring SAML single sign-on for your enterprise](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise#configuring-saml-sso)." + +{% endif %} + +If {% data variables.product.product_name %} successfully identifies a user from the IdP, but account details such as email address, first name, or last name don't match, the instance updates the details with values from the IdP. + +## Supported identity providers + +The following IdPs support user provisioning with SCIM for {% data variables.product.product_name %}. + +{% data reusables.saml.okta-ae-sso-beta %} + +{% data reusables.github-ae.saml-idp-table %} + +{% data reusables.scim.ghes-scim-beta-note %} + +{% data reusables.scim.ghes-scim-idp-table %} + +{% ifversion ghae %} +For IdPs that support team mapping, you can assign or unassign the application for {% data variables.product.product_name %} to groups of users in your IdP. These groups are then available to organization owners and team maintainers in {% data variables.location.product_location %} to map to {% data variables.product.product_name %} teams. For more information, see "[Mapping Okta groups to teams](/admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider/mapping-okta-groups-to-teams)." +{% endif %} + +## Prerequisites + +{% ifversion ghae %} + +- You must configure SAML SSO when you initialize {% data variables.product.product_name %}. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/initializing-github-ae)." + +{% elsif scim-for-ghes %} + +- {% data reusables.saml.ghes-you-must-configure-saml-sso %} + +- You must allow built-in authentication for users who don't have an account on your IdP. For more information, see "[Allowing built-in authentication for users outside your provider](/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider)." + +- Your IdP must support making SCIM calls to a Service Provider (SP). + +{% endif %} + +- You must have administrative access on your IdP to configure the application for user provisioning for {% data variables.product.product_name %}. + +## Enabling user provisioning for your enterprise + +{% ifversion scim-for-ghes %} + +To perform provisioning actions on your instance, you will create a dedicated machine user account and promote the account to an enterprise owner. + +After you enable SCIM on a {% data variables.product.product_name %} instance, all user accounts are suspended. If you grant the user access to your instance from your IdP and the user authenticates successfully, the user's account will be unsuspended. + +{% endif %} + +{%- ifversion ghae %} +1. While signed into {% data variables.location.product_location %} as an enterprise owner, create a {% data variables.product.pat_v1 %} with **admin:enterprise** scope. For more information, see "[Creating a {% data variables.product.pat_generic %}](/github/authenticating-to-github/creating-a-personal-access-token)." + {% note %} + + **Notes**: + - To create the {% data variables.product.pat_generic %}, we recommend using the account for the first enterprise owner that you created during initialization. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/initializing-github-ae)." + - You'll need this {% data variables.product.pat_generic %} to configure the application for SCIM on your IdP. Store the token securely in a password manager until you need the token again later in these instructions. + + {% endnote %} + {% warning %} + + **Warning**: If the user account for the enterprise owner who creates the {% data variables.product.pat_generic %} is deactivated or deprovisioned, your IdP will no longer provision and deprovision user accounts for your enterprise automatically. Another enterprise owner must create a new {% data variables.product.pat_generic %} and reconfigure provisioning on the IdP. + + {% endwarning %} +{%- elsif scim-for-ghes %} +1. Create a dedicated machine user account to perform provisioning actions on your instance. For more information, see "[Allowing built-in authentication for users outside your provider](/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider#inviting-users-outside-your-provider-to-authenticate-to-your-instance)." +1. Promote the dedicated user account to an enterprise owner. For more information, see "[Inviting people to manage your enterprise](/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise#adding-an-enterprise-administrator-to-your-enterprise-account)." +1. Sign into your instance as the new enterprise owner. +1. Create a {% data variables.product.pat_v1 %} with **admin:enterprise** scope. For more information, see "[Creating a {% data variables.product.pat_generic %}](/github/authenticating-to-github/creating-a-personal-access-token)." + + {% note %} + + **Note**: You'll need this {% data variables.product.pat_generic %} to test the SCIM configuration, and to configure the application for SCIM on your IdP. Store the token securely in a password manager until you need the token again later in these instructions. + + {% endnote %} +{% data reusables.enterprise_installation.ssh-into-instance %} +1. To enable SCIM, run the commands provided to you by your account manager on {% data variables.contact.contact_enterprise_sales %}. +{% data reusables.enterprise_site_admin_settings.wait-for-configuration-run %} +1. To validate that SCIM is operational, run the following commands. Replace _PAT FROM STEP 3_ and _YOUR INSTANCE'S HOSTNAME_ with actual values. + + ```shell + $ GHES_PAT="PAT FROM STEP 3" + $ GHES_HOSTNAME="YOUR INSTANCE'S HOSTNAME" + $ curl --location --request GET 'https://$GHES_HOSTNAME/api/v3/scim/v2/Users' \ + --header 'Content-Type: application/scim' \ + --header 'Authorization: Bearer $GHES_PAT' + ``` + + The command should return an empty array. +{%- endif %} +{%- ifversion ghae %} +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +1. Under "SCIM User Provisioning", select **Require SCIM user provisioning**. + ![Checkbox for "Require SCIM user provisioning" within enterprise security settings](/assets/images/help/enterprises/settings-require-scim-user-provisioning.png) +1. Click **Save**. + ![Save button under "Require SCIM user provisioning" within enterprise security settings](/assets/images/help/enterprises/settings-scim-save.png) +{%- endif %} +1. Configure user provisioning in the application for {% data variables.product.product_name %} on your IdP. + + {%- ifversion ghae %} The following IdPs provide documentation about configuring provisioning for {% data variables.product.product_name %}. If your IdP isn't listed, please contact your IdP to request support for {% data variables.product.product_name %}. + {%- elsif scim-for-ghes %} {% data variables.product.company_short %} provides documentation for configuring provisioning for the following IdPs.{% endif %} + + | IdP | More information | + | :- | :- | + | Azure AD | {% ifversion ghae %}[Tutorial: Configure {% data variables.product.prodname_ghe_managed %} for automatic user provisioning](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-provisioning-tutorial) in the Microsoft Docs. {% endif %}To configure Azure AD for {% data variables.product.product_name %}, see "[Configuring authentication and provisioning for your enterprise using Azure AD](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad)." | +| Okta | {% ifversion ghae %}(beta){% endif %} To configure Okta for {% data variables.product.product_name %}, see "[Configuring authentication and provisioning for your enterprise using Okta](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-okta)." | + + The application on your IdP requires two values to provision or deprovision user accounts on {% data variables.location.product_location %}. + + | Value | Other names | Description | Example | + | :- | :- | :- | :- | + | URL | Tenant URL | URL to the SCIM provisioning API for your enterprise on {% data variables.product.prodname_ghe_managed %} | {% data variables.product.api_url_pre %}/scim/v2 | + | Shared secret | {% data variables.product.pat_generic_caps %}, secret token | Token for application on your IdP to perform provisioning tasks on behalf of an enterprise owner | {% data variables.product.pat_generic_caps %} you created in step {% ifversion ghae %}1{% elsif scim-for-ghes %}4{% endif %} | \ No newline at end of file diff --git a/translations/ja-JP/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md b/translations/ja-JP/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md index 9fed0e1cbb..7d70d6d397 100644 --- a/translations/ja-JP/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md +++ b/translations/ja-JP/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md @@ -100,7 +100,7 @@ In the list of pending members, for any individual account, you can cancel all i {% endnote %} -If you use {% data variables.product.prodname_vss_ghe %}, the list of pending invitations includes all {% data variables.product.prodname_vs %} subscribers that haven't joined any of your organizations on {% data variables.product.prodname_dotcom %}, even if the subscriber does not have a pending invitation to join an organization. For more information about how to get {% data variables.product.prodname_vs %} subscribers access to {% data variables.product.prodname_enterprise %}, see "[Setting up {% data variables.product.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise)." +If you use {% data variables.visual_studio.prodname_vss_ghe %}, the list of pending invitations includes all {% data variables.product.prodname_vs %} subscribers that haven't joined any of your organizations on {% data variables.product.prodname_dotcom %}, even if the subscriber does not have a pending invitation to join an organization. For more information about how to get {% data variables.product.prodname_vs %} subscribers access to {% data variables.product.prodname_enterprise %}, see "[Setting up {% data variables.visual_studio.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise)." {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.people-tab %} diff --git a/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md b/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md index b2c8f13f0b..d313679e4d 100644 --- a/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md +++ b/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md @@ -1,6 +1,6 @@ --- -title: About authentication with SAML single sign-on -intro: 'You can access {% ifversion ghae %}{% data variables.location.product_location %}{% elsif ghec %}an organization that uses SAML single sign-on (SSO){% endif %} by authenticating {% ifversion ghae %}with SAML single sign-on (SSO) {% endif %}through an identity provider (IdP).' +title: SAMLのシングルサインオンでの認証について +intro: '{% ifversion ghae %}{% data variables.location.product_location %}{% elsif ghec %}SAML シングル サインオン (SSO) を使う組織{% endif %}にアクセスするには、ID プロバイダー (IdP) を介して{% ifversion ghae %} SAML シングル サインオン (SSO) で{% endif %}認証を行います。' redirect_from: - /articles/about-authentication-with-saml-single-sign-on - /github/authenticating-to-github/about-authentication-with-saml-single-sign-on @@ -11,62 +11,67 @@ versions: topics: - SSO shortTitle: SAML single sign-on +ms.openlocfilehash: 827db3181f742916ba4fdeefd92f25c196c28188 +ms.sourcegitcommit: bf11c3e08cbb5eab6320e0de35b32ade6d863c03 +ms.translationtype: HT +ms.contentlocale: ja-JP +ms.lasthandoff: 10/27/2022 +ms.locfileid: '148111514' --- -## About authentication with SAML SSO +## SAML SSO での認証について {% ifversion ghae %} -SAML SSO allows an enterprise owner to centrally control and secure access to {% data variables.product.product_name %} from a SAML IdP. When you visit {% data variables.location.product_location %} in a browser, {% data variables.product.product_name %} will redirect you to your IdP to authenticate. After you successfully authenticate with an account on the IdP, the IdP redirects you back to {% data variables.location.product_location %}. {% data variables.product.product_name %} validates the response from your IdP, then grants access. +SAML SSO を使用すると、Enterprise のオーナーは、SAML IdP から {% data variables.product.product_name %} へのアクセスを一元的に制御して保護できます。 ブラウザーで {% data variables.location.product_location %} にアクセスすると、認証のために {% data variables.product.product_name %} によって IdP にリダイレクトされます。 IdP のアカウントで正常に認証されると、IdP によって {% data variables.location.product_location %} にリダイレクトされます。 {% data variables.product.product_name %} は、IdP からのレスポンスを検証してから、アクセスを許可します。 {% data reusables.saml.you-must-periodically-authenticate %} -If you can't access {% data variables.product.product_name %}, contact your local enterprise owner or administrator for {% data variables.product.product_name %}. You may be able to locate contact information for your enterprise by clicking **Support** at the bottom of any page on {% data variables.product.product_name %}. {% data variables.product.company_short %} and {% data variables.contact.github_support %} do not have access to your IdP, and cannot troubleshoot authentication problems. +{% data variables.product.product_name %} にアクセスできない場合は、担当の Enterprise のオーナーまたは管理者に {% data variables.product.product_name %} についてお問い合わせください。 {% data variables.product.product_name %} のページの下部にある **[サポート]** をクリックすると、Enterprise の連絡先情報を確認することができます。 {% data variables.product.company_short %} および {% data variables.contact.github_support %} は IdP にアクセスできず、認証の問題をトラブルシューティングできません。 {% endif %} {% ifversion ghec %} -{% data reusables.saml.dotcom-saml-explanation %} Organization owners can invite your personal account on {% data variables.product.prodname_dotcom %} to join their organization that uses SAML SSO, which allows you to contribute to the organization and retain your existing identity and contributions on {% data variables.product.prodname_dotcom %}. +{% data reusables.saml.dotcom-saml-explanation %} Organization のオーナーは、{% data variables.product.prodname_dotcom %}で個人アカウントを SAML SSO を使用する Organization に招待できます。これにより、Organization に貢献することができ、{% data variables.product.prodname_dotcom %}の既存の ID とコントリビューションを保持できます。 -If you're a member of an {% data variables.enterprise.prodname_emu_enterprise %}, you will instead use a new account that is provisioned for you and controlled by your enterprise. {% data reusables.enterprise-accounts.emu-more-info-account %} +{% data variables.enterprise.prodname_emu_enterprise %} のメンバーである場合は、プロビジョニングされ、エンタープライズによって管理された新しいアカウントを代わりに使用します。 {% data reusables.enterprise-accounts.emu-more-info-account %} -When you attempt to access most resources within an organization that uses SAML SSO, {% data variables.product.prodname_dotcom %} will redirect you to the organization's SAML IdP to authenticate. After you successfully authenticate with your account on the IdP, the IdP redirects you back to {% data variables.product.prodname_dotcom %}, where you can access the organization's resources. +SAML SSO を使用する組織内のプライベート リソースにアクセスすると、{% data variables.product.prodname_dotcom %} によって認証のために組織の SAML IdP にリダイレクトされます。 IdP でアカウントが正常に認証されると、IdP は{% data variables.product.prodname_dotcom %}に戻り、Organization のリソースにアクセスできます。 {% data reusables.saml.resources-without-sso %} {% data reusables.saml.outside-collaborators-exemption %} -If you have recently authenticated with your organization's SAML IdP in your browser, you are automatically authorized when you access a {% data variables.product.prodname_dotcom %} organization that uses SAML SSO. If you haven't recently authenticated with your organization's SAML IdP in your browser, you must authenticate at the SAML IdP before you can access the organization. +最近ブラウザで Organization の SAML IdP が認証された場合、SAML SSO を使う {% data variables.product.prodname_dotcom %} の Organization へのアクセスは自動的に認可されます。 最近ブラウザで Organization の SAML IdP が認証されていない場合は、Organization にアクセスする前に SAML IdP で認証を受ける必要があります。 {% data reusables.saml.you-must-periodically-authenticate %} -## Linked SAML identities +## リンクされた SAML ID -When you authenticate with your IdP account and return to {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_dotcom %} will record a link in the organization or enterprise between your {% data variables.product.prodname_dotcom %} personal account and the SAML identity you signed into. This linked identity is used to validate your membership in that organization, and depending on your organization or enterprise setup, is also used to determine which organizations and teams you're a member of as well. Each {% data variables.product.prodname_dotcom %} account can be linked to exactly one SAML identity per organization. Likewise, each SAML identity can be linked to exactly one {% data variables.product.prodname_dotcom %} account in an organization. +IdP アカウントで認証を行い、{% data variables.product.prodname_dotcom %} に戻ると、{% data variables.product.prodname_dotcom %} は、{% data variables.product.prodname_dotcom %} 個人アカウントとサインインした SAML ID の間の組織またはエンタープライズ内のリンクを記録します。 このリンク ID は、その組織のメンバーシップを検証するために使用されます。また、組織またはエンタープライズの設定に応じて、あなたがどの組織やチームのメンバーになっているかを判断するためにも使用されます。 各 {% data variables.product.prodname_dotcom %} アカウントは、組織ごとに 1 つの SAML ID にリンクできます。 同様に、各 SAML ID は、組織内の 1 つの {% data variables.product.prodname_dotcom %} アカウントにリンクできます。 -If you sign in with a SAML identity that is already linked to another {% data variables.product.prodname_dotcom %} account, you will receive an error message indicating that you cannot sign in with that SAML identity. This situation can occur if you are attempting to use a new {% data variables.product.prodname_dotcom %} account to work inside of your organization. If you didn't intend to use that SAML identity with that {% data variables.product.prodname_dotcom %} account, then you'll need to sign out of that SAML identity and then repeat the SAML login. If you do want to use that SAML identity with your {% data variables.product.prodname_dotcom %} account, you'll need to ask your admin to unlink your SAML identity from your old account, so that you can link it to your new account. Depending on the setup of your organization or enterprise, your admin may also need to reassign your identity within your SAML provider. For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)." +別の {% data variables.product.prodname_dotcom %} アカウントに既にリンクされている SAML ID でサインインすると、その SAML ID でサインインできないことを示すエラー メッセージが表示されます。 この状況は、組織内で新しい {% data variables.product.prodname_dotcom %} アカウントを使用しようとしている場合に発生する可能性があります。 その {% data variables.product.prodname_dotcom %} アカウントでその SAML ID を使用しない場合は、その SAML ID からサインアウトしてから、SAML ログインを繰り返す必要があります。 その SAML ID を {% data variables.product.prodname_dotcom %} アカウントで使用する場合は、新しいアカウントにリンクできるように、古いアカウントから SAML ID のリンクを解除するように管理者に依頼する必要があります。 組織またはエンタープライズの設定によっては、管理者が SAML プロバイダー内で ID を再割り当てする必要がある場合もあります。 詳細については、「[Organization へのメンバーの SAML アクセスの表示と管理](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)」を参照してください。 -If the SAML identity you sign in with does not match the SAML identity that is currently linked to your {% data variables.product.prodname_dotcom %} account, you'll receive a warning that you are about to relink your account. Because your SAML identity is used to govern access and team membership, continuing with the new SAML identity can cause you to lose access to teams and organizations inside of {% data variables.product.prodname_dotcom %}. Only continue if you know that you're supposed to use that new SAML identity for authentication in the future. +サインインする SAML ID が、現在 {% data variables.product.prodname_dotcom %} アカウントにリンクされている SAML ID と一致しない場合は、アカウントを再リンクしようとしているという警告が表示されます。 SAML ID はアクセスとチーム メンバーシップを管理するために使用されるため、新しい SAML ID を使用して続けると、{% data variables.product.prodname_dotcom %} 内のチームや組織にアクセスできなくなる可能性があります。 今後、その新しい SAML ID を認証に使用することがわかっている場合にのみ続けます。 -## Authorizing {% data variables.product.pat_generic %}s and SSH keys with SAML SSO +## SAML SSO を使った {% data variables.product.pat_generic %} と SSH キーの認可 -To use the API or Git on the command line to access protected content in an organization that uses SAML SSO, you will need to use an authorized {% data variables.product.pat_generic %} over HTTPS or an authorized SSH key. +SAML SSO を使用する資格組織内の保護されたコンテンツにアクセスするために API またはコマンドライン上の Git を利用するには、認可された {% data variables.product.pat_generic %} を HTTPS 経由で使うか、認可された SSH キーを使う必要があります。 -If you don't have a {% data variables.product.pat_generic %} or an SSH key, you can create a {% data variables.product.pat_generic %} for the command line or generate a new SSH key. For more information, see "[Creating a {% data variables.product.pat_generic %}](/github/authenticating-to-github/creating-a-personal-access-token)" or "[Generating a new SSH key and adding it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." +{% data variables.product.pat_generic %} または SSH キーを持っていない場合は、コマンド ラインの {% data variables.product.pat_generic %} を作成するか、新しい SSH キーを生成することができます。 詳細については、「[{% data variables.product.pat_generic %} の作成](/github/authenticating-to-github/creating-a-personal-access-token)」または「[新しい SSH キーの生成と ssh-agent への追加](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)」を参照してください。 -To use a new or existing {% data variables.product.pat_generic %} or SSH key with an organization that uses or enforces SAML SSO, you will need to authorize the token or authorize the SSH key for use with a SAML SSO organization. For more information, see "[Authorizing a {% data variables.product.pat_generic %} for use with SAML single sign-on](/articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" or "[Authorizing an SSH key for use with SAML single sign-on](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)." +新しい、または既存の {% data variables.product.pat_generic %} か SSH キーを、SAML SSO を使用または要求する組織で利用するには、SAML SSO 組織で使うためにそのトークンや SSH キーを認可する必要があります。 詳細については、「[SAML シングル サインオンで利用するために {% data variables.product.pat_generic %} を承認する](/articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)」または「[SAML シングル サインオンで利用するために SSH キーを承認する](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)」を参照してください。 -## About {% data variables.product.prodname_oauth_apps %}, {% data variables.product.prodname_github_apps %}, and SAML SSO +## {% data variables.product.prodname_oauth_apps %}、{% data variables.product.prodname_github_apps %}、SAML SSO について -You must have an active SAML session each time you authorize an {% data variables.product.prodname_oauth_app %} or {% data variables.product.prodname_github_app %} to access an organization that uses or enforces SAML SSO. You can create an active SAML session by navigating to `https://github.com/orgs/ORGANIZATION-NAME/sso` in your browser. +SAML SSO を使用または要求する Organization にアクセスする {% data variables.product.prodname_oauth_app %} または {% data variables.product.prodname_github_app %} を認証するたびにアクティブな SAML セッションが必要です。 ブラウザーで `https://github.com/orgs/ORGANIZATION-NAME/sso` に移動し、アクティブな SAML セッションを作成できます。 -After an enterprise or organization owner enables or enforces SAML SSO for an organization, and after you authenticate via SAML for the first time, you must reauthorize any {% data variables.product.prodname_oauth_apps %} or {% data variables.product.prodname_github_apps %} that you previously authorized to access the organization. +企業または組織の所有者が Organization の SAML SSO を有効にしたか、適用した後、SAML を使用して初めて認証した後、以前に Organization へのアクセスを許可した {% data variables.product.prodname_oauth_apps %} または {% data variables.product.prodname_github_apps %} を再認証する必要があります。 -To see the {% data variables.product.prodname_oauth_apps %} you've authorized, visit your [{% data variables.product.prodname_oauth_apps %} page](https://github.com/settings/applications). To see the {% data variables.product.prodname_github_apps %} you've authorized, visit your [{% data variables.product.prodname_github_apps %} page](https://github.com/settings/apps/authorizations). +認証した {% data variables.product.prodname_oauth_apps %} を表示するには、[{% data variables.product.prodname_oauth_apps %} ページ](https://github.com/settings/applications)にアクセスします。 認証した {% data variables.product.prodname_github_apps %} を表示するには、[{% data variables.product.prodname_github_apps %} ページ](https://github.com/settings/apps/authorizations)にアクセスします。 {% endif %} -## Further reading +## 参考資料 -{% ifversion ghec %}- "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)"{% endif %} -{% ifversion ghae %}- "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)"{% endif %} +{% ifversion ghec %}- 「[SAML シングル サインオンを使用した ID およびアクセス管理について](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)」{% endif %} {% ifversion ghae %}- 「[Enterprise の ID およびアクセス管理について](/admin/authentication/about-identity-and-access-management-for-your-enterprise)」{% endif %} diff --git a/translations/ja-JP/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md b/translations/ja-JP/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md index af80bbb3a1..59d219df32 100644 --- a/translations/ja-JP/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md +++ b/translations/ja-JP/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md @@ -19,17 +19,17 @@ topics: shortTitle: About --- -## About {% data variables.product.prodname_vss_ghe %} +## About {% data variables.visual_studio.prodname_vss_ghe %} -{% data reusables.enterprise-accounts.vss-ghe-description %} {% data variables.product.prodname_vss_ghe %} is available from Microsoft under the terms of the Microsoft Enterprise Agreement. For more information, see [{% data variables.product.prodname_vss_ghe %}](https://visualstudio.microsoft.com/subscriptions/visual-studio-github/) on the {% data variables.product.prodname_vs %} website. +{% data reusables.enterprise-accounts.vss-ghe-description %} {% data variables.visual_studio.prodname_vss_ghe %} is available from Microsoft under the terms of the Microsoft Enterprise Agreement. For more information, see [{% data variables.visual_studio.prodname_vss_ghe %}](https://visualstudio.microsoft.com/subscriptions/visual-studio-github/) on the {% data variables.product.prodname_vs %} website. To use the {% data variables.product.prodname_enterprise %} portion of the license, each subscriber's personal account on {% data variables.product.prodname_dotcom_the_website %} must be or become a member of an organization owned by your enterprise on {% data variables.product.prodname_dotcom_the_website %}. To accomplish this, organization owners can invite new members to an organization by email address. The subscriber can accept the invitation with an existing personal account on {% data variables.product.prodname_dotcom_the_website %} or create a new account. -For more information about the setup of {% data variables.product.prodname_vss_ghe %}, see "[Setting up {% data variables.product.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise)." +For more information about the setup of {% data variables.visual_studio.prodname_vss_ghe %}, see "[Setting up {% data variables.visual_studio.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise)." -## About licenses for {% data variables.product.prodname_vss_ghe %} +## About licenses for {% data variables.visual_studio.prodname_vss_ghe %} -After you assign a license for {% data variables.product.prodname_vss_ghe %} to a subscriber, the subscriber will use the {% data variables.product.prodname_enterprise %} portion of the license by joining an organization in your enterprise with a personal account on {% data variables.product.prodname_dotcom_the_website %}. If the verified email address for the personal account of an enterprise member on {% data variables.product.prodname_dotcom_the_website %} matches the User Primary Name (UPN) for a subscriber to your {% data variables.product.prodname_vs %} account, the {% data variables.product.prodname_vs %} subscriber will automatically consume one license for {% data variables.product.prodname_vss_ghe %}. +After you assign a license for {% data variables.visual_studio.prodname_vss_ghe %} to a subscriber, the subscriber will use the {% data variables.product.prodname_enterprise %} portion of the license by joining an organization in your enterprise with a personal account on {% data variables.product.prodname_dotcom_the_website %}. If the verified email address for the personal account of an enterprise member on {% data variables.product.prodname_dotcom_the_website %} matches the User Primary Name (UPN) for a subscriber to your {% data variables.product.prodname_vs %} account, the {% data variables.product.prodname_vs %} subscriber will automatically consume one license for {% data variables.visual_studio.prodname_vss_ghe %}. The total quantity of your licenses for your enterprise on {% data variables.product.prodname_dotcom %} is the sum of any standard {% data variables.product.prodname_enterprise %} licenses and the number of {% data variables.product.prodname_vs %} subscription licenses that include access to {% data variables.product.prodname_dotcom %}. If the personal account for an enterprise member does not correspond with the email address for a {% data variables.product.prodname_vs %} subscriber, the license that the personal account consumes is unavailable for a {% data variables.product.prodname_vs %} subscriber. @@ -43,7 +43,7 @@ You can view the number of {% data variables.product.prodname_enterprise %} lice {% endtip %} -You can also see pending {% data variables.product.prodname_enterprise %} invitations to subscribers in {% data variables.product.prodname_vss_admin_portal_with_url %}. +You can also see pending {% data variables.product.prodname_enterprise %} invitations to subscribers in {% data variables.visual_studio.prodname_vss_admin_portal_with_url %}. ## Further reading diff --git a/translations/ja-JP/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md b/translations/ja-JP/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md index 41af3a41ef..5426d14e28 100644 --- a/translations/ja-JP/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md +++ b/translations/ja-JP/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md @@ -10,18 +10,18 @@ topics: shortTitle: Set up --- -## About setup of {% data variables.product.prodname_vss_ghe %} +## About setup of {% data variables.visual_studio.prodname_vss_ghe %} -{% data reusables.enterprise-accounts.vss-ghe-description %} For more information, see "[About {% data variables.product.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise)." +{% data reusables.enterprise-accounts.vss-ghe-description %} For more information, see "[About {% data variables.visual_studio.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise)." This guide shows you how your team can get {% data variables.product.prodname_vs %} subscribers licensed and started with {% data variables.product.prodname_enterprise %}. If you prefer video, you can watch [Setting up your {% data variables.product.prodname_enterprise %} licenses with {% data variables.product.prodname_vs %} subscriptions](https://www.youtube.com/watch?v=P_zBgp_BE_I) on Microsoft Visual Studio's YouTube channel. -## Roles for {% data variables.product.prodname_vss_ghe %} +## Roles for {% data variables.visual_studio.prodname_vss_ghe %} -Before setting up {% data variables.product.prodname_vss_ghe %}, it's important to understand the roles for this combined offering. +Before setting up {% data variables.visual_studio.prodname_vss_ghe %}, it's important to understand the roles for this combined offering. | Role | Service | Description | More information | | :- | :- | :- | :- | @@ -38,15 +38,15 @@ Before setting up {% data variables.product.prodname_vss_ghe %}, it's important - Your team must have an enterprise on {% data variables.location.product_location %}. If you're not sure whether your team has an enterprise, contact your {% data variables.product.prodname_dotcom %} administrator. If you're not sure who on your team is responsible for {% data variables.product.prodname_dotcom %}, contact {% data variables.contact.contact_enterprise_sales %}. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." -## Setting up {% data variables.product.prodname_vss_ghe %} +## Setting up {% data variables.visual_studio.prodname_vss_ghe %} -To set up {% data variables.product.prodname_vss_ghe %}, members of your team must complete the following tasks. +To set up {% data variables.visual_studio.prodname_vss_ghe %}, members of your team must complete the following tasks. -One person may be able to complete the tasks because the person has all of the roles, but you may need to coordinate the tasks with multiple people. For more information, see "[Roles for {% data variables.product.prodname_vss_ghe %}](#roles-for-visual-studio-subscriptions-with-github-enterprise)." +One person may be able to complete the tasks because the person has all of the roles, but you may need to coordinate the tasks with multiple people. For more information, see "[Roles for {% data variables.visual_studio.prodname_vss_ghe %}](#roles-for-visual-studio-subscriptions-with-github-enterprise)." 1. An enterprise owner must create at least one organization in your enterprise on {% data variables.location.product_location %}. For more information, see "[Adding organizations to your enterprise](/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise)." -1. The subscription admin must assign a license for {% data variables.product.prodname_vs %} to a subscriber in {% data variables.product.prodname_vss_admin_portal_with_url %}. For more information, see [Overview of the {% data variables.product.prodname_vs %} Subscriptions Administrator Portal](https://docs.microsoft.com/en-us/visualstudio/subscriptions/using-admin-portal) and [Assign {% data variables.product.prodname_vs %} Licenses in the {% data variables.product.prodname_vs %} Subscriptions Administration Portal](https://docs.microsoft.com/en-us/visualstudio/subscriptions/assign-license) in Microsoft Docs. +1. The subscription admin must assign a license for {% data variables.product.prodname_vs %} to a subscriber in {% data variables.visual_studio.prodname_vss_admin_portal_with_url %}. For more information, see [Overview of the {% data variables.product.prodname_vs %} Subscriptions Administrator Portal](https://docs.microsoft.com/en-us/visualstudio/subscriptions/using-admin-portal) and [Assign {% data variables.product.prodname_vs %} Licenses in the {% data variables.product.prodname_vs %} Subscriptions Administration Portal](https://docs.microsoft.com/en-us/visualstudio/subscriptions/assign-license) in Microsoft Docs. 1. Optionally, if the subscription admin assigned licenses to subscribers in {% data variables.product.prodname_vs %} before adding {% data variables.product.prodname_enterprise %} to the subscription, the subscription admin can move the subscribers to the combined offering in the {% data variables.product.prodname_vs %} administration portal. For more information, see [Manage {% data variables.product.prodname_vs %} subscriptions with {% data variables.product.prodname_enterprise %}](https://docs.microsoft.com/en-us/visualstudio/subscriptions/assign-github#moving-to-visual-studio-with-github-enterprise) in Microsoft Docs. @@ -64,7 +64,7 @@ One person may be able to complete the tasks because the person has all of the r {% endtip %} -After {% data variables.product.prodname_vss_ghe %} is set up for subscribers on your team, enterprise owners can review licensing information on {% data variables.location.product_location %}. For more information, see "[Viewing the subscription and usage for your enterprise account](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)." +After {% data variables.visual_studio.prodname_vss_ghe %} is set up for subscribers on your team, enterprise owners can review licensing information on {% data variables.location.product_location %}. For more information, see "[Viewing the subscription and usage for your enterprise account](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)." ## Further reading diff --git a/translations/ja-JP/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md b/translations/ja-JP/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md index 1021522c66..7bc6979232 100644 --- a/translations/ja-JP/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md +++ b/translations/ja-JP/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md @@ -1,6 +1,6 @@ --- -title: GitHub Enterprise のライセンス使用状況のトラブルシューティング -intro: ライセンス レポートを監査することで、エンタープライズ向けのライセンス使用状況のトラブルシューティングを行うことができます。 +title: Troubleshooting license usage for GitHub Enterprise +intro: You can troubleshoot license usage for your enterprise by auditing license reports. permissions: 'Enterprise owners can review license usage for {% data variables.product.prodname_enterprise %}.' versions: ghec: '*' @@ -10,30 +10,25 @@ topics: - Enterprise - Licensing shortTitle: Troubleshoot license usage -ms.openlocfilehash: f23ca2380e71f5b037278c71da57dc8fab94c750 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147572663' --- -## 想定外のライセンス使用状況について -エンタープライズの使用済みライセンス数が想定外だった場合、使用済みライセンス レポートを確認し、エンタープライズのデプロイとサブスクリプション全体のライセンス使用状況を監査することができます。 詳しくは、「[GitHub Enterprise のライセンス使用状況の表示](/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise)」と「[エンタープライズ アカウントのサブスクリプションと使用状況の表示](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)」を参照してください。 +## About unexpected license usage -エラーが見つかった場合は、トラブルシューティング手順を試すことができます。 +If the number of consumed licenses for your enterprise is unexpected, you can review your consumed license report to audit your license usage across all your enterprise deployments and subscriptions. For more information, see "[Viewing license usage for GitHub Enterprise](/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise)" and "[Viewing the subscription and usage for your enterprise account](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)." -プライバシー上の理由から、{% data variables.product.prodname_emus %} を使用しない限り、Enterprise 所有者はユーザー アカウントの詳細に直接アクセスできません。 +If you find errors, you can try troubleshooting steps. -## 使用済みライセンスの計算について +For privacy reasons, enterprise owners cannot directly access the details of user accounts unless you use {% data variables.product.prodname_emus %}. -{% data variables.product.company_short %} の課金対象は、{% data variables.product.prodname_ghe_server %} のデプロイを使う人、{% data variables.product.prodname_ghe_cloud %} 上の Organization のメンバーである人、または {% data variables.product.prodname_vs_subscriber %} である人です。 ライセンスを使用している Enterprise 内の個人について詳しくは「[ユーザーごとの価格付けについて](/billing/managing-billing-for-your-github-account/about-per-user-pricing)」を参照してください。 +## About the calculation of consumed licenses -使用するデプロイの数に関係なく、各ユーザーが 1 つのシートを使用するには、{% data variables.product.prodname_ghe_server %} と {% data variables.product.prodname_ghe_cloud %} の間でライセンスの使用状況を同期する必要があります。 詳細については、「[{% data variables.product.prodname_ghe_server %} と {% data variables.product.prodname_ghe_cloud %} の間でユーザー ライセンスの使用状況を手動で同期する](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)」を参照してください。 +{% data variables.product.company_short %} bills for each person who uses deployments of {% data variables.product.prodname_ghe_server %}, is a member of one of your organizations on {% data variables.product.prodname_ghe_cloud %}, or is a {% data variables.visual_studio.prodname_vs_subscriber %}. For more information about the people in your enterprise who consume a license, see "[About per-user pricing](/billing/managing-billing-for-your-github-account/about-per-user-pricing)." -ライセンス使用状況を同期すると、{% data variables.product.prodname_dotcom %} では、{% data variables.product.prodname_ghe_server %} のユーザー アカウントと、{% data variables.product.prodname_ghe_cloud %} のユーザー アカウントをメール アドレスを使って照合します。 +For each user to consume a single seat regardless of how many deployments they use, you must synchronize license usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Syncing license usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)." -まず、{% data variables.product.prodname_ghe_server %} の各ユーザーのプライマリ メール アドレスを確認します。 次に、そのアドレスと {% data variables.product.prodname_ghe_cloud %} のユーザー アカウントのメール アドレスを照合します。 Enterprise で SAML SSO を使用している場合は、まず次の SAML 属性でメール アドレスを確認します。 +After you synchronize license usage, {% data variables.product.prodname_dotcom %} matches user accounts on {% data variables.product.prodname_ghe_server %} with user accounts on {% data variables.product.prodname_ghe_cloud %} by email address. + +First, we first check the primary email address of each user on {% data variables.product.prodname_ghe_server %}. Then, we attempt to match that address with the email address for a user account on {% data variables.product.prodname_ghe_cloud %}. If your enterprise uses SAML SSO, we first check the following SAML attributes for email addresses. - `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name` - `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` @@ -41,64 +36,64 @@ ms.locfileid: '147572663' - `NameID` - `emails` -これらの属性で見つかったメール アドレスが {% data variables.product.prodname_ghe_server %} のプライマリ メール アドレスと一致しない場合、または Enterprise が SAML SSO を使用していない場合は、{% data variables.product.prodname_ghe_cloud %} のユーザーの検証済みメール アドレスを確認します。 {% data variables.product.prodname_dotcom_the_website %} 上のメール アドレスの確認の詳細については、「[メール アドレスを検証する](/enterprise-cloud@latest/get-started/signing-up-for-github/verifying-your-email-address)」{% ifversion not ghec %}({% data variables.product.prodname_ghe_cloud %} ドキュメント){% else %}{% endif %}を参照してください。 +If no email addresses found in these attributes match the primary email address on {% data variables.product.prodname_ghe_server %}, or if your enterprise doesn't use SAML SSO, we then check each of the user's verified email addresses on {% data variables.product.prodname_ghe_cloud %}. For more information about verification of email addresses on {% data variables.product.prodname_dotcom_the_website %}, see "[Verifying your email address](/enterprise-cloud@latest/get-started/signing-up-for-github/verifying-your-email-address){% ifversion not ghec %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} -## 使用済みライセンス ファイルのフィールド +## Fields in the consumed license files -{% data variables.product.prodname_dotcom_the_website %} ライセンス使用状況レポートと {% data variables.product.prodname_ghe_server %} のエクスポートされたライセンス使用状況ファイルには、エンタープライズのライセンス使用状況のトラブルシューティングに役立つさまざまなフィールドが含まれています。 +The {% data variables.product.prodname_dotcom_the_website %} license usage report and {% data variables.product.prodname_ghe_server %} exported license usage file include a variety of fields to help you troubleshoot license usage for your enterprise. -### {% data variables.product.prodname_dotcom_the_website %} ライセンス使用状況レポート (CSV ファイル) +### {% data variables.product.prodname_dotcom_the_website %} license usage report (CSV file) -エンタープライズのライセンス使用状況レポートは、エンタープライズのメンバーに関する以下の情報を含む CSV ファイルです。 一部のフィールドは、{% data variables.product.prodname_ghe_cloud %} (GHEC) のデプロイ、{% data variables.product.prodname_ghe_server %} (GHES) の接続環境、または GitHub Enterprise との {% data variables.product.prodname_vs %} サブスクリプション (VSS) に固有のものです。 +The license usage report for your enterprise is a CSV file that contains the following information about members of your enterprise. Some fields are specific to your {% data variables.product.prodname_ghe_cloud %} (GHEC) deployment, {% data variables.product.prodname_ghe_server %} (GHES) connected environments, or your {% data variables.product.prodname_vs %} subscriptions (VSS) with GitHub Enterprise. -| フィールド | 説明 +| Field | Description | ----- | ----------- -| github_com_login | ユーザーの GHEC アカウントのユーザー名 -| github_com_name | ユーザーの GHEC アカウントの表示名 -| github_com_profile | GHEC のユーザーのプロファイル ページの URL -| github_com_user | ユーザーが GHEC のアカウントを持っているかどうか | -| github_com_member_roles | GHEC でユーザーが所属する Organization ごとの、コロンで区切られた Organization 名とその Organization 内の個人のロール (`Owner` または `Member`)

    コンマで区切られた Organization | -| github_com_enterprise_role | `Owner`、`Member`、`Outside collaborator` のいずれかです -| github_com_verified_domain_emails | Enterprise の検証済みドメインに一致するユーザーの GHEC アカウントに関連付けられているすべてのメール アドレス | -| github_com_saml_name_id | SAML ユーザー名 | -| github_com_orgs_with_pending_invites | ユーザーの GHEC アカウントが Enterprise 内の Organization に参加するための保留中のすべての招待 | -| license_type | `Visual Studio subscription` か `Enterprise` のいずれかです -| enterprise_server_user| ユーザーが GHES に少なくとも 1 つのアカウントを持っているかどうか | -| enterprise_server_primary_emails | 各ユーザーの GHES アカウントに関連付けられているプライマリ メール アドレス | -| enterprise_server_user_ids | ユーザーの GHES アカウントごとの、アカウントのユーザー ID -| total_user_accounts | 個人が GHEC と GHES の両方で持っているアカウントの合計数 -| visual_studio_subscription_user | ユーザーが {% data variables.product.prodname_vs_subscriber %} であるかどうか | -| visual_studio_subscription_email | ユーザーの VSS に関連付けられているメール アドレス | -| visual_studio_license_status | Visual Studio ライセンスが {% data variables.product.company_short %} ユーザーに一致しているかどうか | +| github_com_login | The username for the user's GHEC account +| github_com_name | The display name for the user's GHEC account +| github_com_profile | The URL for the user's profile page on GHEC +| github_com_user | Whether or not the user has an account on GHEC | +| github_com_member_roles | For each of the organizations the user belongs to on GHEC, the organization name and the user's role in that organization (`Owner` or `Member`) separated by a colon

    Organizations delimited by commas | +| github_com_enterprise_role | Can be one of: `Owner`, `Member`, or `Outside collaborator` +| github_com_verified_domain_emails | All email addresses associated with the user's GHEC account that match your enterprise's verified domains | +| github_com_saml_name_id | The SAML username | +| github_com_orgs_with_pending_invites | All pending invitations for the user's GHEC account to join organizations within your enterprise | +| license_type | Can be one of: `Visual Studio subscription` or `Enterprise` +| enterprise_server_user| Whether or not the user has at least one account on GHES | +| enterprise_server_primary_emails | The primary email addresses associated with each of the user's GHES accounts | +| enterprise_server_user_ids | For each of the user's GHES accounts, the account's user ID +| total_user_accounts | The total number of accounts the person has across both GHEC and GHES +| visual_studio_subscription_user | Whether or not the user is a {% data variables.visual_studio.prodname_vs_subscriber %} | +| visual_studio_subscription_email | The email address associated with the user's VSS | +| visual_studio_license_status | Whether the Visual Studio license has been matched to a {% data variables.product.company_short %} user | -エンタープライズ内の 1 つ以上の組織のメンバーになっていない {% data variables.product.prodname_vs_subscriber %} は、保留中の招待状態でレポートに含まれ、[Name]\(名前\) または [Profile link]\(プロファイル リンク\) フィールドの値は指定されません。 +{% data variables.visual_studio.prodname_vs_subscriber %}s who are not yet members of at least one organization in your enterprise will be included in the report with a pending invitation status, and will be missing values for the "Name" or "Profile link" field. -### {% data variables.product.prodname_ghe_server %} のエクスポートされたライセンス使用状況 (JSON ファイル) +### {% data variables.product.prodname_ghe_server %} exported license usage (JSON file) -{% data variables.product.prodname_ghe_server %} のライセンス使用状況は JSON ファイルであり、通常、{% data variables.product.prodname_ghe_server %} と {% data variables.product.prodname_ghe_cloud %} のデプロイ間でユーザー ライセンスの手動同期を実行するときに使われます。 このファイルには、{% data variables.product.prodname_ghe_server %} 環境に固有の次の情報が含まれています。 +Your {% data variables.product.prodname_ghe_server %} license usage is a JSON file that is typically used when performing a manual sync of user licenses between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} deployments. The file contains the following information specific to your {% data variables.product.prodname_ghe_server %} environment. -| フィールド | 説明 +| Field | Description | ----- | ----------- -| 機能 | {% data variables.product.prodname_ghe_server %} インスタンスで有効な {% data variables.product.prodname_github_connect %} 機能と、有効になった日時。 -| ホスト名 | {% data variables.product.prodname_ghe_server %} インスタンスのホスト名。 -| HTTP のみ | {% data variables.product.prodname_ghe_server %} インスタンス上でトランスポート層セキュリティ (TLS) が有効であり、構成されているかどうか。 `True` または `False` のいずれかにすることができます。 -| ライセンス | {% data variables.product.prodname_ghe_server %} ライセンスのハッシュ。 -| 公開キー | {% data variables.product.prodname_ghe_server %} ライセンスの公開キーの部分。 -| サーバー ID | {% data variables.product.prodname_ghe_server %} インスタンス用に生成された UUID。 -| Version | {% data variables.product.prodname_ghe_server %} インスタンスのバージョン。 +| Features | The {% data variables.product.prodname_github_connect %} features that are enabled on your {% data variables.product.prodname_ghe_server %} instance, and the date and time of enablement. +| Host name | The hostname of your {% data variables.product.prodname_ghe_server %} instance. +| HTTP only | Whether Transport Layer Security (TLS) is enabled and configured on your {% data variables.product.prodname_ghe_server %} instance. Can be one of: `True` or `False`. +| License | A hash of your {% data variables.product.prodname_ghe_server %} license. +| Public key | The public key portion of your {% data variables.product.prodname_ghe_server %} license. +| Server ID | UUID generated for your {% data variables.product.prodname_ghe_server %} instance. +| Version | The version of your {% data variables.product.prodname_ghe_server %} instance. -## 使用済みライセンスのトラブルシューティング +## Troubleshooting consumed licenses -各ユーザーが異なるデプロイとサブスクリプションに対して 1 つのシートのみを使用していることを確認するには、次のトラブルシューティングの手順を試してみてください。 +To ensure that the each user is only consuming a single seat for different deployments and subscriptions, try the following troubleshooting steps. -1. 複数のシートを使用しているユーザーを特定するために、Enterprise で {% data variables.product.prodname_ghe_cloud %} の検証済みドメインが使われている場合は、{% data variables.product.prodname_dotcom_the_website %} のアカウントに関連付けられている検証済みドメインのメール アドレスを持たない Enterprise メンバーのリストを確認します。 多くの場合、これらは誤って複数のライセンス シートを使っているユーザーです。 詳細については、「[検証済みドメインのメール アドレスを持たないメンバーの表示](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#viewing-members-without-an-email-address-from-a-verified-domain)」を参照してください。 +1. To help identify users that are consuming multiple seats, if your enterprise uses verified domains for {% data variables.product.prodname_ghe_cloud %}, review the list of enterprise members who do not have an email address from a verified domain associated with their account on {% data variables.product.prodname_dotcom_the_website %}. Often, these are the users who erroneously consume more than one licensed seat. For more information, see "[Viewing members without an email address from a verified domain](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#viewing-members-without-an-email-address-from-a-verified-domain)." {% note %} - **注:** トラブルシューティングを簡単に行えるようにするため {% data variables.product.prodname_dotcom_the_website %} の Enterprise アカウントで、検証済みドメインを使うことをお勧めします。 詳細については、「[エンタープライズのドメインの確認または承認](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)」を参照してください。 + **Note:** To make troubleshooting easier, we recommend using verified domains with your enterprise account on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Verifying or approving a domain for your enterprise](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)." {% endnote %} -1. 複数のシートを使用しているユーザーを特定したら、同じメール アドレスがすべてのユーザーのアカウントに関連付けられていることを確認します。 一致する必要があるメール アドレスについて詳しくは、「[使用されるライセンスの計算について](#about-the-calculation-of-consumed-licenses)」を参照してください。 -1. メール アドレスが最近更新されたか、不一致を修正するために検証された場合は、最後のライセンス同期ジョブのタイムスタンプを表示します。 修正が行われた後にジョブが実行されていない場合は、手動で新しいジョブをトリガーします。 詳細については、「[GitHub Enterprise Server と GitHub Enterprise Cloud 間のライセンス使用状況の同期](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)」を参照してください。 +1. After you identify users who are consuming multiple seats, make sure that the same email address is associated with all of the user's accounts. For more information about which email addresses must match, see "[About the calculation of consumed licenses](#about-the-calculation-of-consumed-licenses)." +1. If an email address was recently updated or verified to correct a mismatch, view the timestamp of the last license sync job. If a job hasn't run since the correction was made, manually trigger a new job. For more information, see "[Syncing license usage between GitHub Enterprise Server and GitHub Enterprise Cloud](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)." -前述のようにトラブルシューティング情報を確認した後も、使用済みライセンスについて不明な点がある場合は、{% data variables.contact.contact_enterprise_portal %} を使って {% data variables.contact.github_support %} に問い合わせることができます。 +If you still have questions about your consumed licenses after reviewing the troubleshooting information above, you can contact {% data variables.contact.github_support %} through the {% data variables.contact.contact_enterprise_portal %}. diff --git a/translations/ja-JP/content/code-security/secret-scanning/about-secret-scanning.md b/translations/ja-JP/content/code-security/secret-scanning/about-secret-scanning.md index f1c959c882..4db1d014b7 100644 --- a/translations/ja-JP/content/code-security/secret-scanning/about-secret-scanning.md +++ b/translations/ja-JP/content/code-security/secret-scanning/about-secret-scanning.md @@ -84,9 +84,9 @@ When you enable {% data variables.product.prodname_secret_scanning %} for a repo If {% data variables.product.prodname_secret_scanning %} detects a secret, {% data variables.product.prodname_dotcom %} generates an alert. -- {% data variables.product.prodname_dotcom %} sends an email alert to the repository administrators and organization owners. +- {% data variables.product.prodname_dotcom %} sends an email alert to the repository administrators and organization owners. You'll receive an alert if you are watching the repository, or if you have enabled notifications for security alerts, or for all the activity on the repository. {% ifversion ghes or ghae or ghec %} -- {% data variables.product.prodname_dotcom %} sends an email alert to the contributor who committed the secret to the repository, with a link to the related {% data variables.product.prodname_secret_scanning %} alert. The commit author can then view the alert in the repository, and resolve the alert. +- If the contributor who committed the secret isn't ignoring the repository, {% data variables.product.prodname_dotcom %} will also send an email alert to the contributor. The emails contains a link to the related {% data variables.product.prodname_secret_scanning %} alert. The commit author can then view the alert in the repository, and resolve the alert. {% endif %} - {% data variables.product.prodname_dotcom %} displays an alert in the "Security" tab of the repository. diff --git a/translations/ja-JP/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md b/translations/ja-JP/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md index 72be0fcd50..e9bad376b3 100644 --- a/translations/ja-JP/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md +++ b/translations/ja-JP/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md @@ -1,6 +1,7 @@ --- title: Managing alerts from secret scanning intro: You can view and close alerts for secrets checked in to your repository. +permissions: 'People with admin access to a repository can view and dismiss alerts.' product: '{% data reusables.gated-features.secret-scanning %}' redirect_from: - /github/administering-a-repository/managing-alerts-from-secret-scanning diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/opening-an-existing-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/opening-an-existing-codespace.md new file mode 100644 index 0000000000..32156c2ba0 --- /dev/null +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/opening-an-existing-codespace.md @@ -0,0 +1,78 @@ +--- +title: 既存の codespace を開く +intro: 終了または停止した codespace をもう一度開いて、作業に戻ることができます。 +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +type: how_to +topics: + - Codespaces + - Fundamentals + - Developer +shortTitle: Open an existing codespace +ms.openlocfilehash: 37eff72e5384ec5eda55708f7672cfe6832864c1 +ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 +ms.translationtype: HT +ms.contentlocale: ja-JP +ms.lasthandoff: 10/25/2022 +ms.locfileid: '148109579' +--- +{% data variables.product.prodname_dotcom_the_website %} や {% data variables.product.prodname_vscode %} で、または {% data variables.product.prodname_cli %} を使って、アクティブな codespace または停止している codespace をもう一度開くことができます。 削除された codespace を開き直すことはできません。 詳しくは、「[{% data variables.product.prodname_codespaces %} のライフサイクル](/codespaces/developing-in-codespaces/codespaces-lifecycle)」をご覧ください。 + +## 既存の codespace を開く + +{% webui %} + +{% data reusables.codespaces.your-codespaces-procedure-step %} +1. 既定のエディターで codespace を開くには、codespace の名前をクリックします。 {% data reusables.codespaces.about-changing-default-editor %}詳しくは、「[{% data variables.product.prodname_github_codespaces %} の既定のエディターを設定する](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)」をご覧ください。 + + 既定以外のエディターで codespace を開くには、codespace の右側にある省略記号 **[...]** を選んで、 **[<アプリケーション> で開く]** をクリックします。 + + ![[Visual Studio Code で開く] が強調されている "自分の codespace" ページのスクリーンショット](/assets/images/help/codespaces/open-codespace-in-another-editor.png) + +{% endwebui %} + +{% vscode %} + +{% note %} + +**注:** {% data reusables.codespaces.using-codespaces-in-vscode %}詳しくは、「[{% data variables.product.prodname_vscode %} で {% data variables.product.prodname_github_codespaces %} を使用する](/codespaces/developing-in-codespaces/using-github-codespaces-in-visual-studio-code)」をご覧ください。 + +{% endnote %} + +1. {% data variables.product.prodname_vscode_shortname %} デスクトップ アプリケーションで、Command + Shift + P (Mac) または Ctrl + Shift + P (Windows/Linux) を使ってコマンド パレットを開きます。 +1. 「Codespaces」と入力して、次のいずれかのコマンドを選びます。 + - {% data variables.product.prodname_vscode_shortname %} の新しいウィンドウで codespace を開くには、 **[Codespaces: 新しいウィンドウで codespace を開く]** を選びます + - Web エディターで codespace を開くには、 **[Codespaces: ブラウザーで開く]** を選びます +1. 開く codespace をクリックします。 + + ![Visual Studio Code での codespace の一覧のスクリーンショット](/assets/images/help/codespaces/open-codespace-from-vscode.png) + +{% data variables.product.prodname_vscode_shortname %} のリモート エクスプローラー ビューに移動し、開く codespace を右クリックすることで、上記のコマンドにアクセスすることもできます。 + +![[ブラウザーで開く] が強調されている、リモート エクスプローラーで選ばれた codespace のスクリーンショット](/assets/images/help/codespaces/open-codespace-remote-explorer.png) + +{% data reusables.codespaces.remote-explorer %} {% endvscode %} + +{% cli %} + +1. ターミナルで、次のいずれかの {% data variables.product.prodname_cli %} コマンドを入力します。 + - {% data variables.product.prodname_vscode_shortname %} で codespace を開くには、次のように入力します。 + + ```shell{:copy} + gh codespace code + ``` + + - ブラウザーで codespace を開くには、次のように入力します。 + + ```shell{:copy} + gh codespace code --web + ``` + +1. 方向キーを使って、開きたい codespace に移動します。 +1. codespace を開くには、Enter キーを押します。 + +詳しくは、{% data variables.product.prodname_cli %} のマニュアルで [`gh codespace code`](https://cli.github.com/manual/gh_codespace_code) をご覧ください。 + +{% endcli %} diff --git a/translations/ja-JP/content/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization.md b/translations/ja-JP/content/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization.md new file mode 100644 index 0000000000..34ece084e6 --- /dev/null +++ b/translations/ja-JP/content/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization.md @@ -0,0 +1,43 @@ +--- +title: Organization で個人用アクセス トークンの要求を管理する +intro: 'Organization の所有者は、Organization へのアクセスを要求する {% data variables.product.pat_v2 %} を承認または拒否できます。' +versions: + feature: pat-v2 +shortTitle: Manage token requests +ms.openlocfilehash: ea2f01436ca4649cae5310b14070625c5947922e +ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 +ms.translationtype: HT +ms.contentlocale: ja-JP +ms.lasthandoff: 10/25/2022 +ms.locfileid: '148107406' +--- +{% data reusables.user-settings.pat-v2-org-opt-in %} + +## {% data variables.product.pat_v2 %} の要求について + +Organization が所有するリソースにアクセスするために Organization のメンバーが {% data variables.product.pat_v2 %} を作成するとき、Organization による {% data variables.product.pat_v2 %} の承認が必要な場合は、Organization の所有者がトークンを承認してからでないと、パブリックではないリソースへのアクセスにそのトークンを使うことはできません。 詳しくは、「[Organization の {% data variables.product.pat_generic %} ポリシーを設定する](/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization)」をご覧ください。 + +{% data variables.product.company_short %} は、承認を待っているすべての {% data variables.product.pat_v2 %} について、Organization の所有者に毎日メールで通知します。 トークンが拒否または承認されると、トークンを作成したユーザーはメール通知を受け取ります。 + +{% note %} + +**注**: 承認の対象となるのは {% data variables.product.pat_v2 %} だけであり、{% data variables.product.pat_v1_plural %} はなりません。 Organization が {% data variables.product.pat_v1_plural %} によるアクセスを制限していない限り、{% data variables.product.pat_v1 %} は事前の承認なしに Organization のリソースにアクセスできます。 詳しくは、「[Organization の {% data variables.product.pat_generic %} ポリシーを設定する](/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization)」をご覧ください。 + +{% endnote %} + +## {% data variables.product.pat_v2 %} の要求を管理する + +{% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} +1. 左側のサイドバーの **[{% octicon "key" aria-label="The key icon" %} {% data variables.product.pat_generic_caps %}]** の下にある **[保留中の要求]** をクリックします。 Organization の承認を待っているトークンがある場合、それらが表示されます。 +1. 承認または拒否するトークンの名前をクリックします。 +1. トークンが要求しているアクセスとアクセス許可を確認します。 +1. トークンに Organization へのアクセスを許可するには、 **[承認]** をクリックします。 トークンに Organization へのアクセスを禁止するには、 **[拒否]** をクリックします。 +1. 要求を拒否した場合は、必要に応じて、確認ボックスにトークンを拒否した理由を入力します。 この理由は、トークンの所有者に送信される通知で共有されます。 その後、 **[拒否]** をクリックします。 + +または、複数のトークンを一度に承認または拒否することもできます。 + +{% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} +1. 左側のサイドバーの **[{% octicon "key" aria-label="The key icon" %} {% data variables.product.pat_generic_caps %}]** の下にある **[保留中の要求]** をクリックします。 Organization の承認を待っているトークンがある場合、それらが表示されます。 +1. 必要に応じて、 **[所有者]** と **[リポジトリ]** ドロップダウン メニューを使って、要求を行っているメンバーで要求をフィルター処理します。 +1. 承認または拒否する各トークンを選びます。 +1. **[選択した要求の処理]** ドロップダウン メニューを選んで、 **[承認]** または **[拒否]** をクリックします。 diff --git a/translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md b/translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md index b0a8576c06..e8b0412d5b 100644 --- a/translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md +++ b/translations/ja-JP/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md @@ -56,6 +56,12 @@ After you enable SAML SSO, there are multiple ways you can add new members to yo To provision new users without an invitation from an organization owner, you can use the URL `https://github.com/orgs/ORGANIZATION/sso/sign_up`, replacing _ORGANIZATION_ with the name of your organization. For example, you can configure your IdP so that anyone with access to the IdP can click a link on the IdP's dashboard to join your {% data variables.product.prodname_dotcom %} organization. +{% note %} + +**Note:** Provisioning new users via `https://github.com/orgs/ORGANIZATION/sso/sign_up` is only supported when SAML SSO is configured at the organization level, not when SAML SSO is configured at the enterprise account level. For more information about SAML SSO for enterprise accounts, see "[About SAML for enterprise IAM](/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam)." + +{% endnote %} + If your IdP supports SCIM, {% data variables.product.prodname_dotcom %} can automatically invite members to join your organization when you grant access on your IdP. If you remove a member's access to your {% data variables.product.prodname_dotcom %} organization on your SAML IdP, the member will be automatically removed from the {% data variables.product.prodname_dotcom %} organization. For more information, see "[About SCIM for organizations](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)." {% data reusables.organizations.team-synchronization %} diff --git a/translations/ja-JP/content/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts.md b/translations/ja-JP/content/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts.md new file mode 100644 index 0000000000..af91d3a860 --- /dev/null +++ b/translations/ja-JP/content/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts.md @@ -0,0 +1,43 @@ +--- +title: 会計ホストを使用して GitHub Sponsors の支払いを受け取る +intro: '{% data variables.product.prodname_sponsors %} に参加し、支払いを受け取るための会計ホストを選ぶことで、スポンサード開発者になることができます。' +versions: + fpt: '*' + ghec: '*' +type: how_to +topics: + - User account + - Sponsors profile +shortTitle: Using a fiscal host +ms.openlocfilehash: 8e26f07d8decf6819824bbcb7885d6e09ace5bdb +ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 +ms.translationtype: HT +ms.contentlocale: ja-JP +ms.lasthandoff: 10/25/2022 +ms.locfileid: '148108820' +--- +## 会計ホストを使用して {% data variables.product.prodname_sponsors %} の支払いを受け取る方法について + +{% data variables.product.prodname_sponsors %} プロファイルにサインアップして、資金提供を受けられるようにするときに、自分が管理する Stripe Connect アカウントまたは既に利用している会計ホストのどちらで支払いを受け取るかを選べます。 + +{% data reusables.sponsors.bank-info-fiscal-host-reminder %} + +{% data variables.product.prodname_sponsors %} では、次の会計ホストがサポートされています。 + +- [Open Source Collective](https://oscollective.org/) +- [NumFOCUS](http://www.numfocus.org/) +- [Open Collective Europe](https://opencollective.com/europe) +- [Software Underground](https://softwareunderground.org/) +- [Software Freedom Conservancy](https://sfconservancy.org/) + +## 会計ホストの使用を選択する + +資金提供を受けるアカウントの [順番待ちリストに登録する] プロファイル設定ページに移動すると、設定しているアカウントの種類に応じて、[支払いを受け取る方法] または [Organization の銀行口座] セクションが表示されます。 {% data variables.product.prodname_sponsors %} プロファイルにサインアップする方法について詳しくは、「[個人アカウント用に {% data variables.product.prodname_sponsors %} を設定する](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account)」または「[Organization 用に {% data variables.product.prodname_sponsors %} を設定する](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)」をご覧ください。 + +1. [支払いを受け取る方法] または [Organization の銀行口座] で、 **[会計ホストを使用する]** または **[この Organization は会計ホストを使用している]** オプションを選びます。 + + ![銀行口座と会計ホストのどちらかを選ぶオプションのスクリーンショット](/assets/images/help/sponsors/user-waitlist-payout-options.png) +2. **[会計ホストの選択]** ドロップダウンを使って、使用する会計ホストを選びます。 +3. [会計ホスト プロジェクト プロファイルの URL] の下のテキスト ボックスに、会計ホストのサイトでの自分のプロファイル ページへの URL を入力します。 これは、ユーザーが会計ホストに実際に登録されていることをこちらで確認するのに役立ちます。 + + ![会計ホストのプロジェクト プロファイルの URL のテキスト ボックスのスクリーンショット](/assets/images/help/sponsors/fiscal-host-project-profile-field.png) diff --git a/translations/ja-JP/data/reusables/audit_log/audit-log-action-categories.md b/translations/ja-JP/data/reusables/audit_log/audit-log-action-categories.md index f6f3bf77d0..a20fdee08a 100644 --- a/translations/ja-JP/data/reusables/audit_log/audit-log-action-categories.md +++ b/translations/ja-JP/data/reusables/audit_log/audit-log-action-categories.md @@ -33,7 +33,6 @@ {%- ifversion ghes %} | `config_entry` | Contains activities related to configuration settings. These events are only visible in the site admin audit log. {%- endif %} -| | `dependabot_alerts` | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in existing repositories. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." | `dependabot_alerts_new_repos` | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in new repositories created in the organization. | `dependabot_repository_access` | Contains activities related to which private repositories in an organization {% data variables.product.prodname_dependabot %} is allowed to access. diff --git a/translations/ja-JP/data/reusables/billing/license-statuses.md b/translations/ja-JP/data/reusables/billing/license-statuses.md index 99a69f8cc5..2572ebc62f 100644 --- a/translations/ja-JP/data/reusables/billing/license-statuses.md +++ b/translations/ja-JP/data/reusables/billing/license-statuses.md @@ -1,13 +1,6 @@ ---- -ms.openlocfilehash: 7604b9a565888d01aee7eac1643ddf4652a54ed9 -ms.sourcegitcommit: fb047f9450b41b24afc43d9512a5db2a2b750a2a -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/11/2022 -ms.locfileid: "145113613" ---- -{% ifversion ghec %}ライセンスに {% data variables.product.prodname_vss_ghe %} が含まれている場合は、追加のライセンスの詳細を含む CSV ファイルをダウンロードすることで、{% data variables.product.prodname_dotcom_the_website %} のユーザー アカウントが {% data variables.product.prodname_vs %} サブスクライバーと正常に一致したかどうかを特定できます。 ライセンス ステータスは、次のいずれかになります。 -- "一致": {% data variables.product.prodname_dotcom_the_website %} のユーザー アカウントは、{% data variables.product.prodname_vs %} サブスクライバーにリンクされています。 -- "保留中の招待": {% data variables.product.prodname_vs %} サブスクライバーに招待が送信されましたが、サブスクライバーは招待を受け入れていません。 -- 空白: {% data variables.product.prodname_dotcom_the_website %} のユーザー アカウントに対して考慮すべき {% data variables.product.prodname_vs %} の関連付けはありません。 +{% ifversion ghec %} +If your license includes {% data variables.visual_studio.prodname_vss_ghe %}, you can identify whether a user account on {% data variables.product.prodname_dotcom_the_website %} has successfully matched with a {% data variables.product.prodname_vs %} subscriber by downloading the CSV file that contains additional license details. The license status will be one of the following. +- "Matched": The user account on {% data variables.product.prodname_dotcom_the_website %} is linked with a {% data variables.product.prodname_vs %} subscriber. +- "Pending Invitation": An invitation was sent to a {% data variables.product.prodname_vs %} subscriber, but the subscriber has not accepted the invitation. +- Blank: There is no {% data variables.product.prodname_vs %} association to consider for the user account on {% data variables.product.prodname_dotcom_the_website %}. {% endif %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/vss-ghe-description.md b/translations/ja-JP/data/reusables/enterprise-accounts/vss-ghe-description.md index 886821cde4..9fba228686 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/vss-ghe-description.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/vss-ghe-description.md @@ -1,9 +1 @@ ---- -ms.openlocfilehash: e8fcb120bbfd58d97607b749e78e3ed6aa94c7fb -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/10/2022 -ms.locfileid: "145124005" ---- -{% data variables.product.prodname_vss_ghe %} は、サブスクライバーが {% data variables.product.prodname_vs %} と {% data variables.product.prodname_enterprise %} の両方を使用できるように組み合わせて販売されている Microsoft の製品です。 +{% data variables.visual_studio.prodname_vss_ghe %} is a combined offering from Microsoft that allows a subscriber to use both {% data variables.product.prodname_vs %} and {% data variables.product.prodname_enterprise %}. diff --git a/translations/ja-JP/data/reusables/saml/outside-collaborators-exemption.md b/translations/ja-JP/data/reusables/saml/outside-collaborators-exemption.md index a8f671713a..76409d988e 100644 --- a/translations/ja-JP/data/reusables/saml/outside-collaborators-exemption.md +++ b/translations/ja-JP/data/reusables/saml/outside-collaborators-exemption.md @@ -1,16 +1,13 @@ --- -ms.openlocfilehash: 4d4e5a2d205dd4774e4d40394e07f339536e1dcb -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 +ms.openlocfilehash: 2756814ec2c08dfce708645cec499588fbad330d +ms.sourcegitcommit: bf11c3e08cbb5eab6320e0de35b32ade6d863c03 ms.translationtype: HT ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: "147526818" +ms.lasthandoff: 10/27/2022 +ms.locfileid: "148111629" --- {% note %} -**注:** - -- 組織のメンバーは、SAML 認証がなくても、パブリック リソースの表示、複製、フォークなどの読み取り操作を実行できます。 -- SAML 認証は、外部コラボレーターにも必要ありません。 外部コラボレーターの詳細については、「[Organization のロール](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)」を参照してください。 +**注:** SAML 認証は、外部コラボレーターにも必要ありません。 外部コラボレーターの詳細については、「[Organization のロール](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)」を参照してください。 {% endnote %} diff --git a/translations/ja-JP/data/reusables/saml/resources-without-sso.md b/translations/ja-JP/data/reusables/saml/resources-without-sso.md new file mode 100644 index 0000000000..55561f50c9 --- /dev/null +++ b/translations/ja-JP/data/reusables/saml/resources-without-sso.md @@ -0,0 +1,15 @@ +--- +ms.openlocfilehash: 6801c86b93cfe8a48f1380bcb65e3fc8802e0eae +ms.sourcegitcommit: bf11c3e08cbb5eab6320e0de35b32ade6d863c03 +ms.translationtype: HT +ms.contentlocale: ja-JP +ms.lasthandoff: 10/27/2022 +ms.locfileid: "148111614" +--- +次のように特定の方法でパブリック リポジトリにアクセスする場合、IdP 認証は必要ありません。 + +- リポジトリの概要ページとファイルの内容を {% data variables.product.prodname_dotcom %} 上で表示する +- リポジトリをフォークする +- リポジトリのクローンなど、Git を使って読み取り操作を実行する + +issue、pull request、プロジェクト、リリースの閲覧など、パブリック リポジトリへのその他のアクセスには認証が必要です。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/saml/saml-accounts.md b/translations/ja-JP/data/reusables/saml/saml-accounts.md index 366783c3a0..b78d1d49ab 100644 --- a/translations/ja-JP/data/reusables/saml/saml-accounts.md +++ b/translations/ja-JP/data/reusables/saml/saml-accounts.md @@ -1,12 +1,12 @@ --- -ms.openlocfilehash: b5ea320db35c6a770853644bcdb50117d3da578d -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 +ms.openlocfilehash: 7f8e979109d851c152b9cb2b90569ea12155b2dd +ms.sourcegitcommit: bf11c3e08cbb5eab6320e0de35b32ade6d863c03 ms.translationtype: HT ms.contentlocale: ja-JP -ms.lasthandoff: 10/25/2022 -ms.locfileid: "148108790" +ms.lasthandoff: 10/27/2022 +ms.locfileid: "148111522" --- -SAML SSO を構成する場合、組織のメンバーは引き続き {% data variables.product.prodname_dotcom_the_website %} で個人アカウントにサインインします。 組織内の非パブリックのリソースにメンバーがアクセスすると、{% data variables.product.prodname_dotcom %} により、認証のためにメンバーが IdP にリダイレクトされます。 認証に成功すると、IdP はメンバーを {% data variables.product.prodname_dotcom %} にリダイレクトして戻します。 詳細については、「[SAML のシングル サインオンでの認証について](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on)」を参照してください。 +SAML SSO を構成する場合、組織のメンバーは引き続き {% data variables.product.prodname_dotcom_the_website %} で個人アカウントにサインインします。 組織内のほとんどのリソースは、メンバーがアクセスすると、{% data variables.product.prodname_dotcom %} によってメンバーは IdP にリダイレクトされ、認証を受けます。 認証に成功すると、IdP はメンバーを {% data variables.product.prodname_dotcom %} にリダイレクトして戻します。 詳細については、「[SAML のシングル サインオンでの認証について](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on)」を参照してください。 {% note %} diff --git a/translations/ja-JP/data/variables/product.yml b/translations/ja-JP/data/variables/product.yml index 09ba187929..eab46df50e 100644 --- a/translations/ja-JP/data/variables/product.yml +++ b/translations/ja-JP/data/variables/product.yml @@ -202,9 +202,6 @@ prodname_dependency_review_action: 'dependency review action' prodname_vs: 'Visual Studio' prodname_vscode_shortname: 'VS Code' prodname_vscode: 'Visual Studio Code' -prodname_vs_subscriber: '{% data variables.product.prodname_vs %} subscriber' -prodname_vss_ghe: 'Visual Studio subscriptions with GitHub Enterprise' -prodname_vss_admin_portal_with_url: 'the [administrator portal for Visual Studio subscriptions](https://visualstudio.microsoft.com/subscriptions-administration/)' prodname_vscode_command_palette_shortname: 'VS Code Command Palette' prodname_vscode_command_palette: 'Visual Studio Code Command Palette' prodname_vscode_marketplace: 'Visual Studio Code Marketplace' diff --git a/translations/log/msft-ja-resets.csv b/translations/log/msft-ja-resets.csv index 6a85d4e3bc..60735b95f4 100644 --- a/translations/log/msft-ja-resets.csv +++ b/translations/log/msft-ja-resets.csv @@ -479,9 +479,9 @@ translations/ja-JP/content/admin/identity-and-access-management/using-enterprise translations/ja-JP/content/admin/identity-and-access-management/using-ldap-for-enterprise-iam/index.md,broken liquid tags translations/ja-JP/content/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap.md,broken liquid tags translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam.md,broken liquid tags -translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md,broken liquid tags translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-okta.md,broken liquid tags translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md,broken liquid tags +translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise.md,rendering error translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/enabling-encrypted-assertions.md,broken liquid tags translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/index.md,broken liquid tags translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md,rendering error @@ -535,7 +535,6 @@ translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md,broken liquid tags translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/index.md,broken liquid tags translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md,broken liquid tags -translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md,broken liquid tags translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md,rendering error translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md,rendering error translations/ja-JP/content/authentication/connecting-to-github-with-ssh/about-ssh.md,broken liquid tags @@ -590,6 +589,7 @@ translations/ja-JP/content/billing/managing-licenses-for-visual-studio-subscript translations/ja-JP/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md,broken liquid tags translations/ja-JP/content/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise.md,broken liquid tags translations/ja-JP/content/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise.md,broken liquid tags +translations/ja-JP/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md,broken liquid tags translations/ja-JP/content/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server.md,broken liquid tags translations/ja-JP/content/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise.md,broken liquid tags translations/ja-JP/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md,rendering error @@ -1057,6 +1057,7 @@ translations/ja-JP/data/reusables/audit_log/audit-log-action-categories.md,rende translations/ja-JP/data/reusables/audit_log/audit-log-events-workflows.md,rendering error translations/ja-JP/data/reusables/audit_log/audit_log_sidebar_for_org_admins.md,rendering error translations/ja-JP/data/reusables/audit_log/audit_log_sidebar_for_site_admins.md,rendering error +translations/ja-JP/data/reusables/billing/license-statuses.md,broken liquid tags translations/ja-JP/data/reusables/branches/new-repo-default-branch.md,broken liquid tags translations/ja-JP/data/reusables/classroom/about-autograding.md,broken liquid tags translations/ja-JP/data/reusables/code-scanning/alerts-found-in-generated-code.md,broken liquid tags @@ -1110,6 +1111,7 @@ translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-repo.md,bro translations/ja-JP/data/reusables/enterprise-accounts/emu-short-summary.md,rendering error translations/ja-JP/data/reusables/enterprise-accounts/oidc-gei-warning.md,broken liquid tags translations/ja-JP/data/reusables/enterprise-accounts/security-tab.md,rendering error +translations/ja-JP/data/reusables/enterprise-accounts/vss-ghe-description.md,broken liquid tags translations/ja-JP/data/reusables/enterprise/apply-configuration.md,broken liquid tags translations/ja-JP/data/reusables/enterprise/rate_limit.md,broken liquid tags translations/ja-JP/data/reusables/enterprise/repository-caching-release-phase.md,rendering error diff --git a/translations/log/msft-pt-resets.csv b/translations/log/msft-pt-resets.csv index 368803d923..5a598f5150 100644 --- a/translations/log/msft-pt-resets.csv +++ b/translations/log/msft-pt-resets.csv @@ -579,6 +579,7 @@ translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscript translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md,broken liquid tags translations/pt-BR/content/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise.md,broken liquid tags translations/pt-BR/content/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise.md,broken liquid tags +translations/pt-BR/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md,broken liquid tags translations/pt-BR/content/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server.md,broken liquid tags translations/pt-BR/content/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise.md,broken liquid tags translations/pt-BR/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md,rendering error @@ -1055,6 +1056,7 @@ translations/pt-BR/data/reusables/audit_log/audit-log-action-categories.md,rende translations/pt-BR/data/reusables/audit_log/audit-log-events-workflows.md,rendering error translations/pt-BR/data/reusables/audit_log/audit_log_sidebar_for_org_admins.md,rendering error translations/pt-BR/data/reusables/audit_log/audit_log_sidebar_for_site_admins.md,rendering error +translations/pt-BR/data/reusables/billing/license-statuses.md,broken liquid tags translations/pt-BR/data/reusables/branches/new-repo-default-branch.md,broken liquid tags translations/pt-BR/data/reusables/classroom/about-autograding.md,broken liquid tags translations/pt-BR/data/reusables/code-scanning/alerts-found-in-generated-code.md,broken liquid tags @@ -1108,6 +1110,7 @@ translations/pt-BR/data/reusables/enterprise-accounts/emu-permission-repo.md,bro translations/pt-BR/data/reusables/enterprise-accounts/emu-short-summary.md,rendering error translations/pt-BR/data/reusables/enterprise-accounts/oidc-gei-warning.md,broken liquid tags translations/pt-BR/data/reusables/enterprise-accounts/security-tab.md,broken liquid tags +translations/pt-BR/data/reusables/enterprise-accounts/vss-ghe-description.md,broken liquid tags translations/pt-BR/data/reusables/enterprise/apply-configuration.md,broken liquid tags translations/pt-BR/data/reusables/enterprise/rate_limit.md,broken liquid tags translations/pt-BR/data/reusables/enterprise/repository-caching-release-phase.md,rendering error diff --git a/translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md b/translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md index b4203f0a1d..58c6be3da8 100644 --- a/translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md +++ b/translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md @@ -69,7 +69,7 @@ There are two types of snapshots: | Azure | VM | | Hyper-V | VM | | Google Compute Engine | Disk | -| VMware | VM | +| VMware | VM | ## Upgrading with a hotpatch diff --git a/translations/pt-BR/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md b/translations/pt-BR/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md index 138d9b40d8..6c71f4293a 100644 --- a/translations/pt-BR/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md +++ b/translations/pt-BR/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md @@ -85,6 +85,8 @@ When you configure SAML authentication, {% data variables.product.product_name % 1. Usernames created from email addresses are created from the normalized characters that precede the `@` character. +1. Usernames created from domain accounts are created from the normalized characters after the `\\` separator. + 1. If multiple accounts are normalized into the same {% data variables.product.product_name %} username, only the first user account is created. Subsequent users with the same username won't be able to sign in. {% ifversion ghec %}For more information, see "[Resolving username problems](#resolving-username-problems)."{% endif %} ### Examples of username normalization @@ -97,6 +99,7 @@ When you configure SAML authentication, {% data variables.product.product_name % | The!!Octocat | `the--octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created, because it contains two consecutive dashes. | | The!Octocat | `the-octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created. Although the normalized username is valid, it already exists. | | `The.Octocat@example.com` | `the-octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created. Although the normalized username is valid, it already exists. | +| `internal\\The.Octocat` | `the-octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created. Although the normalized username is valid, it already exists. | | `mona.lisa.the.octocat.from.github.united.states@example.com` | `mona-lisa-the-octocat-from-github-united-states{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created, because it exceeds the 39-character limit. | {% ifversion not ghec %} diff --git a/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md b/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md index 9fed0e1cbb..7d70d6d397 100644 --- a/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md +++ b/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md @@ -100,7 +100,7 @@ In the list of pending members, for any individual account, you can cancel all i {% endnote %} -If you use {% data variables.product.prodname_vss_ghe %}, the list of pending invitations includes all {% data variables.product.prodname_vs %} subscribers that haven't joined any of your organizations on {% data variables.product.prodname_dotcom %}, even if the subscriber does not have a pending invitation to join an organization. For more information about how to get {% data variables.product.prodname_vs %} subscribers access to {% data variables.product.prodname_enterprise %}, see "[Setting up {% data variables.product.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise)." +If you use {% data variables.visual_studio.prodname_vss_ghe %}, the list of pending invitations includes all {% data variables.product.prodname_vs %} subscribers that haven't joined any of your organizations on {% data variables.product.prodname_dotcom %}, even if the subscriber does not have a pending invitation to join an organization. For more information about how to get {% data variables.product.prodname_vs %} subscribers access to {% data variables.product.prodname_enterprise %}, see "[Setting up {% data variables.visual_studio.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise)." {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.people-tab %} diff --git a/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md b/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md index af80bbb3a1..59d219df32 100644 --- a/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md +++ b/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md @@ -19,17 +19,17 @@ topics: shortTitle: About --- -## About {% data variables.product.prodname_vss_ghe %} +## About {% data variables.visual_studio.prodname_vss_ghe %} -{% data reusables.enterprise-accounts.vss-ghe-description %} {% data variables.product.prodname_vss_ghe %} is available from Microsoft under the terms of the Microsoft Enterprise Agreement. For more information, see [{% data variables.product.prodname_vss_ghe %}](https://visualstudio.microsoft.com/subscriptions/visual-studio-github/) on the {% data variables.product.prodname_vs %} website. +{% data reusables.enterprise-accounts.vss-ghe-description %} {% data variables.visual_studio.prodname_vss_ghe %} is available from Microsoft under the terms of the Microsoft Enterprise Agreement. For more information, see [{% data variables.visual_studio.prodname_vss_ghe %}](https://visualstudio.microsoft.com/subscriptions/visual-studio-github/) on the {% data variables.product.prodname_vs %} website. To use the {% data variables.product.prodname_enterprise %} portion of the license, each subscriber's personal account on {% data variables.product.prodname_dotcom_the_website %} must be or become a member of an organization owned by your enterprise on {% data variables.product.prodname_dotcom_the_website %}. To accomplish this, organization owners can invite new members to an organization by email address. The subscriber can accept the invitation with an existing personal account on {% data variables.product.prodname_dotcom_the_website %} or create a new account. -For more information about the setup of {% data variables.product.prodname_vss_ghe %}, see "[Setting up {% data variables.product.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise)." +For more information about the setup of {% data variables.visual_studio.prodname_vss_ghe %}, see "[Setting up {% data variables.visual_studio.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise)." -## About licenses for {% data variables.product.prodname_vss_ghe %} +## About licenses for {% data variables.visual_studio.prodname_vss_ghe %} -After you assign a license for {% data variables.product.prodname_vss_ghe %} to a subscriber, the subscriber will use the {% data variables.product.prodname_enterprise %} portion of the license by joining an organization in your enterprise with a personal account on {% data variables.product.prodname_dotcom_the_website %}. If the verified email address for the personal account of an enterprise member on {% data variables.product.prodname_dotcom_the_website %} matches the User Primary Name (UPN) for a subscriber to your {% data variables.product.prodname_vs %} account, the {% data variables.product.prodname_vs %} subscriber will automatically consume one license for {% data variables.product.prodname_vss_ghe %}. +After you assign a license for {% data variables.visual_studio.prodname_vss_ghe %} to a subscriber, the subscriber will use the {% data variables.product.prodname_enterprise %} portion of the license by joining an organization in your enterprise with a personal account on {% data variables.product.prodname_dotcom_the_website %}. If the verified email address for the personal account of an enterprise member on {% data variables.product.prodname_dotcom_the_website %} matches the User Primary Name (UPN) for a subscriber to your {% data variables.product.prodname_vs %} account, the {% data variables.product.prodname_vs %} subscriber will automatically consume one license for {% data variables.visual_studio.prodname_vss_ghe %}. The total quantity of your licenses for your enterprise on {% data variables.product.prodname_dotcom %} is the sum of any standard {% data variables.product.prodname_enterprise %} licenses and the number of {% data variables.product.prodname_vs %} subscription licenses that include access to {% data variables.product.prodname_dotcom %}. If the personal account for an enterprise member does not correspond with the email address for a {% data variables.product.prodname_vs %} subscriber, the license that the personal account consumes is unavailable for a {% data variables.product.prodname_vs %} subscriber. @@ -43,7 +43,7 @@ You can view the number of {% data variables.product.prodname_enterprise %} lice {% endtip %} -You can also see pending {% data variables.product.prodname_enterprise %} invitations to subscribers in {% data variables.product.prodname_vss_admin_portal_with_url %}. +You can also see pending {% data variables.product.prodname_enterprise %} invitations to subscribers in {% data variables.visual_studio.prodname_vss_admin_portal_with_url %}. ## Further reading diff --git a/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md b/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md index 41af3a41ef..5426d14e28 100644 --- a/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md +++ b/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md @@ -10,18 +10,18 @@ topics: shortTitle: Set up --- -## About setup of {% data variables.product.prodname_vss_ghe %} +## About setup of {% data variables.visual_studio.prodname_vss_ghe %} -{% data reusables.enterprise-accounts.vss-ghe-description %} For more information, see "[About {% data variables.product.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise)." +{% data reusables.enterprise-accounts.vss-ghe-description %} For more information, see "[About {% data variables.visual_studio.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise)." This guide shows you how your team can get {% data variables.product.prodname_vs %} subscribers licensed and started with {% data variables.product.prodname_enterprise %}. If you prefer video, you can watch [Setting up your {% data variables.product.prodname_enterprise %} licenses with {% data variables.product.prodname_vs %} subscriptions](https://www.youtube.com/watch?v=P_zBgp_BE_I) on Microsoft Visual Studio's YouTube channel. -## Roles for {% data variables.product.prodname_vss_ghe %} +## Roles for {% data variables.visual_studio.prodname_vss_ghe %} -Before setting up {% data variables.product.prodname_vss_ghe %}, it's important to understand the roles for this combined offering. +Before setting up {% data variables.visual_studio.prodname_vss_ghe %}, it's important to understand the roles for this combined offering. | Role | Service | Description | More information | | :- | :- | :- | :- | @@ -38,15 +38,15 @@ Before setting up {% data variables.product.prodname_vss_ghe %}, it's important - Your team must have an enterprise on {% data variables.location.product_location %}. If you're not sure whether your team has an enterprise, contact your {% data variables.product.prodname_dotcom %} administrator. If you're not sure who on your team is responsible for {% data variables.product.prodname_dotcom %}, contact {% data variables.contact.contact_enterprise_sales %}. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." -## Setting up {% data variables.product.prodname_vss_ghe %} +## Setting up {% data variables.visual_studio.prodname_vss_ghe %} -To set up {% data variables.product.prodname_vss_ghe %}, members of your team must complete the following tasks. +To set up {% data variables.visual_studio.prodname_vss_ghe %}, members of your team must complete the following tasks. -One person may be able to complete the tasks because the person has all of the roles, but you may need to coordinate the tasks with multiple people. For more information, see "[Roles for {% data variables.product.prodname_vss_ghe %}](#roles-for-visual-studio-subscriptions-with-github-enterprise)." +One person may be able to complete the tasks because the person has all of the roles, but you may need to coordinate the tasks with multiple people. For more information, see "[Roles for {% data variables.visual_studio.prodname_vss_ghe %}](#roles-for-visual-studio-subscriptions-with-github-enterprise)." 1. An enterprise owner must create at least one organization in your enterprise on {% data variables.location.product_location %}. For more information, see "[Adding organizations to your enterprise](/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise)." -1. The subscription admin must assign a license for {% data variables.product.prodname_vs %} to a subscriber in {% data variables.product.prodname_vss_admin_portal_with_url %}. For more information, see [Overview of the {% data variables.product.prodname_vs %} Subscriptions Administrator Portal](https://docs.microsoft.com/en-us/visualstudio/subscriptions/using-admin-portal) and [Assign {% data variables.product.prodname_vs %} Licenses in the {% data variables.product.prodname_vs %} Subscriptions Administration Portal](https://docs.microsoft.com/en-us/visualstudio/subscriptions/assign-license) in Microsoft Docs. +1. The subscription admin must assign a license for {% data variables.product.prodname_vs %} to a subscriber in {% data variables.visual_studio.prodname_vss_admin_portal_with_url %}. For more information, see [Overview of the {% data variables.product.prodname_vs %} Subscriptions Administrator Portal](https://docs.microsoft.com/en-us/visualstudio/subscriptions/using-admin-portal) and [Assign {% data variables.product.prodname_vs %} Licenses in the {% data variables.product.prodname_vs %} Subscriptions Administration Portal](https://docs.microsoft.com/en-us/visualstudio/subscriptions/assign-license) in Microsoft Docs. 1. Optionally, if the subscription admin assigned licenses to subscribers in {% data variables.product.prodname_vs %} before adding {% data variables.product.prodname_enterprise %} to the subscription, the subscription admin can move the subscribers to the combined offering in the {% data variables.product.prodname_vs %} administration portal. For more information, see [Manage {% data variables.product.prodname_vs %} subscriptions with {% data variables.product.prodname_enterprise %}](https://docs.microsoft.com/en-us/visualstudio/subscriptions/assign-github#moving-to-visual-studio-with-github-enterprise) in Microsoft Docs. @@ -64,7 +64,7 @@ One person may be able to complete the tasks because the person has all of the r {% endtip %} -After {% data variables.product.prodname_vss_ghe %} is set up for subscribers on your team, enterprise owners can review licensing information on {% data variables.location.product_location %}. For more information, see "[Viewing the subscription and usage for your enterprise account](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)." +After {% data variables.visual_studio.prodname_vss_ghe %} is set up for subscribers on your team, enterprise owners can review licensing information on {% data variables.location.product_location %}. For more information, see "[Viewing the subscription and usage for your enterprise account](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)." ## Further reading diff --git a/translations/pt-BR/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md b/translations/pt-BR/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md index ca7c5a8934..7bc6979232 100644 --- a/translations/pt-BR/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md +++ b/translations/pt-BR/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md @@ -1,6 +1,6 @@ --- -title: Solução de problemas de uso de licenças para GitHub Enterprise -intro: Você pode solucionar problemas de uso de licença para sua empresa auditando os relatórios de licença. +title: Troubleshooting license usage for GitHub Enterprise +intro: You can troubleshoot license usage for your enterprise by auditing license reports. permissions: 'Enterprise owners can review license usage for {% data variables.product.prodname_enterprise %}.' versions: ghec: '*' @@ -10,30 +10,25 @@ topics: - Enterprise - Licensing shortTitle: Troubleshoot license usage -ms.openlocfilehash: f23ca2380e71f5b037278c71da57dc8fab94c750 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147572654' --- -## Sobre o uso inesperado de licenças -Se o número de licenças consumidas da sua empresa for inesperado, você poderá revisar seu relatório de licenças consumidas para auditar seu uso de licenças em todas as suas implantações e assinaturas corporativas. Para obter mais informações, confira "[Como exibir o uso da licença para o GitHub Enterprise](/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise)" e "[Como exibir a assinatura e o uso da sua conta corporativa](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)". +## About unexpected license usage -Se você encontrar erros, tente as etapas de solução de problemas. +If the number of consumed licenses for your enterprise is unexpected, you can review your consumed license report to audit your license usage across all your enterprise deployments and subscriptions. For more information, see "[Viewing license usage for GitHub Enterprise](/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise)" and "[Viewing the subscription and usage for your enterprise account](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)." -Por motivos de privacidade, os proprietários corporativos não podem acessar diretamente os detalhes das contas de usuário, a menos que você use {% data variables.product.prodname_emus %}. +If you find errors, you can try troubleshooting steps. -## Sobre o cálculo de licenças consumidas +For privacy reasons, enterprise owners cannot directly access the details of user accounts unless you use {% data variables.product.prodname_emus %}. -{% data variables.product.company_short %} fatura para cada pessoa que usa implementações do {% data variables.product.prodname_ghe_server %}, é membro de uma das suas organizações do {% data variables.product.prodname_ghe_cloud %} ou é um {% data variables.product.prodname_vs_subscriber %}. Para obter mais informações sobre as pessoas em sua empresa que consomem uma licença, confira "[Sobre preços por usuário](/billing/managing-billing-for-your-github-account/about-per-user-pricing)". +## About the calculation of consumed licenses -Para que cada usuário consuma apenas uma estação, independentemente de quantas implantações eles usam, você precisa sincronizar o uso de licenças entre {% data variables.product.prodname_ghe_server %} e {% data variables.product.prodname_ghe_cloud %}. Para obter mais informações, confira "[Sincronizando o uso de licenças entre o {% data variables.product.prodname_ghe_server %} e o {% data variables.product.prodname_ghe_cloud %}](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)". +{% data variables.product.company_short %} bills for each person who uses deployments of {% data variables.product.prodname_ghe_server %}, is a member of one of your organizations on {% data variables.product.prodname_ghe_cloud %}, or is a {% data variables.visual_studio.prodname_vs_subscriber %}. For more information about the people in your enterprise who consume a license, see "[About per-user pricing](/billing/managing-billing-for-your-github-account/about-per-user-pricing)." -Depois de sincronizar o uso das licenças, {% data variables.product.prodname_dotcom %} corresponde as contas de usuário em {% data variables.product.prodname_ghe_server %} às contas de usuário em {% data variables.product.prodname_ghe_cloud %} por endereço de email. +For each user to consume a single seat regardless of how many deployments they use, you must synchronize license usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Syncing license usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)." -Primeiro, verificamos o endereço de email primário de cada usuário em {% data variables.product.prodname_ghe_server %}. Em seguida, tentamos corresponder esse endereço com o endereço de email de uma conta de usuário em {% data variables.product.prodname_ghe_cloud %}. Se sua empresa usa o SSO do SAML, primeiro verificamos os atributos de SAML a seguir em busca de endereços de email. +After you synchronize license usage, {% data variables.product.prodname_dotcom %} matches user accounts on {% data variables.product.prodname_ghe_server %} with user accounts on {% data variables.product.prodname_ghe_cloud %} by email address. + +First, we first check the primary email address of each user on {% data variables.product.prodname_ghe_server %}. Then, we attempt to match that address with the email address for a user account on {% data variables.product.prodname_ghe_cloud %}. If your enterprise uses SAML SSO, we first check the following SAML attributes for email addresses. - `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name` - `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` @@ -41,64 +36,64 @@ Primeiro, verificamos o endereço de email primário de cada usuário em {% data - `NameID` - `emails` -Se nenhum endereço de email encontrado nesses atributos corresponder ao endereço de email primário em {% data variables.product.prodname_ghe_server %} ou se sua empresa não usar o SSO do SAML, verificaremos cada um dos endereços de email verificados do usuário em {% data variables.product.prodname_ghe_cloud %}. Para obter mais informações sobre a verificação de endereços de email do {% data variables.product.prodname_dotcom_the_website %}, confira "[Como verificar seu endereço de email](/enterprise-cloud@latest/get-started/signing-up-for-github/verifying-your-email-address){% ifversion not ghec %}" na documentação do {% data variables.product.prodname_ghe_cloud %}.{% else %}".{% endif %} +If no email addresses found in these attributes match the primary email address on {% data variables.product.prodname_ghe_server %}, or if your enterprise doesn't use SAML SSO, we then check each of the user's verified email addresses on {% data variables.product.prodname_ghe_cloud %}. For more information about verification of email addresses on {% data variables.product.prodname_dotcom_the_website %}, see "[Verifying your email address](/enterprise-cloud@latest/get-started/signing-up-for-github/verifying-your-email-address){% ifversion not ghec %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} -## Campos nos arquivos de licença consumidos +## Fields in the consumed license files -O relatório de uso da licença do {% data variables.product.prodname_dotcom_the_website %} e o arquivo de uso de licença exportado do {% data variables.product.prodname_ghe_server %} incluem uma variedade de campos para ajudar você a solucionar problemas de uso de licença para sua empresa. +The {% data variables.product.prodname_dotcom_the_website %} license usage report and {% data variables.product.prodname_ghe_server %} exported license usage file include a variety of fields to help you troubleshoot license usage for your enterprise. -### Relatório de uso de licença do {% data variables.product.prodname_dotcom_the_website %} (arquivo CSV) +### {% data variables.product.prodname_dotcom_the_website %} license usage report (CSV file) -O relatório de uso de licença para sua empresa é um arquivo CSV que contém as seguintes informações sobre os membros de sua empresa. Alguns campos são específicos para sua implantação do {% data variables.product.prodname_ghe_cloud %} (GHEC), ambientes conectados do {% data variables.product.prodname_ghe_server %} (GHES), ou suas assinaturas do {% data variables.product.prodname_vs %} (VSS) com o GitHub Enterprise. +The license usage report for your enterprise is a CSV file that contains the following information about members of your enterprise. Some fields are specific to your {% data variables.product.prodname_ghe_cloud %} (GHEC) deployment, {% data variables.product.prodname_ghe_server %} (GHES) connected environments, or your {% data variables.product.prodname_vs %} subscriptions (VSS) with GitHub Enterprise. -| Campo | DESCRIÇÃO +| Field | Description | ----- | ----------- -| github_com_login | O nome de usuário da conta do GHEC do usuário -| github_com_name | O nome de exibição da conta do GHEC do usuário -| github_com_profile | A URL da página de perfil do usuário no GHEC -| github_com_user | Se o usuário tem ou não uma conta no GHEC | -| github_com_member_roles | Para cada uma das organizações às quais o usuário pertence no GHEC, o nome da organização e a função da pessoa nessa organização (`Owner` ou `Member`) separados por dois pontos

    Organizações delimitadas por vírgulas | -| github_com_enterprise_role | Pode ser uma entre: `Owner`, `Member` ou `Outside collaborator` -| github_com_verified_domain_emails | Todos os endereços de email associados à conta GHEC do usuário que correspondem aos domínios verificados da sua empresa | -| github_com_saml_name_id | O nome de usuário do SAML | -| github_com_orgs_with_pending_invites | Todos os convites pendentes para a conta do GHEC do usuário ingressar em organizações em sua empresa | -| license_type | Pode ser `Visual Studio subscription` ou `Enterprise` -| enterprise_server_user| Se o usuário tem ou não pelo menos uma conta no GHES | -| enterprise_server_primary_emails | Os endereços de email primários associados a cada uma das contas do GHES do usuário | -| enterprise_server_user_ids | Para cada uma das contas do GHES do usuário, a ID de usuário da conta -| total_user_accounts | O número total de contas que a pessoa tem em GHEC e GHES -| visual_studio_subscription_user | Se o usuário é ou não um {% data variables.product.prodname_vs_subscriber %} | -| visual_studio_subscription_email | O endereço de email associado ao VSS do usuário | -| visual_studio_license_status | Se a licença do Visual Studio foi correspondida a um usuário do {% data variables.product.company_short %} | +| github_com_login | The username for the user's GHEC account +| github_com_name | The display name for the user's GHEC account +| github_com_profile | The URL for the user's profile page on GHEC +| github_com_user | Whether or not the user has an account on GHEC | +| github_com_member_roles | For each of the organizations the user belongs to on GHEC, the organization name and the user's role in that organization (`Owner` or `Member`) separated by a colon

    Organizations delimited by commas | +| github_com_enterprise_role | Can be one of: `Owner`, `Member`, or `Outside collaborator` +| github_com_verified_domain_emails | All email addresses associated with the user's GHEC account that match your enterprise's verified domains | +| github_com_saml_name_id | The SAML username | +| github_com_orgs_with_pending_invites | All pending invitations for the user's GHEC account to join organizations within your enterprise | +| license_type | Can be one of: `Visual Studio subscription` or `Enterprise` +| enterprise_server_user| Whether or not the user has at least one account on GHES | +| enterprise_server_primary_emails | The primary email addresses associated with each of the user's GHES accounts | +| enterprise_server_user_ids | For each of the user's GHES accounts, the account's user ID +| total_user_accounts | The total number of accounts the person has across both GHEC and GHES +| visual_studio_subscription_user | Whether or not the user is a {% data variables.visual_studio.prodname_vs_subscriber %} | +| visual_studio_subscription_email | The email address associated with the user's VSS | +| visual_studio_license_status | Whether the Visual Studio license has been matched to a {% data variables.product.company_short %} user | -{% data variables.product.prodname_vs_subscriber %}s que ainda não são membros de pelo menos uma organização em sua empresa serão incluídos no relatório com um status de convite pendente e não terão valores para o campo "Nome" ou "Link do perfil". +{% data variables.visual_studio.prodname_vs_subscriber %}s who are not yet members of at least one organization in your enterprise will be included in the report with a pending invitation status, and will be missing values for the "Name" or "Profile link" field. -### Uso de licença exportada do {% data variables.product.prodname_ghe_server %} (arquivo JSON) +### {% data variables.product.prodname_ghe_server %} exported license usage (JSON file) -Seu uso de licença do {% data variables.product.prodname_ghe_server %} é um arquivo JSON que normalmente é usado ao realizar uma sincronização manual de licenças de usuário entre as implantações do {% data variables.product.prodname_ghe_server %} e do {% data variables.product.prodname_ghe_cloud %}. O arquivo contém as seguintes informações específicas para seu ambiente do {% data variables.product.prodname_ghe_server %}. +Your {% data variables.product.prodname_ghe_server %} license usage is a JSON file that is typically used when performing a manual sync of user licenses between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} deployments. The file contains the following information specific to your {% data variables.product.prodname_ghe_server %} environment. -| Campo | Descrição +| Field | Description | ----- | ----------- -| Recursos | Os recursos do {% data variables.product.prodname_github_connect %} habilitados em sua instância do {% data variables.product.prodname_ghe_server %} e a data e hora da habilitação. -| Nome do host | O nome do host de sua instância do {% data variables.product.prodname_ghe_server %}. -| Somente HTTP | Se o Transport Layer Security (TLS) está ativado e configurado em sua instância do {% data variables.product.prodname_ghe_server %}. Pode ser: `True` ou `False`. -| Licença | Um hash de sua licença do {% data variables.product.prodname_ghe_server %}. -| Chave pública | A parte da chave pública da sua licença do {% data variables.product.prodname_ghe_server %}. -| ID de servidor | UUID gerado para sua instância do {% data variables.product.prodname_ghe_server %}. -| Versão | A versão da sua instância do {% data variables.product.prodname_ghe_server %}. +| Features | The {% data variables.product.prodname_github_connect %} features that are enabled on your {% data variables.product.prodname_ghe_server %} instance, and the date and time of enablement. +| Host name | The hostname of your {% data variables.product.prodname_ghe_server %} instance. +| HTTP only | Whether Transport Layer Security (TLS) is enabled and configured on your {% data variables.product.prodname_ghe_server %} instance. Can be one of: `True` or `False`. +| License | A hash of your {% data variables.product.prodname_ghe_server %} license. +| Public key | The public key portion of your {% data variables.product.prodname_ghe_server %} license. +| Server ID | UUID generated for your {% data variables.product.prodname_ghe_server %} instance. +| Version | The version of your {% data variables.product.prodname_ghe_server %} instance. -## Solução de problemas de licenças consumidas +## Troubleshooting consumed licenses -Para garantir que cada usuário esteja consumindo apenas uma estação para diferentes implantações e assinaturas, tente as etapas de solução de problemas a seguir. +To ensure that the each user is only consuming a single seat for different deployments and subscriptions, try the following troubleshooting steps. -1. Para ajudar a identificar usuários que estão consumindo várias estações, se sua empresa usar domínios verificados para {% data variables.product.prodname_ghe_cloud %}, examine a lista de membros corporativos que não têm um endereço de email de um domínio verificado associado à conta deles em {% data variables.product.prodname_dotcom_the_website %}. Muitas vezes, esses são os usuários que consomem erroneamente mais de uma estação licenciada. Para obter mais informações, confira "[Como exibir os membros que não têm um endereço de email de um domínio verificado](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#viewing-members-without-an-email-address-from-a-verified-domain)". +1. To help identify users that are consuming multiple seats, if your enterprise uses verified domains for {% data variables.product.prodname_ghe_cloud %}, review the list of enterprise members who do not have an email address from a verified domain associated with their account on {% data variables.product.prodname_dotcom_the_website %}. Often, these are the users who erroneously consume more than one licensed seat. For more information, see "[Viewing members without an email address from a verified domain](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#viewing-members-without-an-email-address-from-a-verified-domain)." {% note %} - **Observação:** para facilitar a solução de problemas, recomendamos o uso de domínios verificados com sua conta corporativa no {% data variables.product.prodname_dotcom_the_website %}. Para obter mais informações, confira "[Como verificar ou aprovar um domínio para sua empresa](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)". + **Note:** To make troubleshooting easier, we recommend using verified domains with your enterprise account on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Verifying or approving a domain for your enterprise](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)." {% endnote %} -1. Depois de identificar usuários que estão consumindo várias estações, verifique se o mesmo endereço de email está associado a todas as contas do usuário. Para obter mais informações sobre quais endereços de email precisam corresponder, confira "[Sobre o cálculo de licenças consumidas](#about-the-calculation-of-consumed-licenses)". -1. Se um endereço de email foi atualizado ou verificado recentemente para corrigir uma incompatibilidade, exiba o carimbo de data/hora do último trabalho de sincronização de licenças. Se um trabalho não tiver sido executado desde que a correção foi feita, dispare manualmente um novo trabalho. Para obter mais informações, confira "[Como sincronizar o uso da licença entre o GitHub Enterprise Server e o GitHub Enterprise Cloud](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)." +1. After you identify users who are consuming multiple seats, make sure that the same email address is associated with all of the user's accounts. For more information about which email addresses must match, see "[About the calculation of consumed licenses](#about-the-calculation-of-consumed-licenses)." +1. If an email address was recently updated or verified to correct a mismatch, view the timestamp of the last license sync job. If a job hasn't run since the correction was made, manually trigger a new job. For more information, see "[Syncing license usage between GitHub Enterprise Server and GitHub Enterprise Cloud](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)." -Se você ainda tiver dúvidas sobre suas licenças consumidas após analisar as informações de solução de problemas acima, entre em contato com {% data variables.contact.github_support %} por meio do {% data variables.contact.contact_enterprise_portal %}. +If you still have questions about your consumed licenses after reviewing the troubleshooting information above, you can contact {% data variables.contact.github_support %} through the {% data variables.contact.contact_enterprise_portal %}. diff --git a/translations/pt-BR/content/code-security/secret-scanning/about-secret-scanning.md b/translations/pt-BR/content/code-security/secret-scanning/about-secret-scanning.md index f1c959c882..4db1d014b7 100644 --- a/translations/pt-BR/content/code-security/secret-scanning/about-secret-scanning.md +++ b/translations/pt-BR/content/code-security/secret-scanning/about-secret-scanning.md @@ -84,9 +84,9 @@ When you enable {% data variables.product.prodname_secret_scanning %} for a repo If {% data variables.product.prodname_secret_scanning %} detects a secret, {% data variables.product.prodname_dotcom %} generates an alert. -- {% data variables.product.prodname_dotcom %} sends an email alert to the repository administrators and organization owners. +- {% data variables.product.prodname_dotcom %} sends an email alert to the repository administrators and organization owners. You'll receive an alert if you are watching the repository, or if you have enabled notifications for security alerts, or for all the activity on the repository. {% ifversion ghes or ghae or ghec %} -- {% data variables.product.prodname_dotcom %} sends an email alert to the contributor who committed the secret to the repository, with a link to the related {% data variables.product.prodname_secret_scanning %} alert. The commit author can then view the alert in the repository, and resolve the alert. +- If the contributor who committed the secret isn't ignoring the repository, {% data variables.product.prodname_dotcom %} will also send an email alert to the contributor. The emails contains a link to the related {% data variables.product.prodname_secret_scanning %} alert. The commit author can then view the alert in the repository, and resolve the alert. {% endif %} - {% data variables.product.prodname_dotcom %} displays an alert in the "Security" tab of the repository. diff --git a/translations/pt-BR/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md b/translations/pt-BR/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md index 72be0fcd50..e9bad376b3 100644 --- a/translations/pt-BR/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md +++ b/translations/pt-BR/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md @@ -1,6 +1,7 @@ --- title: Managing alerts from secret scanning intro: You can view and close alerts for secrets checked in to your repository. +permissions: 'People with admin access to a repository can view and dismiss alerts.' product: '{% data reusables.gated-features.secret-scanning %}' redirect_from: - /github/administering-a-repository/managing-alerts-from-secret-scanning diff --git a/translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md b/translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md index b0a8576c06..e8b0412d5b 100644 --- a/translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md +++ b/translations/pt-BR/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md @@ -56,6 +56,12 @@ After you enable SAML SSO, there are multiple ways you can add new members to yo To provision new users without an invitation from an organization owner, you can use the URL `https://github.com/orgs/ORGANIZATION/sso/sign_up`, replacing _ORGANIZATION_ with the name of your organization. For example, you can configure your IdP so that anyone with access to the IdP can click a link on the IdP's dashboard to join your {% data variables.product.prodname_dotcom %} organization. +{% note %} + +**Note:** Provisioning new users via `https://github.com/orgs/ORGANIZATION/sso/sign_up` is only supported when SAML SSO is configured at the organization level, not when SAML SSO is configured at the enterprise account level. For more information about SAML SSO for enterprise accounts, see "[About SAML for enterprise IAM](/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam)." + +{% endnote %} + If your IdP supports SCIM, {% data variables.product.prodname_dotcom %} can automatically invite members to join your organization when you grant access on your IdP. If you remove a member's access to your {% data variables.product.prodname_dotcom %} organization on your SAML IdP, the member will be automatically removed from the {% data variables.product.prodname_dotcom %} organization. For more information, see "[About SCIM for organizations](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)." {% data reusables.organizations.team-synchronization %} diff --git a/translations/pt-BR/content/repositories/creating-and-managing-repositories/renaming-a-repository.md b/translations/pt-BR/content/repositories/creating-and-managing-repositories/renaming-a-repository.md index 37f56abd8e..a1b945610f 100644 --- a/translations/pt-BR/content/repositories/creating-and-managing-repositories/renaming-a-repository.md +++ b/translations/pt-BR/content/repositories/creating-and-managing-repositories/renaming-a-repository.md @@ -12,12 +12,12 @@ versions: ghec: '*' topics: - Repositories -ms.openlocfilehash: e56e8ca634ca1bfec3c587fe8fb606ab73ac72d4 -ms.sourcegitcommit: 5f9527483381cfb1e41f2322f67c80554750a47d +ms.openlocfilehash: d0067d96dce2f2cf9fe8bb2dd519668780d861ff +ms.sourcegitcommit: bd8b3e152f17d90acf222a0d50ba9595184c1f5f ms.translationtype: HT ms.contentlocale: pt-BR -ms.lasthandoff: 09/11/2022 -ms.locfileid: '145127080' +ms.lasthandoff: 10/27/2022 +ms.locfileid: '148111670' --- Quando você renomear um repositório, todas as informações existentes, com exceção das URLs do site do projeto, serão automaticamente redirecionadas para o novo nome, incluindo: @@ -31,7 +31,7 @@ Para obter mais informações sobre sites de projeto, confira "[Sobre o {% data Além de redirecionar o tráfego da Web, todas as operações `git clone`, `git fetch` ou `git push` direcionadas ao local anterior continuarão funcionando como se fossem feitas no novo local. No entanto, para reduzir a confusão, recomendamos que a atualização de quaisquer clones locais existentes apontem para a nova URL do repositório. Faça isso usando `git remote` na linha de comando: ```shell -$ git remote set-url origin new_url +$ git remote set-url origin NEW_URL ``` Para obter mais informações, confira "[Como gerenciar repositórios remotos](/github/getting-started-with-github/managing-remote-repositories)". @@ -50,7 +50,7 @@ Se você planeja renomear um repositório que tenha um site do {% data variables {% warning %} -**Aviso**: se você criar um repositório na sua conta no futuro, não reutilize o nome original do repositório renomeado. Se o fizer, o redirecionamento para o repositório renomeado quebrará. +**Aviso**: se você criar um repositório na sua conta no futuro, não reutilize o nome original do repositório renomeado. Se você reutilizar, redirecionamentos para o repositório renomeado não funcionarão mais. {% endwarning %} diff --git a/translations/pt-BR/data/reusables/audit_log/audit-log-action-categories.md b/translations/pt-BR/data/reusables/audit_log/audit-log-action-categories.md index f6f3bf77d0..a20fdee08a 100644 --- a/translations/pt-BR/data/reusables/audit_log/audit-log-action-categories.md +++ b/translations/pt-BR/data/reusables/audit_log/audit-log-action-categories.md @@ -33,7 +33,6 @@ {%- ifversion ghes %} | `config_entry` | Contains activities related to configuration settings. These events are only visible in the site admin audit log. {%- endif %} -| | `dependabot_alerts` | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in existing repositories. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." | `dependabot_alerts_new_repos` | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in new repositories created in the organization. | `dependabot_repository_access` | Contains activities related to which private repositories in an organization {% data variables.product.prodname_dependabot %} is allowed to access. diff --git a/translations/pt-BR/data/reusables/billing/license-statuses.md b/translations/pt-BR/data/reusables/billing/license-statuses.md index f5755f211a..2572ebc62f 100644 --- a/translations/pt-BR/data/reusables/billing/license-statuses.md +++ b/translations/pt-BR/data/reusables/billing/license-statuses.md @@ -1,13 +1,6 @@ ---- -ms.openlocfilehash: 7604b9a565888d01aee7eac1643ddf4652a54ed9 -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/10/2022 -ms.locfileid: "145094201" ---- -{% ifversion ghec %} Se sua licença inclui o {% data variables.product.prodname_vss_ghe %}, você poderá identificar se uma conta do usuário no {% data variables.product.prodname_dotcom_the_website %} correspondeu com êxito a um assinante do {% data variables.product.prodname_vs %} baixando o arquivo CSV que contém detalhes adicionais da licença. O status da licença será um dos status a seguir. -- "Correspondente": a conta de usuário no {% data variables.product.prodname_dotcom_the_website %} está vinculada a um assinante do {% data variables.product.prodname_vs %}. -- "Convite Pendente": um convite foi enviado para um assinante do {% data variables.product.prodname_vs %}, mas o assinante não aceitou o convite. -- Em branco: não há nenhuma associação do {% data variables.product.prodname_vs %} a considerar para a conta de usuário no {% data variables.product.prodname_dotcom_the_website %}. +{% ifversion ghec %} +If your license includes {% data variables.visual_studio.prodname_vss_ghe %}, you can identify whether a user account on {% data variables.product.prodname_dotcom_the_website %} has successfully matched with a {% data variables.product.prodname_vs %} subscriber by downloading the CSV file that contains additional license details. The license status will be one of the following. +- "Matched": The user account on {% data variables.product.prodname_dotcom_the_website %} is linked with a {% data variables.product.prodname_vs %} subscriber. +- "Pending Invitation": An invitation was sent to a {% data variables.product.prodname_vs %} subscriber, but the subscriber has not accepted the invitation. +- Blank: There is no {% data variables.product.prodname_vs %} association to consider for the user account on {% data variables.product.prodname_dotcom_the_website %}. {% endif %} diff --git a/translations/pt-BR/data/reusables/enterprise-accounts/vss-ghe-description.md b/translations/pt-BR/data/reusables/enterprise-accounts/vss-ghe-description.md index 3ad8415ad3..9fba228686 100644 --- a/translations/pt-BR/data/reusables/enterprise-accounts/vss-ghe-description.md +++ b/translations/pt-BR/data/reusables/enterprise-accounts/vss-ghe-description.md @@ -1,9 +1 @@ ---- -ms.openlocfilehash: e8fcb120bbfd58d97607b749e78e3ed6aa94c7fb -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/10/2022 -ms.locfileid: "145096799" ---- -O {% data variables.product.prodname_vss_ghe %} é uma oferta combinada da Microsoft que permite que um assinante use o {% data variables.product.prodname_vs %} e o {% data variables.product.prodname_enterprise %}. +{% data variables.visual_studio.prodname_vss_ghe %} is a combined offering from Microsoft that allows a subscriber to use both {% data variables.product.prodname_vs %} and {% data variables.product.prodname_enterprise %}. diff --git a/translations/pt-BR/data/variables/product.yml b/translations/pt-BR/data/variables/product.yml index 09ba187929..eab46df50e 100644 --- a/translations/pt-BR/data/variables/product.yml +++ b/translations/pt-BR/data/variables/product.yml @@ -202,9 +202,6 @@ prodname_dependency_review_action: 'dependency review action' prodname_vs: 'Visual Studio' prodname_vscode_shortname: 'VS Code' prodname_vscode: 'Visual Studio Code' -prodname_vs_subscriber: '{% data variables.product.prodname_vs %} subscriber' -prodname_vss_ghe: 'Visual Studio subscriptions with GitHub Enterprise' -prodname_vss_admin_portal_with_url: 'the [administrator portal for Visual Studio subscriptions](https://visualstudio.microsoft.com/subscriptions-administration/)' prodname_vscode_command_palette_shortname: 'VS Code Command Palette' prodname_vscode_command_palette: 'Visual Studio Code Command Palette' prodname_vscode_marketplace: 'Visual Studio Code Marketplace'