jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-09 15:02:41 -05:00
Code Issues Projects Releases Wiki Activity

Merge branch 'github:main' into patch-2

Browse Source
This commit is contained in:
CyberFlame
2021-08-19 10:41:10 +12:00
committed by GitHub
parent 72ebe773e3 d09de3ca69
commit a53c59cebb
156 changed files with 22726 additions and 6916 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.eslintignore
View File

@@ -1 +1 @@
dist/
storybook/

16
.github/ISSUE_TEMPLATE/improve-existing-docs.yaml vendored
View File

@@ -1,24 +1,24 @@
name: Improve existing content
description: Make a suggestion to improve the content in an existing article
name: Improve existing content.
description: Make a suggestion to improve the content in an existing article.
labels:
- content
body:
- type: markdown
attributes:
value: |
**HUBBERS:** This is the github/docs open source repo. You may want to open an issue in the internal-only github/docs-content repo instead.
**HUBBERS!!** This is the github/docs open source repo. You may want to open an issue in the internal-only github/docs-content repo instead.
* For questions, ask in [Discussions](https://github.com/github/docs/discussions)
* Before you file an issue read the [Contributing guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md)
* Check to make sure someone hasn't already opened a similar [issue](https://github.com/github/docs/issues)
* For questions, ask in [Discussions](https://github.com/github/docs/discussions).
* Before you file an issue read the [Contributing guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md).
* Check to make sure someone hasn't already opened a similar [issue](https://github.com/github/docs/issues).
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: This project has a [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md) that all participants are expected to understand and follow.
description: This project has a Code of Conduct that all participants are expected to understand and follow.
options:
- label: I have read and agree to the GitHub Docs project's Code of Conduct.
- label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)
required: true
- type: textarea

19
.github/ISSUE_TEMPLATE/improve-the-site.yml vendored
View File

@@ -6,25 +6,25 @@ body:
- type: markdown
attributes:
value: |
**HUBBERS!! THIS IS GITHUB/DOCS OPEN SOURCE REPO. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD.**
**HUBBERS!!** This is the github/docs open source repo. You may want to open an issue in the internal-only github/docs-content repo instead.
* For questions, ask in [Discussions](https://github.com/github/docs/discussions)
* Before you file an issue read the [Contributing guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md)
* Check to make sure someone hasn't already opened a similar [issue](https://github.com/github/docs/issues)
* For questions, ask in [Discussions](https://github.com/github/docs/discussions).
* Before you file an issue read the [Contributing guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md).
* Check to make sure someone hasn't already opened a similar [issue](https://github.com/github/docs/issues).
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
description: This project has a Code of Conduct that all participants are expected to understand and follow.
options:
- label: I agree to follow this project's Code of Conduct
- label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)
required: true
- type: textarea
attributes:
label: What article on docs.github.com is affected?
description: |
Include links to articles where you're seeing a problem, screenshots, what browser you're using, etc.
description: Include links to articles where you're seeing a problem, screenshots, what browser you're using, etc.
validations:
required: true
@@ -41,7 +41,6 @@ body:
- type: textarea
attributes:
label: Additional information
description: |
Any additional information, configuration, or data that might be necessary to reproduce the issue.
description: Any additional information, configuration, or data that might be necessary to reproduce the issue.
validations:
required: false

48
.github/ISSUE_TEMPLATE/partner-contributed-documentation.md vendored
View File

@@ -1,48 +0,0 @@
---
name: Partner-owned product documentation
about: Initiate a set of tasks to be completed by a GitHub partner wishing to document how their product works with GitHub
title: ''
labels:
- partner
assignees: ''
---
<!--
Thank you for your interest in contributing to the GitHub documentation.
This issue template is only for use by GitHub's Technology Partners who wish to contribute documentation explaining how the partner's product works with GitHub, making it straightforward for our shared customers to adopt the product into their workflow.
As a general guide, we estimate we have bandwidth for prioritizing and reviewing up to 3 partner contributions per quarter.
Please be sure to complete all items in the checklists that follow, and feel free to comment with any questions. A member of the team will be glad to support you.
-->
## Pre-requisites
- [ ] Prior to submitting documentation, please apply to join the GitHub Technology Partner Program: [partner.github.com/apply](https://partner.github.com/apply?partnershipType=Technology+Partner). Please feel free to proceed once your application is approved.
## What information would you like to add to docs.github.com?
<!-- Please explain what your proposed article is about, what customers it benefits, and any other information that would help us to prioritize this request -->
## Tasks
Please be sure to complete each of the following:
**Third-party product documentation:**
- [ ] MUST follow our [general contributing guidelines](CONTRIBUTING.md) for voice and markup format.
- [ ] MUST emphasize how the third-party product works with GitHub.
- [ ] MUST be written in Markdown format, using [one of the templates provided](contributing/github-partners/README.md#templates)
- [ ] MUST include the name and URL of the GitHub technology partner responsible for maintenance of the documentation being contributed. This should be added via the `contributor.name` and `contributor.URL` properties in the template's YAML frontmatter.
- [ ] MUST be proposed via a pull request to this repo following [the GitHub Flow](https://guides.github.com/introduction/flow/).
- [ ] MUST be located in the root of [the `content` folder](content). Your filename MUST match the GitHub technology partner name, and use the `.md` file extension.
**The `Pull Request`:**
- [ ] MUST reference this issue, e.g. via `closes #<this issue number>`
- [ ] MUST pass the automated CI checks
- [ ] MUST include links to supporting material demonstrating the functionality being documented (this can be a link to a public GitHub repo, _or_ a video / screencast walkthrough)
Once all tasks are completed, please mention `@github/docs-content` for next steps.
/cc @github/partner-engineering for :eyes:

67
.github/ISSUE_TEMPLATE/partner-contributed-documentation.yml vendored Normal file
View File

@@ -0,0 +1,67 @@
name: Partner-owned product documentation.
description: Initiate a set of tasks to be completed by a GitHub partner wishing to document how their product works with GitHub.
labels:
- partner
body:
- type: markdown
attributes:
value: |
Thank you for your interest in contributing to the GitHub documentation.
This issue template is only for use by GitHub's Technology Partners who wish to contribute documentation explaining how the partner's product works with GitHub, making it straightforward for our shared customers to adopt the product into their workflow.
As a general guide, we estimate we have bandwidth for prioritizing and reviewing up to 3 partner contributions per quarter.
Please be sure to complete all items in the checklists that follow, and feel free to comment with any questions. A member of the team will be glad to support you.
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: This project has a Code of Conduct that all participants are expected to understand and follow.
options:
- label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)
required: true
- type: checkboxes
attributes:
label: Pre-requisites
description: Prior to submitting documentation, please apply to join the GitHub Technology Partner Program [partner.github.com/apply](https://partner.github.com/apply?partnershipType=Technology+Partner). Please feel free to proceed once your application is approved.
options:
- label: My application to the GitHub Technology Partner Program is approved.
required: true
- type: checkboxes
attributes:
label: Tasks
description: Please be sure to complete each of the following.
options:
- label: MUST follow our [general contributing guidelines](CONTRIBUTING.md) for voice and markup format.
required: true
- label: MUST emphasize how the third-party product works with GitHub.
required: true
- label: MUST be written in Markdown format, using [one of the templates provided](contributing/github-partners/README.md#templates).
required: true
- label: MUST include the name and URL of the GitHub technology partner responsible for maintenance of the documentation being contributed. This should be added via the `contributor.name` and `contributor.URL` properties in the template's YAML frontmatter.
required: true
- label: MUST be proposed via a pull request to this repo following [the GitHub Flow](https://guides.github.com/introduction/flow/).
required: true
- label: MUST be located in the root of [the `content` folder](content). Your filename MUST match the GitHub technology partner name, and use the `.md` file extension.
required: true
- type: checkboxes
attributes:
label: Pull Request
description: Please be sure to complete each of the following.
options:
- label: MUST reference this issue, e.g. via `closes [this issue number]`.
required: true
- label: MUST pass the automated CI checks.
required: true
- label: MUST include links to supporting material demonstrating the functionality being documented (this can be a link to a public GitHub repo, _or_ a video / screencast walkthrough).
required: true
- type: markdown
attributes:
value: |
Once all tasks are completed, please mention `@github/docs-content` for next steps.
/cc @github/partner-engineering for :eyes:.

1
.gitignore vendored
View File

@@ -10,6 +10,7 @@ coverage/
/data/early-access
.next
.eslintcache
/storybook/
# blc: broken link checker
blc_output.log

9
.storybook/main.js Normal file
View File

@@ -0,0 +1,9 @@
const path = require('path')
module.exports = {
stories: [
'../components/stories/**/*.stories.mdx',
'../components/stories/**/*.stories.@(js|jsx|ts|tsx)',
],
addons: ['@storybook/addon-links', '@storybook/addon-essentials', '@storybook/preset-scss'],
}

11
.storybook/preview.js Normal file
View File

@@ -0,0 +1,11 @@
import '../stylesheets/index.scss'
export const parameters = {
actions: { argTypesRegex: '^on[A-Z].*' },
controls: {
matchers: {
color: /(background|color)$/i,
date: /Date$/,
},
},
}

1
Dockerfile
View File

@@ -48,6 +48,7 @@ COPY content/index.md ./content/index.md
COPY next.config.js ./next.config.js
COPY tsconfig.json ./tsconfig.json
COPY next-env.d.ts ./next-env.d.ts
COPY .storybook ./.storybook
RUN npx tsc --noEmit

5
components/landing/ArticleList.tsx
View File

@@ -45,10 +45,7 @@ export const ArticleList = ({
{articles.map((link) => {
return (
<li key={link.href} className={cx(variant === 'compact' && 'border-top')}>
<Link
href={link.href}
className="link-with-intro Bump-link--hover no-underline d-block py-3"
>
<Link href={link.href} className="Bump-link--hover no-underline d-block py-3">
<h4 className="link-with-intro-title">
<span dangerouslySetInnerHTML={{ __html: link.title }} />
<span className="Bump-link-symbol">→</span>

4
components/page-footer/Survey.tsx
View File

@@ -97,10 +97,6 @@ export const Survey = () => {
{[ViewState.YES, ViewState.NO].includes(state) && (
<>
<p className="color-text-secondary f6">
{state === ViewState.YES && t`yes_feedback`}
{state === ViewState.NO && t`no_feedback`}
</p>
<p className="mb-3">
<label className="d-block mb-1 f6" htmlFor="survey-comment">
<span>

28
components/release-notes/PatchNotes.tsx
View File

@@ -1,3 +1,4 @@
import { Fragment } from 'react'
import cx from 'classnames'
import slugger from 'github-slugger'
import { ReleaseNotePatch } from './types'
@@ -62,29 +63,26 @@ export function PatchNotes({ patch, withReleaseNoteLabel }: Props) {
const slug = item.heading ? slugger.slug(item.heading) : ''
return (
<li key={slug} className="list-style-none">
<Fragment key={slug}>
<h4
id={slug}
className={cx(styles.sectionHeading, 'text-uppercase text-bold f4')}
style={{ color: !withReleaseNoteLabel ? primaryColor : '' }}
style={{ color: primaryColor }}
>
<Link href={`#${slug}`} className="text-inherit">
{item.heading}
</Link>
</h4>
<ul className="pl-0 pb-4 mt-2">
{item.notes.map((note) => {
return (
<li
key={note}
className="list-style-none f4"
dangerouslySetInnerHTML={{ __html: note }}
/>
)
})}
</ul>
</li>
{item.notes.map((note) => {
return (
<li
key={note}
className={cx(!withReleaseNoteLabel && 'list-style-none', 'f4')}
dangerouslySetInnerHTML={{ __html: note }}
/>
)
})}
</Fragment>
)
})}
</ul>

4
components/sidebar/SidebarProduct.tsx
View File

@@ -54,8 +54,8 @@ export const SidebarProduct = () => {
const isStandaloneCategory = childPage.page.documentType === 'article'
const childTitle = childPage.renderedShortTitle || childPage.renderedFullTitle
const isActive = routePath.includes(childPage.href) || routePath === childPage.href
const isActive =
routePath.includes(childPage.href + '/') || routePath === childPage.href
const defaultOpen = hasExactCategory ? isActive : false
return (
<li

30
components/stories/Callout.stories.tsx Normal file
View File

@@ -0,0 +1,30 @@
import React from 'react'
import { ComponentStory, ComponentMeta } from '@storybook/react'
// @ts-ignore
import { Callout } from '../ui/Callout.tsx'
export default {
title: 'UI/Callout',
component: Callout,
} as ComponentMeta<typeof Callout>
const Template: ComponentStory<typeof Callout> = (args) => <Callout {...args} />
export const Success = Template.bind({})
Success.args = {
variant: 'success',
children: <p>Hello!</p>,
}
export const Info = Template.bind({})
Info.args = {
variant: 'info',
children: <p>Hello!</p>,
}
export const Warning = Template.bind({})
Warning.args = {
variant: 'warning',
children: <p>Hello!</p>,
}

12
components/stories/Introduction.stories.mdx Normal file
View File

@@ -0,0 +1,12 @@
import { Meta } from '@storybook/addon-docs';
<Meta title="Example/Introduction" />
# Welcome to Storybook
Storybook helps you build UI components in isolation from your app's business logic, data, and context.
That makes it easy to develop hard-to-reach states. Save these UI states as **stories** to revisit during development, testing, or QA.
Browse example stories now by navigating to them in the sidebar.
View their code in the `src/stories` directory to learn how they work.
We recommend building UIs with a [**component-driven**](https://componentdriven.org) process starting with atomic components and ending with pages.

2
content/actions/creating-actions/about-actions.md
View File

@@ -59,7 +59,7 @@ If you're developing a Node.js project, the {% data variables.product.prodname_a
### Composite run steps actions
A _composite run steps_ action allows you to combine multiple workflow run steps within one action. For example, you can use this feature to bundle together multiple run commands into an action, and then have a workflow that executes the bundled commands a single step using that action. To see an example, check out "[Creating a composite run steps action](/actions/creating-actions/creating-a-composite-run-steps-action)".
A _composite run steps_ action allows you to combine multiple workflow run steps within one action. For example, you can use this feature to bundle together multiple run commands into an action, and then have a workflow that executes the bundled commands as a single step using that action. To see an example, check out "[Creating a composite run steps action](/actions/creating-actions/creating-a-composite-run-steps-action)".
## Choosing a location for your action

2
content/actions/reference/workflow-syntax-for-github-actions.md
View File

@@ -371,8 +371,6 @@ Available {% data variables.product.prodname_dotcom %}-hosted runner types are:
{% data reusables.github-actions.supported-github-runners %}
{% data reusables.github-actions.macos-runner-preview %}
#### Example
```yaml

2
content/actions/using-github-hosted-runners/about-github-hosted-runners.md
View File

@@ -61,8 +61,6 @@ Hardware specification for macOS virtual machines:
{% data reusables.github-actions.supported-github-runners %}
{% data reusables.github-actions.macos-runner-preview %}
Workflow logs list the runner used to run a job. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)."
## Supported software

2
content/developers/github-marketplace/creating-apps-for-github-marketplace/viewing-transactions-for-your-listing.md
View File

@@ -30,6 +30,8 @@ You can view or download the transaction data to keep track of your subscription
* **amount_in_cents:** The amount of the transaction in cents. When a value is less the plan amount, the user upgraded and the new plan is prorated. A value of zero indicates the user cancelled their plan.
* **renewal_frequency:** The subscription renewal frequency, either `Monthly` or `Yearly`.
* **marketplace_listing_plan_id:** The `id` of the subscription plan.
* **region:** The name of the region present in billing address.
* **postal_code:** The postal code value present in billing address.
![Marketplace insights](/assets/images/marketplace/marketplace_transactions.png)

1
content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md
View File

@@ -5,7 +5,6 @@ versions:
fpt: '*'
---
{% data reusables.discussions.beta %}
## About {% data variables.product.prodname_discussions %}

1
content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md
View File

@@ -7,7 +7,6 @@ versions:
fpt: '*'
---
{% data reusables.discussions.beta %}
## About collaboration with maintainers using {% data variables.product.prodname_discussions %}

1
content/discussions/collaborating-with-your-community-using-discussions/index.md
View File

@@ -9,4 +9,3 @@ children:
- /participating-in-a-discussion
- /collaborating-with-maintainers-using-discussions
---
{% data reusables.discussions.beta %}

1
content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md
View File

@@ -7,7 +7,6 @@ versions:
shortTitle: Participate in discussion
---
{% data reusables.discussions.beta %}
## About participation in a discussion

1
content/discussions/guides/best-practices-for-community-conversations-on-github.md
View File

@@ -6,7 +6,6 @@ versions:
fpt: '*'
---
{% data reusables.discussions.beta %}
## Community conversations in {% data variables.product.prodname_discussions %}

1
content/discussions/guides/finding-discussions-across-multiple-repositories.md
View File

@@ -6,7 +6,6 @@ versions:
shortTitle: Find discussions
---
{% data reusables.discussions.beta %}
## Finding discussions

1
content/discussions/guides/granting-higher-permissions-to-top-contributors.md
View File

@@ -6,7 +6,6 @@ versions:
shortTitle: Grant higher permissions
---
{% data reusables.discussions.beta %}
## Introduction

1
content/discussions/guides/index.md
View File

@@ -9,4 +9,3 @@ children:
- /finding-discussions-across-multiple-repositories
- /granting-higher-permissions-to-top-contributors
---
{% data reusables.discussions.beta %}

1
content/discussions/index.md
View File

@@ -1,6 +1,5 @@
---
title: GitHub Discussions Documentation
beta_product: true
shortTitle: GitHub Discussions
intro: '{% data variables.product.prodname_discussions %} is a collaborative communication forum for the community around an open source project. Community members can ask and answer questions, share updates, have open-ended conversations, and follow along on decisions affecting the community''s way of working.'
introLinks:

1
content/discussions/managing-discussions-for-your-community/index.md
View File

@@ -9,4 +9,3 @@ children:
- /managing-categories-for-discussions-in-your-repository
- /moderating-discussions
---
{% data reusables.discussions.beta %}

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

@@ -7,7 +7,6 @@ versions:
shortTitle: Manage categories
---
{% data reusables.discussions.beta %}
## About categories for discussions

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

@@ -7,7 +7,6 @@ versions:
shortTitle: Manage discussions
---
{% data reusables.discussions.beta %}
## About management of discussions

1
content/discussions/managing-discussions-for-your-community/moderating-discussions.md
View File

@@ -6,7 +6,6 @@ versions:
fpt: '*'
---
{% data reusables.discussions.beta %}
## About moderating discussions

1
content/discussions/quickstart.md
View File

@@ -7,7 +7,6 @@ versions:
shortTitle: Quickstart
---
{% data reusables.discussions.beta %}
## Introduction

6
content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md
View File

@@ -61,6 +61,12 @@ Once you've authenticated successfully, your credentials are stored in the Windo
{% endwarning %}
{% warning %}
**Warning:** If you cached incorrect or outdated credentials in Credential Manager for Windows, Git will fail to access {% data variables.product.product_name %}. To reset your cached credentials so that Git prompts you to enter your credentials, access the Credential Manager in the Windows Control Panel under User Accounts > Credential Manager. Look for the {% data variables.product.product_name %} entry and delete it.
{% endwarning %}
{% endwindows %}
{% linux %}

1
content/github/administering-a-repository/managing-repository-settings/enabling-or-disabling-github-discussions-for-a-repository.md
View File

@@ -11,7 +11,6 @@ redirect_from:
- /github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository
shortTitle: Discussions
---
{% data reusables.discussions.beta %}
## Enabling or disabling {% data variables.product.prodname_discussions %} for your repository

8
content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners.md
View File

@@ -41,7 +41,7 @@ For code owners to receive review requests, the CODEOWNERS file must be on the b
## CODEOWNERS syntax
A CODEOWNERS file uses a pattern that follows most of the same rules used in [gitignore](https://git-scm.com/docs/gitignore#_pattern_format) files, with [some exceptions](#syntax-exceptions). The pattern is followed by one or more {% data variables.product.prodname_dotcom %} usernames or team names using the standard `@username` or `@org/team-name` format. You can also refer to a user by an email address that has been added to their {% data variables.product.product_name %} account, for example `user@example.com`.
A CODEOWNERS file uses a pattern that follows most of the same rules used in [gitignore](https://git-scm.com/docs/gitignore#_pattern_format) files, with [some exceptions](#syntax-exceptions). The pattern is followed by one or more {% data variables.product.prodname_dotcom %} usernames or team names using the standard `@username` or `@org/team-name` format. Users must have `read` access to the repository and teams must have explicit `write` access, even if the team's members already have access. You can also refer to a user by an email address that has been added to their {% data variables.product.product_name %} account, for example `user@example.com`.
If any line in your CODEOWNERS file contains invalid syntax, the file will not be detected and will not be used to request reviews.
### Example of a CODEOWNERS file
@@ -66,6 +66,12 @@ If any line in your CODEOWNERS file contains invalid syntax, the file will not b
# emails.
*.go docs@example.com
# Teams can be specified as code owners as well. Teams should
# be identified in the format @org/team-name. Teams must have
# explicit write access to the repository. In this example,
# the octocats team in the octo-org organization owns all .txt files.
*.txt @octo-org/octocats
# In this example, @doctocat owns any files in the build/logs
# directory at the root of the repository and any of its
# subdirectories.

4
content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes.md
View File

@@ -42,6 +42,8 @@ If you put your README file in your repository's root, `docs`, or hidden `.githu
{% endif %}
{% ifversion fpt or ghae-next or ghes > 3.1 %}
## Auto-generated table of contents for README files
For the rendered view of any Markdown file in a repository, including README files, {% data variables.product.product_name %} will automatically generate a table of contents based on section headings. You can view the table of contents for a README file by clicking the {% octicon "list-unordered" aria-label="The unordered list icon" %} menu icon at the top left of the rendered page.
@@ -55,6 +57,8 @@ The auto-generated table of contents is enabled by default for all Markdown file
1. Under "Features", deselect **Table of contents**.
![Automatic TOC setting for repositories](/assets/images/help/repository/readme-automatic-toc-setting.png)
{% endif %}
## Section links in README files and blob pages
{% data reusables.repositories.section-links %}

1
content/github/searching-for-information-on-github/searching-on-github/searching-discussions.md
View File

@@ -8,7 +8,6 @@ topics:
redirect_from:
- /github/searching-for-information-on-github/searching-discussions
---
{% data reusables.discussions.beta %}
## About searching for discussions

1
content/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization.md
View File

@@ -12,7 +12,6 @@ topics:
shortTitle: Manage discussion creation
---
{% data reusables.discussions.beta %}
## Allowing or disallowing users with read access to create discussions

2
contributing/development.md
View File

@@ -28,7 +28,7 @@ When you're ready to stop your local server, type <kbd>CTRL</kbd><kbd>c</kbd> in
Note that `npm ci` and `npm run build` are steps that should typically only need to be run once each time you pull the latest for a branch.
- `npm ci` does a clean install of dependencies, without updating the `package-lock.json` file
- `npm run build` creates static assets, such as the `dist/index.js` and `dist/index.css` files
- `npm run build` creates static assets, such as JavaScript and CSS files
### Using GitHub Codespaces

5
data/graphql/ghae/schema.docs-ghae.graphql
View File

@@ -21792,6 +21792,11 @@ enum OrganizationMembersCanCreateRepositoriesSettingValue {
"""
DISABLED
"""
Members will be able to create only internal repositories.
"""
INTERNAL
"""
Members will be able to create only private repositories.
"""

35
data/graphql/schema.docs.graphql
View File

@@ -22119,6 +22119,11 @@ type Organization implements Actor & MemberStatusable & Node & PackageOwner & Pr
"""
email: String
"""
The estimated next GitHub Sponsors payout for this user/organization in cents (USD).
"""
estimatedNextSponsorsPayoutInCents: Int!
"""
True if this user/organization has a GitHub Sponsors listing.
"""
@@ -22261,6 +22266,11 @@ type Organization implements Actor & MemberStatusable & Node & PackageOwner & Pr
last: Int
): OrganizationMemberConnection!
"""
The estimated monthly GitHub Sponsors income for this user/organization in cents (USD).
"""
monthlyEstimatedSponsorsIncomeInCents: Int!
"""
The organization's public profile name.
"""
@@ -23425,6 +23435,11 @@ enum OrganizationMembersCanCreateRepositoriesSettingValue {
"""
DISABLED
"""
Members will be able to create only internal repositories.
"""
INTERNAL
"""
Members will be able to create only private repositories.
"""
@@ -37069,6 +37084,11 @@ enum SponsorOrderField {
Entities that can be sponsored through GitHub Sponsors
"""
interface Sponsorable {
"""
The estimated next GitHub Sponsors payout for this user/organization in cents (USD).
"""
estimatedNextSponsorsPayoutInCents: Int!
"""
True if this user/organization has a GitHub Sponsors listing.
"""
@@ -37089,6 +37109,11 @@ interface Sponsorable {
"""
isSponsoringViewer: Boolean!
"""
The estimated monthly GitHub Sponsors income for this user/organization in cents (USD).
"""
monthlyEstimatedSponsorsIncomeInCents: Int!
"""
List of users and organizations this entity is sponsoring.
"""
@@ -43673,6 +43698,11 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner &
"""
email: String!
"""
The estimated next GitHub Sponsors payout for this user/organization in cents (USD).
"""
estimatedNextSponsorsPayoutInCents: Int!
"""
A list of users the given user is followed by.
"""
@@ -43960,6 +43990,11 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner &
"""
login: String!
"""
The estimated monthly GitHub Sponsors income for this user/organization in cents (USD).
"""
monthlyEstimatedSponsorsIncomeInCents: Int!
"""
The user's public profile name.
"""

5
data/reusables/discussions/beta.md
View File

@@ -1,5 +0,0 @@
{% note %}
**Note:** {% data variables.product.prodname_discussions %} is currently in beta and subject to change.
{% endnote %}

6
data/reusables/github-actions/macos-runner-preview.md
View File

@@ -1,5 +1 @@
{% note %}
**Note:** The `macos-latest` YAML workflow label currently uses the macOS 10.15 virtual environment.
{% endnote %}
The <code>macos-latest</code> YAML workflow label currently uses the macOS 10.15 virtual environment.

98
data/reusables/github-actions/supported-github-runners.md
View File

@@ -1,14 +1,84 @@
{% warning %}
**Warning**: Ubuntu 16.04 is being deprecated and limited to existing customers only. No new onboardings are accepted. If any of your workflows use Ubuntu 16.04, migrate to Ubuntu 20.04 or 18.04. For more information, see [the blog post](https://github.blog/changelog/2021-04-29-github-actions-ubuntu-16-04-lts-virtual-environment-will-be-removed-on-september-20-2021).
{% endwarning %}
| Virtual environment | YAML workflow label |
| --------------------|---------------------|
| Windows Server 2019 | `windows-latest` or `windows-2019` |
| Windows Server 2016 | `windows-2016` |
| Ubuntu 20.04 | `ubuntu-latest` or `ubuntu-20.04` |
| Ubuntu 18.04 | `ubuntu-18.04` |
| macOS Big Sur 11 | `macos-11` |
| macOS Catalina 10.15 | `macos-latest` or `macos-10.15` |
<table style="width:100%">
<thead>
<tr>
<th style="width:25%">Virtual environment</th>
<th style="width:25%">YAML workflow label</th>
<th style="width:50%">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Windows Server 2019
</td>
<td>
<code>windows-latest</code> or <code>windows-2019</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
Windows Server 2016
</td>
<td>
<code>windows-2016</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
Ubuntu 20.04
</td>
<td>
<code>ubuntu-latest</code> or <code>ubuntu-20.04</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
Ubuntu 18.04
</td>
<td>
<code>ubuntu-18.04</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
Ubuntu 16.04
</td>
<td>
<code>ubuntu-16.04</code>
</td>
<td>
Deprecated and limited to existing customers only. If any of your workflows use Ubuntu 16.04, migrate to Ubuntu 20.04 or 18.04. For more information, see <A href="https://github.blog/changelog/2021-04-29-github-actions-ubuntu-16-04-lts-virtual-environment-will-be-removed-on-september-20-2021">the blog post</A>.
</td>
</tr>
<tr>
<td>
macOS Big Sur 11
</td>
<td>
<code>macos-11</code>
</td>
<td>
{% data reusables.github-actions.macos-runner-preview %}
</td>
</tr>
<tr>
<td>
macOS Catalina 10.15
</td>
<td>
<code>macos-latest</code> or <code>macos-10.15</code>
</td>
<td>
{% data reusables.github-actions.macos-runner-preview %}
</td>
</tr>
</tbody>
</table>

2
data/ui.yml
View File

@@ -54,8 +54,6 @@ survey:
able_to_find: Did this doc help you?
yes: Yes
no: No
yes_feedback: We're continually improving our docs. We'd love to hear what we do well.
no_feedback: We're continually improving our docs. We'd love to hear how we can do better.
comment_yes_label: Let us know what we do well
comment_no_label: Let us know what we can do better
optional: Optional

14
includes/liquid-tags/link-as-article-card.html
View File

@@ -1,14 +0,0 @@
<div class="d-flex col-12 col-md-4 pr-0 pr-md-6 pr-lg-8 <display condition> js-filter-card" data-type="{{ type.key }}" data-topics="{{ topics | join: ',' }}">
<a class="no-underline d-flex flex-column py-3 border-bottom" href="{{ fullPath }}">
<h4 class="h4 color-text-primary mb-1">{{ title }}</h4>
<div class="h6 text-uppercase">{{ type.value }}</div>
<p class="color-text-secondary my-3">{{ intro }}</p>
{% if topics.length %}
<div>
{% for topic in topics %}
<span class="IssueLabel bg-gradient--pink-blue color-text-inverse mr-1">{{ topic }}</span>
{% endfor %}
</div>
{% endif %}
</a>
</div>

1
includes/liquid-tags/link-in-list.html
View File

@@ -1 +0,0 @@
- <a class="article-link link Bump-link--hover no-underline" href="{{ fullPath }}">{{ title }}</a>

4
includes/liquid-tags/link-with-intro.html
View File

@@ -1,4 +0,0 @@
<a class="link-with-intro Bump-link--hover no-underline" href="{{ fullPath }}">
<h2 class="link-with-intro-title f4">{{ title }}<span class="Bump-link-symbol">→</span></h2>
</a>
{% if intro %}<p class="link-with-intro-intro">{{ intro }}</p>{% endif %}

1
includes/liquid-tags/link.html
View File

@@ -1 +0,0 @@
<a class="link-title Bump-link--hover no-underline" href="{{ fullPath }}">{{ title }}</a>

1
includes/liquid-tags/topic-link-in-list.html
View File

@@ -1 +0,0 @@
- <a class="topic-link link Bump-link--hover no-underline" href="{{ fullPath }}">{{ title }}</a>

2
jest.config.js
View File

@@ -25,7 +25,7 @@ module.exports = {
preset: isBrowser ? 'jest-puppeteer' : undefined,
reporters,
modulePathIgnorePatterns: ['assets/'],
setupFilesAfterEnv: ['jest-expect-message'],
setupFilesAfterEnv: ['@alex_neo/jest-expect-message'],
...(isBrowser ? {} : { testEnvironment: 'node' }),
testPathIgnorePatterns: [
'node_modules/',

3
lib/enterprise-dates.json
View File

@@ -1,5 +1,4 @@
{
"comment": "This file is also used by Octokit. See https://github.com/octokit/openapi-types.ts/issues/109. Please reach out to the Octokit maintainer before removing or renaming this file.",
"2.0": {
"releaseDate": "2014-11-11",
"deprecationDate": "2016-02-09"
@@ -108,4 +107,4 @@
"releaseDate": "2021-11-09",
"deprecationDate": "2022-12-07"
}
}
}

3
lib/enterprise-server-releases.js
View File

@@ -12,8 +12,9 @@ export const dates = JSON.parse(
// Some frontmatter may contain the upcoming GHES release number
export const next = '3.2'
export const supported = ['3.1', '3.0', '2.22', '2.21']
export const supported = ['3.1', '3.0', '2.22']
export const deprecated = [
'2.21',
'2.20',
'2.19',
'2.18',

19
lib/graphql/static/changelog.json
View File

@@ -1,4 +1,23 @@
[
{
"schemaChanges": [
{
"title": "The GraphQL schema includes these changes:",
"changes": [
"Field `estimatedNextSponsorsPayoutInCents` was added to object type `Organization`",
"Field `monthlyEstimatedSponsorsIncomeInCents` was added to object type `Organization`",
"Enum value `INTERNAL` was added to enum `OrganizationMembersCanCreateRepositoriesSettingValue`",
"Field `estimatedNextSponsorsPayoutInCents` was added to interface `Sponsorable`",
"Field `monthlyEstimatedSponsorsIncomeInCents` was added to interface `Sponsorable`",
"Field `estimatedNextSponsorsPayoutInCents` was added to object type `User`",
"Field `monthlyEstimatedSponsorsIncomeInCents` was added to object type `User`"
]
}
],
"previewChanges": [],
"upcomingChanges": [],
"date": "2021-08-18"
},
{
"schemaChanges": [
{

860
lib/graphql/static/prerendered-input-objects.json
View File

File diff suppressed because one or more lines are too long

2207
lib/graphql/static/prerendered-objects.json
View File

File diff suppressed because one or more lines are too long

249
lib/graphql/static/previews.json
View File

@@ -667,255 +667,6 @@
"href": "/graphql/overview/schema-previews#team-review-assignments-preview"
}
],
"ghes-2.21": [
{
"title": "Access to package version deletion preview",
"description": "This preview adds support for the DeletePackageVersion mutation which enables deletion of private package versions.",
"toggled_by": "package-deletes-preview",
"toggled_on": [
"Mutation.deletePackageVersion",
"RegistryPackageVersion.deleted"
],
"owning_teams": [
"@github/pe-package-registry"
],
"accept_header": "application/vnd.github.package-deletes-preview+json",
"href": "/graphql/overview/schema-previews#access-to-package-version-deletion-preview"
},
{
"title": "GitHub packages preview",
"description": "This preview adds support for objects relating to GitHub Packages.",
"toggled_by": "packages-preview",
"toggled_on": [
"Package",
"PackageFile",
"PackageFileOrder",
"PackageFileOrderField",
"PackageOrder",
"PackageOrderField",
"PackageOwner",
"PackageStatistics",
"PackageTag",
"PackageVersion",
"PackageVersionOrder",
"PackageVersionOrderField",
"PackageVersionStatistics",
"Organization.packages",
"PackageMetadatum.packageVersion",
"Repository.packages",
"User.packages",
"PackageConnection.nodes",
"PackageFileConnection.nodes",
"PackageTagConnection.nodes",
"PackageVersionConnection.nodes",
"PackageEdge.node",
"PackageFileEdge.node",
"PackageTagEdge.node",
"PackageVersionEdge.node",
"CreatePackageVersionPayload.packageVersion",
"UpdatePackageVersionPayload.packageVersion",
"CreatePackageFilePayload.packageFile",
"UpdatePackageFilePayload.packageFile",
"CreatePackageVersionMetadataPayload.packageVersion",
"AddPackageTagPayload.package",
"DeletePackageTagPayload.package"
],
"owning_teams": [
"@github/pe-package-registry"
],
"accept_header": "application/vnd.github.packages-preview+json",
"href": "/graphql/overview/schema-previews#github-packages-preview"
},
{
"title": "Deployments preview",
"description": "This preview adds support for deployments mutations and new deployments features.",
"toggled_by": "flash-preview",
"toggled_on": [
"DeploymentStatus.environment",
"Mutation.createDeploymentStatus",
"Mutation.createDeployment"
],
"owning_teams": [
"@github/ecosystem-api"
],
"accept_header": "application/vnd.github.flash-preview+json",
"href": "/graphql/overview/schema-previews#deployments-preview"
},
{
"title": "Checks preview",
"description": "This preview adds support for reading checks created by GitHub Apps.",
"toggled_by": "antiope-preview",
"toggled_on": [
"CheckAnnotationRange",
"CheckAnnotationPosition",
"CheckAnnotationSpan",
"CheckAnnotation",
"CheckAnnotationConnection.nodes",
"CheckAnnotationData",
"CheckAnnotationEdge.node",
"CheckAnnotationLevel",
"CheckConclusionState",
"CheckStatusState",
"CheckSuiteAutoTriggerPreference",
"CheckRun",
"CheckRunConnection.nodes",
"CheckRunEdge.node",
"CheckRunAction",
"CheckRunFilter",
"CheckRunOutput",
"CheckRunOutputImage",
"CheckRunType",
"CheckSuite",
"CheckSuiteConnection.nodes",
"CheckSuiteEdge.node",
"CheckSuiteFilter",
"Commit.checkSuites",
"Mutation.createCheckRun",
"Mutation.createCheckSuite",
"Mutation.rerequestCheckSuite",
"Mutation.updateCheckRun",
"Mutation.updateCheckSuitePreferences",
"Push",
"RequestableCheckStatusState",
"UpdateCheckSuitePayload.checkSuite"
],
"owning_teams": [
"@github/ce-extensibility"
],
"accept_header": "application/vnd.github.antiope-preview+json",
"href": "/graphql/overview/schema-previews#checks-preview"
},
{
"title": "Merge info preview",
"description": "This preview adds support for accessing fields that provide more detailed information about a pull request's merge state.",
"toggled_by": "merge-info-preview",
"toggled_on": [
"PullRequest.canBeRebased",
"PullRequest.mergeStateStatus"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.merge-info-preview+json",
"href": "/graphql/overview/schema-previews#merge-info-preview"
},
{
"title": "Update refs preview",
"description": "This preview adds support for updating multiple refs in a single operation.",
"toggled_by": "update-refs-preview",
"toggled_on": [
"Mutation.updateRefs",
"GitRefname",
"RefUpdate"
],
"owning_teams": [
"@github/pe-repos"
],
"accept_header": "application/vnd.github.update-refs-preview+json",
"href": "/graphql/overview/schema-previews#update-refs-preview"
},
{
"title": "Project event details preview",
"description": "This preview adds project, project card, and project column details to project-related issue events.",
"toggled_by": "starfox-preview",
"toggled_on": [
"AddedToProjectEvent.project",
"AddedToProjectEvent.projectCard",
"AddedToProjectEvent.projectColumnName",
"ConvertedNoteToIssueEvent.project",
"ConvertedNoteToIssueEvent.projectCard",
"ConvertedNoteToIssueEvent.projectColumnName",
"MovedColumnsInProjectEvent.project",
"MovedColumnsInProjectEvent.projectCard",
"MovedColumnsInProjectEvent.projectColumnName",
"MovedColumnsInProjectEvent.previousProjectColumnName",
"RemovedFromProjectEvent.project",
"RemovedFromProjectEvent.projectColumnName"
],
"owning_teams": [
"@github/github-projects"
],
"accept_header": "application/vnd.github.starfox-preview+json",
"href": "/graphql/overview/schema-previews#project-event-details-preview"
},
{
"title": "Create content attachments preview",
"description": "This preview adds support for creating content attachments.",
"toggled_by": "corsair-preview",
"toggled_on": [
"Mutation.createContentAttachment"
],
"owning_teams": [
"@github/ce-extensibility"
],
"accept_header": "application/vnd.github.corsair-preview+json",
"href": "/graphql/overview/schema-previews#create-content-attachments-preview"
},
{
"title": "Pinned issues preview",
"description": "This preview adds support for pinned issues.",
"toggled_by": "elektra-preview",
"toggled_on": [
"Repository.pinnedIssues",
"PinnedIssue",
"PinnedIssueEdge",
"PinnedIssueConnection",
"Mutation.pinIssue",
"Mutation.unpinIssue"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.elektra-preview+json",
"href": "/graphql/overview/schema-previews#pinned-issues-preview"
},
{
"title": "Labels preview",
"description": "This preview adds support for adding, updating, creating and deleting labels.",
"toggled_by": "bane-preview",
"toggled_on": [
"Mutation.createLabel",
"Mutation.deleteLabel",
"Mutation.updateLabel"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.bane-preview+json",
"href": "/graphql/overview/schema-previews#labels-preview"
},
{
"title": "Import project preview",
"description": "This preview adds support for importing projects.",
"toggled_by": "slothette-preview",
"toggled_on": [
"Mutation.importProject"
],
"owning_teams": [
"@github/pe-issues-projects"
],
"accept_header": "application/vnd.github.slothette-preview+json",
"href": "/graphql/overview/schema-previews#import-project-preview"
},
{
"title": "Team review assignments preview",
"description": "This preview adds support for updating the settings for team review assignment.",
"toggled_by": "stone-crop-preview",
"toggled_on": [
"Mutation.updateTeamReviewAssignment",
"TeamReviewAssignmentAlgorithm",
"Team.reviewRequestDelegationEnabled",
"Team.reviewRequestDelegationAlgorithm",
"Team.reviewRequestDelegationMemberCount",
"Team.reviewRequestDelegationNotifyTeam"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.stone-crop-preview+json",
"href": "/graphql/overview/schema-previews#team-review-assignments-preview"
}
],
"ghae": [
{
"title": "Access to package version deletion preview",

52
lib/graphql/static/schema-dotcom.json
View File

@@ -32666,6 +32666,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "estimatedNextSponsorsPayoutInCents",
"description": "<p>The estimated next GitHub Sponsors payout for this user/organization in cents (USD).</p>",
"type": "Int!",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
},
{
"name": "hasSponsorsListing",
"description": "<p>True if this user/organization has a GitHub Sponsors listing.</p>",
@@ -32928,6 +32936,14 @@
}
]
},
{
"name": "monthlyEstimatedSponsorsIncomeInCents",
"description": "<p>The estimated monthly GitHub Sponsors income for this user/organization in cents (USD).</p>",
"type": "Int!",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
},
{
"name": "name",
"description": "<p>The organization's public profile name.</p>",
@@ -58270,6 +58286,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "estimatedNextSponsorsPayoutInCents",
"description": "<p>The estimated next GitHub Sponsors payout for this user/organization in cents (USD).</p>",
"type": "Int!",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
},
{
"name": "followers",
"description": "<p>A list of users the given user is followed by.</p>",
@@ -58812,6 +58836,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "monthlyEstimatedSponsorsIncomeInCents",
"description": "<p>The estimated monthly GitHub Sponsors income for this user/organization in cents (USD).</p>",
"type": "Int!",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
},
{
"name": "name",
"description": "<p>The user's public profile name.</p>",
@@ -63672,6 +63704,14 @@
"href": "/graphql/reference/interfaces#sponsorable",
"description": "<p>Entities that can be sponsored through GitHub Sponsors.</p>",
"fields": [
{
"name": "estimatedNextSponsorsPayoutInCents",
"description": "<p>The estimated next GitHub Sponsors payout for this user/organization in cents (USD).</p>",
"type": "Int!",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
},
{
"name": "hasSponsorsListing",
"description": "<p>True if this user/organization has a GitHub Sponsors listing.</p>",
@@ -63708,6 +63748,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean"
},
{
"name": "monthlyEstimatedSponsorsIncomeInCents",
"description": "<p>The estimated monthly GitHub Sponsors income for this user/organization in cents (USD).</p>",
"type": "Int!",
"id": "int",
"kind": "scalars",
"href": "/graphql/reference/scalars#int"
},
{
"name": "sponsoring",
"description": "<p>List of users and organizations this entity is sponsoring.</p>",
@@ -66165,6 +66213,10 @@
"name": "DISABLED",
"description": "<p>Members will not be able to create public or private repositories.</p>"
},
{
"name": "INTERNAL",
"description": "<p>Members will be able to create only internal repositories.</p>"
},
{
"name": "PRIVATE",
"description": "<p>Members will be able to create only private repositories.</p>"

4
lib/graphql/static/schema-ghae.json
View File

@@ -60363,6 +60363,10 @@
"name": "DISABLED",
"description": "<p>Members will not be able to create public or private repositories.</p>"
},
{
"name": "INTERNAL",
"description": "<p>Members will be able to create only internal repositories.</p>"
},
{
"name": "PRIVATE",
"description": "<p>Members will be able to create only private repositories.</p>"

660
lib/graphql/static/upcoming-changes.json
View File

@@ -611,666 +611,6 @@
}
]
},
"ghes-2.21": {
"2020-10-01": [
{
"location": "PullRequest.timeline",
"description": "<p><code>timeline</code> will be removed. Use PullRequest.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "Issue.timeline",
"description": "<p><code>timeline</code> will be removed. Use Issue.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
}
],
"2020-04-01": [
{
"location": "User.registryPackagesForQuery",
"description": "<p><code>registryPackagesForQuery</code> will be removed. Use the <code>PackageSearch</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "User.registryPackages",
"description": "<p><code>registryPackages</code> will be removed. Use the <code>PackageOwner</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "Sponsorship.maintainer",
"description": "<p><code>maintainer</code> will be removed. Use <code>Sponsorship.sponsorable</code> instead.</p>",
"reason": "<p><code>Sponsorship.maintainer</code> will be removed.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "antn"
},
{
"location": "Repository.registryPackagesForQuery",
"description": "<p><code>registryPackagesForQuery</code> will be removed. Use the <code>PackageSearch</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "Repository.registryPackages",
"description": "<p><code>registryPackages</code> will be removed. Use the <code>PackageOwner</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersionStatistics.downloadsTotalCount",
"description": "<p><code>downloadsTotalCount</code> will be removed. Use the <code>PackageVersionStatistics</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersionStatistics.downloadsToday",
"description": "<p><code>downloadsToday</code> will be removed. Use the <code>PackageVersionStatistics</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersionStatistics.downloadsThisYear",
"description": "<p><code>downloadsThisYear</code> will be removed. Use the <code>PackageVersionStatistics</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersionStatistics.downloadsThisWeek",
"description": "<p><code>downloadsThisWeek</code> will be removed. Use the <code>PackageVersionStatistics</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersionStatistics.downloadsThisMonth",
"description": "<p><code>downloadsThisMonth</code> will be removed. Use the <code>PackageVersionStatistics</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.viewerCanEdit",
"description": "<p><code>viewerCanEdit</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.version",
"description": "<p><code>version</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.updatedAt",
"description": "<p><code>updatedAt</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.summary",
"description": "<p><code>summary</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.statistics",
"description": "<p><code>statistics</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.size",
"description": "<p><code>size</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.sha256",
"description": "<p><code>sha256</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.release",
"description": "<p><code>release</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.registryPackage",
"description": "<p><code>registryPackage</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.readmeHtml",
"description": "<p><code>readmeHtml</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.readme",
"description": "<p><code>readme</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.preRelease",
"description": "<p><code>preRelease</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.platform",
"description": "<p><code>platform</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.manifest",
"description": "<p><code>manifest</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.installationCommand",
"description": "<p><code>installationCommand</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.files",
"description": "<p><code>files</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.fileByName",
"description": "<p><code>fileByName</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.dependencies",
"description": "<p><code>dependencies</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageVersion.deleted",
"description": "<p><code>deleted</code> will be removed. Use the <code>PackageVersion</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageTag.version",
"description": "<p><code>version</code> will be removed. Use the <code>PackageTag</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageTag.name",
"description": "<p><code>name</code> will be removed. Use the <code>PackageTag</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageStatistics.downloadsTotalCount",
"description": "<p><code>downloadsTotalCount</code> will be removed. Use the <code>PackageStatistics</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageStatistics.downloadsToday",
"description": "<p><code>downloadsToday</code> will be removed. Use the <code>PackageStatistics</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageStatistics.downloadsThisYear",
"description": "<p><code>downloadsThisYear</code> will be removed. Use the <code>PackageStatistics</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageStatistics.downloadsThisWeek",
"description": "<p><code>downloadsThisWeek</code> will be removed. Use the <code>PackageStatistics</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageStatistics.downloadsThisMonth",
"description": "<p><code>downloadsThisMonth</code> will be removed. Use the <code>PackageStatistics</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageSearch.registryPackagesForQuery",
"description": "<p><code>registryPackagesForQuery</code> will be removed. Use the <code>PackageSearch</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageOwner.registryPackages",
"description": "<p><code>registryPackages</code> will be removed. Use the <code>PackageOwner</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageFile.url",
"description": "<p><code>url</code> will be removed. Use the <code>PackageFile</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageFile.size",
"description": "<p><code>size</code> will be removed. Use the <code>PackageFile</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageFile.sha256",
"description": "<p><code>sha256</code> will be removed. Use the <code>PackageFile</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageFile.sha1",
"description": "<p><code>sha1</code> will be removed. Use the <code>PackageFile</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageFile.packageVersion",
"description": "<p><code>packageVersion</code> will be removed. Use the <code>PackageFile</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageFile.name",
"description": "<p><code>name</code> will be removed. Use the <code>PackageFile</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageFile.metadataUrl",
"description": "<p><code>metadataUrl</code> will be removed. Use the <code>PackageFile</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageFile.md5",
"description": "<p><code>md5</code> will be removed. Use the <code>PackageFile</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageFile.guid",
"description": "<p><code>guid</code> will be removed. Use the <code>PackageFile</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageDependency.version",
"description": "<p><code>version</code> will be removed. Use the <code>PackageDependency</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageDependency.name",
"description": "<p><code>name</code> will be removed. Use the <code>PackageDependency</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackageDependency.dependencyType",
"description": "<p><code>dependencyType</code> will be removed. Use the <code>PackageDependency</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.versionsByMetadatum",
"description": "<p><code>versionsByMetadatum</code> will be removed. Use the <code>Package</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.versions",
"description": "<p><code>versions</code> will be removed. Use the <code>Package</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.versionBySha256",
"description": "<p><code>versionBySha256</code> will be removed. Use the <code>Package</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.versionByPlatform",
"description": "<p><code>versionByPlatform</code> will be removed. Use the <code>Package</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.version",
"description": "<p><code>version</code> will be removed. Use the <code>Package</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.topics",
"description": "<p><code>topics</code> will be removed. Use the <code>Package</code> object.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.tags",
"description": "<p><code>tags</code> will be removed. Use the <code>Package</code> object.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.statistics",
"description": "<p><code>statistics</code> will be removed. Use the <code>Package</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.repository",
"description": "<p><code>repository</code> will be removed. Use the <code>Package</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.registryPackageType",
"description": "<p><code>registryPackageType</code> will be removed. Use the <code>Package</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.preReleaseVersions",
"description": "<p><code>preReleaseVersions</code> will be removed. Use the <code>Package</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.packageType",
"description": "<p><code>packageType</code> will be removed. Use the <code>Package</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.packageFileBySha256",
"description": "<p><code>packageFileBySha256</code> will be removed. Use the <code>Package</code> object.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.packageFileByGuid",
"description": "<p><code>packageFileByGuid</code> will be removed. Use the <code>Package</code> object.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.nameWithOwner",
"description": "<p><code>nameWithOwner</code> will be removed. Use the <code>Package</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.name",
"description": "<p><code>name</code> will be removed. Use the <code>Package</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.latestVersion",
"description": "<p><code>latestVersion</code> will be removed. Use the <code>Package</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "RegistryPackage.color",
"description": "<p><code>color</code> will be removed. Use the <code>Package</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "Organization.registryPackagesForQuery",
"description": "<p><code>registryPackagesForQuery</code> will be removed. Use the <code>PackageSearch</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
},
{
"location": "Organization.registryPackages",
"description": "<p><code>registryPackages</code> will be removed. Use the <code>PackageOwner</code> object instead.</p>",
"reason": "<p>Renaming GitHub Packages fields and objects.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "dinahshi"
}
],
"2020-01-01": [
{
"location": "UnassignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
},
{
"location": "EnterpriseBillingInfo.seats",
"description": "<p><code>seats</code> will be removed. Use EnterpriseBillingInfo.totalLicenses instead.</p>",
"reason": "<p><code>seats</code> will be replaced with <code>totalLicenses</code> to provide more clarity on the value being returned</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "BlakeWilliams"
},
{
"location": "EnterpriseBillingInfo.availableSeats",
"description": "<p><code>availableSeats</code> will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses instead.</p>",
"reason": "<p><code>availableSeats</code> will be replaced with <code>totalAvailableLicenses</code> to provide more clarity on the value being returned</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "BlakeWilliams"
},
{
"location": "AssignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
}
],
"2019-10-01": [
{
"location": "User.pinnedRepositories",
"description": "<p><code>pinnedRepositories</code> will be removed. Use ProfileOwner.pinnedItems instead.</p>",
"reason": "<p>pinnedRepositories will be removed</p>",
"date": "2019-10-01",
"criticality": "breaking",
"owner": "cheshire137"
},
{
"location": "RepositoryOwner.pinnedRepositories",
"description": "<p><code>pinnedRepositories</code> will be removed. Use ProfileOwner.pinnedItems instead.</p>",
"reason": "<p>pinnedRepositories will be removed</p>",
"date": "2019-10-01",
"criticality": "breaking",
"owner": "cheshire137"
},
{
"location": "Organization.pinnedRepositories",
"description": "<p><code>pinnedRepositories</code> will be removed. Use ProfileOwner.pinnedItems instead.</p>",
"reason": "<p>pinnedRepositories will be removed</p>",
"date": "2019-10-01",
"criticality": "breaking",
"owner": "cheshire137"
},
{
"location": "ContributionOrder.field",
"description": "<p><code>field</code> will be removed. Only one order field is supported.</p>",
"reason": "<p><code>field</code> will be removed.</p>",
"date": "2019-10-01",
"criticality": "breaking",
"owner": "dinahshi"
}
],
"2019-04-01": [
{
"location": "Migration.uploadUrlTemplate",
"description": "<p><code>uploadUrlTemplate</code> will be removed. Use <code>uploadUrl</code> instead.</p>",
"reason": "<p><code>uploadUrlTemplate</code> is being removed because it is not a standard URL and adds an extra user step.</p>",
"date": "2019-04-01",
"criticality": "breaking",
"owner": "tambling"
}
]
},
"ghae": {
"2021-10-01": [
{

39
lib/liquid-tags/README.md
View File

@@ -5,7 +5,6 @@ See also [contributing/liquid-helpers.md](../../contributing/liquid-helpers.md)
This directory contains custom Liquid tags for outputting dynamic content. These custom tags exist for a few reasons:
- Content and styling should be separated. Writers should not be concerned with writing or maintaining stylistic markup.
- Writers should be able to create links by specifying the minimum amount of identifying information (an article href) and leave it to the site to dynamically inject that page's metadata like `title`, `intro`, etc.
- Content should be localized to match the current language.
- Styling and markup should be DRY and reusable.
@@ -19,49 +18,13 @@ Tags can be used in:
Tags always expect a single argument, a language agnostic href:
```html
{% link_with_intro /getting-started-with-github-desktop %}
{% data variables.product.product_name %}
```
where the reference must be in the parent file, `content/desktop/index.md`, as it points to `content/desktop/getting-started-with-github-desktop`.
The href can also be an absolute path:
```html
{% link_with_intro /desktop/getting-started-with-github-desktop %}
```
where the reference can be in any file.
**Note:** Every href, whether relative or absolute, must start with a slash (`/`). Do not include `content` in the href.
The tag above will output this HTML for English pages:
```html
<a class="link-with-intro Bump-link--hover no-underline" href="/en/desktop/getting-started-with-github-desktop">
<h4 class="link-with-intro-title">Getting started with GitHub Desktop<span class="Bump-link-symbol">→</span></h4>
</a>
<p class="link-with-intro-intro">Get GitHub Desktop set up to manage your project work. Authenticate to GitHub.com or GitHub Enterprise Server, keep the app up-to-date, and review your preferred settings.</p>
```
and this HTML for Spanish pages:
```html
<a class="link-with-intro Bump-link--hover no-underline" href="/es/desktop/getting-started-with-github-desktop">
<h4 class="link-with-intro-title">Comenzar con GitHub Desktop<span class="Bump-link-symbol">→</span></h4></a>
<p class="link-with-intro-intro">Configura GitHub Desktop para administrar tu proyecto de trabajo. Autentícate en GitHub.com o en el Servidor de GitHub Enterprise, mantén la app actualizada y revisa tu configuración preferida.</p>
```
Note that link tags will only render links that are available in the current page version (i.e. GitHub.com vs Enterprise), so it's not necessary to add Liquid conditionals around them.
## Supported tags
| Markup | Renders |
| -- | -- |
| `{% link /href %}` | The linked page's title, with no special styling.
| `{% link_with_intro /href %}` | The linked page's title and intro.
| `{% homepage_link_with_intro /href %}` | The linked page's title and intro, with homepage-specific styling.
| `{% link_in_list /href %}` | The linked page's title in a list item.
| `{% topic_link_in_list /href %}` | The linked map topic's title in a list item (used in category TOCs).
| `{% indented_data_reference foo.bar spaces=NUMBER %}` | A data reference with the specified number of spaces prepended to each line. Defaults to 2 spaces if no spaces included. For example: `{% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %}`
## Creating tags

3
lib/liquid-tags/homepage-link-with-intro.js
View File

@@ -1,3 +0,0 @@
import link from './link.js'
// For details, see class method in lib/liquid-tags/link.js
export default link('homepage-link-with-intro')

16
lib/liquid-tags/link-as-article-card.js
View File

@@ -1,16 +0,0 @@
import link from './link.js'
const linkAsArticleCard = link('link-as-article-card')
// For details, see class method in lib/liquid-tags/link.js
linkAsArticleCard.renderPageProps = async function renderPageProps(page, ctx, props) {
const renderedProps = await link().renderPageProps(page, ctx, props)
const { type: typeKey, topics = [] } = page
const typeVal = typeKey ? ctx.site.data.ui.product_sublanding.guide_types[typeKey] : null
return {
...renderedProps,
type: { key: typeKey, value: typeVal },
topics,
}
}
export default linkAsArticleCard

2
lib/liquid-tags/link-in-list.js
View File

@@ -1,2 +0,0 @@
import link from './link.js'
export default link('link-in-list')

3
lib/liquid-tags/link-with-intro.js
View File

@@ -1,3 +0,0 @@
import link from './link.js'
// For details, see class method in lib/liquid-tags/link.js
export default link('link-with-intro')

113
lib/liquid-tags/link.js
View File

@@ -1,113 +0,0 @@
import { fileURLToPath } from 'url'
import path from 'path'
import assert from 'assert'
import readFileAsync from '../readfile-async.js'
import findPage from '../find-page.js'
import { getPathWithoutLanguage, getPathWithoutVersion } from '../path-utils.js'
import getApplicableVersions from '../get-applicable-versions.js'
import removeFPTFromPath from '../remove-fpt-from-path.js'
const __dirname = path.dirname(fileURLToPath(import.meta.url))
const liquidVariableSyntax = /^{{\s*(.*)\s*}}/
// This class supports a set of link tags. Each tag expects one parameter, a language-agnostic href:
//
// {% link /articles/set-up-git %}
//
// {% link_in_list /articles/set-up-git %}
//
// {% link_with_intro /articles/set-up-git %}
//
// {% homepage_link_with_intro /articles/set-up-git %}
//
// Each tag renders a link to the given article using the article's `title`
// frontmatter data. The href and title are all dynamic based on the
// current language (English, Japanese, etc..)
//
// Liquid Docs: https://github.com/liquid-lang/liquid-node#registering-new-tags
export default (name) => ({
parse(tagToken) {
this.param = tagToken.args.trim()
},
async getTemplate() {
const pathToTemplate = path.join(__dirname, '../../includes/liquid-tags', `${name}.html`)
const template = await readFileAsync(pathToTemplate, 'utf8')
return template.replace(/\r/g, '')
},
async renderPageProps(page, ctx, props) {
const renderedProps = {}
for (const propName in props) {
const { opt } = props[propName] || {}
renderedProps[propName] = await page.renderProp(propName, ctx, opt)
}
return renderedProps
},
async render(scope) {
const template = await this.getTemplate()
const ctx = scope.environments
assert(ctx.page, 'context.page is required')
assert(ctx.page.relativePath, 'context.page.relativePath is required')
assert(ctx.pages, 'context.pages is required')
assert(ctx.currentLanguage, 'context.currentLanguage is required')
// process any liquid in hrefs (e.g., /enterprise/{{ page.version }})
let href = await this.liquid.parseAndRender(this.param, ctx)
if (href === '') {
const match = liquidVariableSyntax.exec(this.param)
if (match) {
href = await this.liquid.evalValue(match[1], scope)
}
}
let fullPath = href
const dirName = path.dirname(ctx.page.relativePath)
// if href contains one slash, assume it's a relative path and infer the full path
// example: /site-policy (linked to from /github/index.md)
// becomes: /github/site-policy
// otherwise, assume it's already a full path and needs nothing further
const hrefMatch = href.match(/\//g)
if (hrefMatch && hrefMatch.length < 2) {
fullPath = path.join(dirName, href)
}
// add language code and version
fullPath = removeFPTFromPath(
path.posix.join(
'/',
ctx.currentLanguage,
ctx.currentVersion,
getPathWithoutLanguage(getPathWithoutVersion(fullPath))
)
)
// find the page based on the full path
const page = findPage(fullPath, ctx.pages, ctx.redirects)
// return an empty string if it's a hidden link on a non-hidden page (hidden links on hidden pages are OK)
if (!page || (page.hidden && !ctx.page.hidden)) {
return ''
}
// also return early if the found page should not render in current version
if (!getApplicableVersions(page.versions).includes(ctx.currentVersion)) {
return ''
}
// find and render the props
const renderedProps = await this.renderPageProps(page, ctx, {
title: { opt: { textOnly: true, encodeEntities: true } },
intro: { opt: { unwrap: true } },
})
const parsed = await this.liquid.parseAndRender(template, { fullPath, ...renderedProps })
return parsed.trim()
},
})

2
lib/liquid-tags/topic-link-in-list.js
View File

@@ -1,2 +0,0 @@
import link from './link.js'
export default link('topic-link-in-list')

2
lib/patterns.js
View File

@@ -29,7 +29,7 @@ export const dataReference = /{% ?data\s(?:early-access\.)?(?:reusables|variable
export const imagePath = /\/?assets\/images\/.*?\.(png|svg|gif|pdf|ico|jpg|jpeg)/gi
export const homepagePath = /^\/\w{2}$/ // /en, /ja /cn
export const multipleSlashes = /^\/{2,}/
export const assetPaths = /\/(?:javascripts|stylesheets|assets|node_modules|dist)\//
export const assetPaths = /\/(?:javascripts|stylesheets|assets|node_modules|dist|_next)\//
export const oldApiPath = /\/v[34]\/(?!guides|overview).+?\/.+/
export const staticRedirect = /<link rel="canonical" href="(.+?)">/
export const enterpriseNoVersion = /\/enterprise\/([^\d].*$)/

11
lib/render-content/index.js
View File

@@ -1,25 +1,14 @@
import GithubSlugger from 'github-slugger'
import renderContent from './renderContent.js'
import { ExtendedMarkdown, tags } from '../liquid-tags/extended-markdown.js'
import Link from '../liquid-tags/link.js'
import LinkWithIntro from '../liquid-tags/link-with-intro.js'
import LinkInList from '../liquid-tags/link-in-list.js'
import TopicLinkInList from '../liquid-tags/topic-link-in-list.js'
import IndentedDataReference from '../liquid-tags/indented-data-reference.js'
import Data from '../liquid-tags/data.js'
import Octicon from '../liquid-tags/octicon.js'
import LinkAsArticleCard from '../liquid-tags/link-as-article-card.js'
import Ifversion from '../liquid-tags/ifversion.js'
// Include custom tags like {% link_with_intro /article/foo %}
renderContent.liquid.registerTag('link', Link('link'))
renderContent.liquid.registerTag('link_with_intro', LinkWithIntro)
renderContent.liquid.registerTag('link_in_list', LinkInList)
renderContent.liquid.registerTag('topic_link_in_list', TopicLinkInList)
renderContent.liquid.registerTag('indented_data_reference', IndentedDataReference)
renderContent.liquid.registerTag('data', Data)
renderContent.liquid.registerTag('octicon', Octicon)
renderContent.liquid.registerTag('link_as_article_card', LinkAsArticleCard)
renderContent.liquid.registerTag('ifversion', Ifversion)
for (const tag in tags) {

299
lib/rest/static/decorated/api.github.com.json
View File

@@ -3139,79 +3139,6 @@
}
]
},
{
"verb": "delete",
"requestPath": "/applications/{client_id}/grants/{access_token}",
"serverUrl": "https://api.github.com",
"parameters": [
{
"name": "client_id",
"in": "path",
"required": true,
"description": "The client ID of your GitHub app.",
"schema": {
"type": "string"
},
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
},
{
"name": "access_token",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('DELETE /applications/{client_id}/grants/{access_token}', {\n client_id: 'client_id',\n access_token: 'access_token'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /applications/{client_id}/grants/{access_token}'</span>, {\n <span class=\"hljs-attr\">client_id</span>: <span class=\"hljs-string\">'client_id'</span>,\n <span class=\"hljs-attr\">access_token</span>: <span class=\"hljs-string\">'access_token'</span>\n})\n</code></pre>"
}
],
"summary": "Revoke a grant for an application",
"description": "**Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub](https://github.com/settings/applications#authorized).",
"tags": [
"apps"
],
"operationId": "apps/revoke-grant-for-application",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/apps#revoke-a-grant-for-an-application"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"previews": [],
"removalDate": "2021-05-05",
"deprecationDate": "2020-02-14",
"category": "apps",
"subcategory": "oauth-applications"
},
"deprecated": true,
"slug": "revoke-a-grant-for-an-application",
"category": "apps",
"categoryLabel": "Apps",
"subcategory": "oauth-applications",
"subcategoryLabel": "Oauth applications",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use <a href=\"https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. You must also provide a valid token as <code>:access_token</code> and the grant for the token's owner will be deleted.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on <a href=\"https://github.com/settings/applications#authorized\">the Applications settings page under \"Authorized OAuth Apps\" on GitHub</a>.</p>"
},
{
"verb": "post",
"requestPath": "/applications/{client_id}/token",
@@ -5396,232 +5323,6 @@
}
]
},
{
"verb": "get",
"requestPath": "/applications/{client_id}/tokens/{access_token}",
"serverUrl": "https://api.github.com",
"parameters": [
{
"name": "client_id",
"in": "path",
"required": true,
"description": "The client ID of your GitHub app.",
"schema": {
"type": "string"
},
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
},
{
"name": "access_token",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /applications/{client_id}/tokens/{access_token}', {\n client_id: 'client_id',\n access_token: 'access_token'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /applications/{client_id}/tokens/{access_token}'</span>, {\n <span class=\"hljs-attr\">client_id</span>: <span class=\"hljs-string\">'client_id'</span>,\n <span class=\"hljs-attr\">access_token</span>: <span class=\"hljs-string\">'access_token'</span>\n})\n</code></pre>"
}
],
"summary": "Check an authorization",
"description": "**Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"tags": [
"apps"
],
"operationId": "apps/check-authorization",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/apps#check-an-authorization"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"previews": [],
"removalDate": "2021-05-05",
"deprecationDate": "2020-02-14",
"category": "apps",
"subcategory": "oauth-applications"
},
"deprecated": true,
"slug": "check-an-authorization",
"category": "apps",
"categoryLabel": "Apps",
"subcategory": "oauth-applications",
"subcategoryLabel": "Oauth applications",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use <a href=\"https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Response",
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/authorizations/1\"</span>,\n <span class=\"hljs-attr\">\"scopes\"</span>: [\n <span class=\"hljs-string\">\"public_repo\"</span>,\n <span class=\"hljs-string\">\"user\"</span>\n ],\n <span class=\"hljs-attr\">\"token\"</span>: <span class=\"hljs-string\">\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\"</span>,\n <span class=\"hljs-attr\">\"token_last_eight\"</span>: <span class=\"hljs-string\">\"Ae178B4a\"</span>,\n <span class=\"hljs-attr\">\"hashed_token\"</span>: <span class=\"hljs-string\">\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\"</span>,\n <span class=\"hljs-attr\">\"app\"</span>: {\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"http://my-github-app.com\"</span>,\n <span class=\"hljs-attr\">\"name\"</span>: <span class=\"hljs-string\">\"my github app\"</span>,\n <span class=\"hljs-attr\">\"client_id\"</span>: <span class=\"hljs-string\">\"abcde12345fghij67890\"</span>\n },\n <span class=\"hljs-attr\">\"note\"</span>: <span class=\"hljs-string\">\"optional note\"</span>,\n <span class=\"hljs-attr\">\"note_url\"</span>: <span class=\"hljs-string\">\"http://optional/note/url\"</span>,\n <span class=\"hljs-attr\">\"updated_at\"</span>: <span class=\"hljs-string\">\"2011-09-06T20:39:23Z\"</span>,\n <span class=\"hljs-attr\">\"created_at\"</span>: <span class=\"hljs-string\">\"2011-09-06T17:26:27Z\"</span>,\n <span class=\"hljs-attr\">\"fingerprint\"</span>: <span class=\"hljs-string\">\"jklmnop12345678\"</span>,\n <span class=\"hljs-attr\">\"user\"</span>: {\n <span class=\"hljs-attr\">\"login\"</span>: <span class=\"hljs-string\">\"octocat\"</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"node_id\"</span>: <span class=\"hljs-string\">\"MDQ6VXNlcjE=\"</span>,\n <span class=\"hljs-attr\">\"avatar_url\"</span>: <span class=\"hljs-string\">\"https://github.com/images/error/octocat_happy.gif\"</span>,\n <span class=\"hljs-attr\">\"gravatar_id\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat\"</span>,\n <span class=\"hljs-attr\">\"html_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"followers_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/followers\"</span>,\n <span class=\"hljs-attr\">\"following_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/following{/other_user}\"</span>,\n <span class=\"hljs-attr\">\"gists_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/gists{/gist_id}\"</span>,\n <span class=\"hljs-attr\">\"starred_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"</span>,\n <span class=\"hljs-attr\">\"subscriptions_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/subscriptions\"</span>,\n <span class=\"hljs-attr\">\"organizations_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/orgs\"</span>,\n <span class=\"hljs-attr\">\"repos_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/repos\"</span>,\n <span class=\"hljs-attr\">\"events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/events{/privacy}\"</span>,\n <span class=\"hljs-attr\">\"received_events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/received_events\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"User\"</span>,\n <span class=\"hljs-attr\">\"site_admin\"</span>: <span class=\"hljs-literal\">false</span>\n }\n}\n</code></pre>"
},
{
"httpStatusCode": "404",
"httpStatusMessage": "Not Found",
"description": "Resource not found"
}
]
},
{
"verb": "post",
"requestPath": "/applications/{client_id}/tokens/{access_token}",
"serverUrl": "https://api.github.com",
"parameters": [
{
"name": "client_id",
"in": "path",
"required": true,
"description": "The client ID of your GitHub app.",
"schema": {
"type": "string"
},
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
},
{
"name": "access_token",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('POST /applications/{client_id}/tokens/{access_token}', {\n client_id: 'client_id',\n access_token: 'access_token'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /applications/{client_id}/tokens/{access_token}'</span>, {\n <span class=\"hljs-attr\">client_id</span>: <span class=\"hljs-string\">'client_id'</span>,\n <span class=\"hljs-attr\">access_token</span>: <span class=\"hljs-string\">'access_token'</span>\n})\n</code></pre>"
}
],
"summary": "Reset an authorization",
"description": "**Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"tags": [
"apps"
],
"operationId": "apps/reset-authorization",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/apps#reset-an-authorization"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"previews": [],
"removalDate": "2021-05-05",
"deprecationDate": "2020-02-14",
"category": "apps",
"subcategory": "oauth-applications"
},
"deprecated": true,
"slug": "reset-an-authorization",
"category": "apps",
"categoryLabel": "Apps",
"subcategory": "oauth-applications",
"subcategoryLabel": "Oauth applications",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use <a href=\"https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Response",
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/authorizations/1\"</span>,\n <span class=\"hljs-attr\">\"scopes\"</span>: [\n <span class=\"hljs-string\">\"public_repo\"</span>,\n <span class=\"hljs-string\">\"user\"</span>\n ],\n <span class=\"hljs-attr\">\"token\"</span>: <span class=\"hljs-string\">\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\"</span>,\n <span class=\"hljs-attr\">\"token_last_eight\"</span>: <span class=\"hljs-string\">\"Ae178B4a\"</span>,\n <span class=\"hljs-attr\">\"hashed_token\"</span>: <span class=\"hljs-string\">\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\"</span>,\n <span class=\"hljs-attr\">\"app\"</span>: {\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"http://my-github-app.com\"</span>,\n <span class=\"hljs-attr\">\"name\"</span>: <span class=\"hljs-string\">\"my github app\"</span>,\n <span class=\"hljs-attr\">\"client_id\"</span>: <span class=\"hljs-string\">\"abcde12345fghij67890\"</span>\n },\n <span class=\"hljs-attr\">\"note\"</span>: <span class=\"hljs-string\">\"optional note\"</span>,\n <span class=\"hljs-attr\">\"note_url\"</span>: <span class=\"hljs-string\">\"http://optional/note/url\"</span>,\n <span class=\"hljs-attr\">\"updated_at\"</span>: <span class=\"hljs-string\">\"2011-09-06T20:39:23Z\"</span>,\n <span class=\"hljs-attr\">\"created_at\"</span>: <span class=\"hljs-string\">\"2011-09-06T17:26:27Z\"</span>,\n <span class=\"hljs-attr\">\"fingerprint\"</span>: <span class=\"hljs-string\">\"jklmnop12345678\"</span>,\n <span class=\"hljs-attr\">\"user\"</span>: {\n <span class=\"hljs-attr\">\"login\"</span>: <span class=\"hljs-string\">\"octocat\"</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"node_id\"</span>: <span class=\"hljs-string\">\"MDQ6VXNlcjE=\"</span>,\n <span class=\"hljs-attr\">\"avatar_url\"</span>: <span class=\"hljs-string\">\"https://github.com/images/error/octocat_happy.gif\"</span>,\n <span class=\"hljs-attr\">\"gravatar_id\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat\"</span>,\n <span class=\"hljs-attr\">\"html_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"followers_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/followers\"</span>,\n <span class=\"hljs-attr\">\"following_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/following{/other_user}\"</span>,\n <span class=\"hljs-attr\">\"gists_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/gists{/gist_id}\"</span>,\n <span class=\"hljs-attr\">\"starred_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"</span>,\n <span class=\"hljs-attr\">\"subscriptions_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/subscriptions\"</span>,\n <span class=\"hljs-attr\">\"organizations_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/orgs\"</span>,\n <span class=\"hljs-attr\">\"repos_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/repos\"</span>,\n <span class=\"hljs-attr\">\"events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/events{/privacy}\"</span>,\n <span class=\"hljs-attr\">\"received_events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/received_events\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"User\"</span>,\n <span class=\"hljs-attr\">\"site_admin\"</span>: <span class=\"hljs-literal\">false</span>\n }\n}\n</code></pre>"
}
]
},
{
"verb": "delete",
"requestPath": "/applications/{client_id}/tokens/{access_token}",
"serverUrl": "https://api.github.com",
"parameters": [
{
"name": "client_id",
"in": "path",
"required": true,
"description": "The client ID of your GitHub app.",
"schema": {
"type": "string"
},
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
},
{
"name": "access_token",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('DELETE /applications/{client_id}/tokens/{access_token}', {\n client_id: 'client_id',\n access_token: 'access_token'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /applications/{client_id}/tokens/{access_token}'</span>, {\n <span class=\"hljs-attr\">client_id</span>: <span class=\"hljs-string\">'client_id'</span>,\n <span class=\"hljs-attr\">access_token</span>: <span class=\"hljs-string\">'access_token'</span>\n})\n</code></pre>"
}
],
"summary": "Revoke an authorization for an application",
"description": "**Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.",
"tags": [
"apps"
],
"operationId": "apps/revoke-authorization-for-application",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/apps#revoke-an-authorization-for-an-application"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"previews": [],
"removalDate": "2021-05-05",
"deprecationDate": "2020-02-14",
"category": "apps",
"subcategory": "oauth-applications"
},
"deprecated": true,
"slug": "revoke-an-authorization-for-an-application",
"category": "apps",
"categoryLabel": "Apps",
"subcategory": "oauth-applications",
"subcategoryLabel": "Oauth applications",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth application owners can revoke a single token for an OAuth application. You must use <a href=\"https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password.</p>"
},
{
"verb": "get",
"requestPath": "/apps/{app_slug}",

1611
lib/rest/static/dereferenced/api.github.com.deref.json
View File

File diff suppressed because it is too large Load Diff

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:185db3a69d22262339b3aa8f077f114d63a1affaafb55b2d8ae990165dd519ed
size 445068
oid sha256:3f63c67c3dcedbb36a55d6430e2cb4ef03b30189697a0d61c43c0b7aa7697dba
size 444929

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:f08addf313e1758ee5c7ef60ad047f2384282e4e8f7bb9d53ad9069bba3e5fcf
size 868882
oid sha256:b35a032b4d7dfee92213d6ee9174b56f181ce42050ba12179edb10fc4be88724
size 868844

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:117031c69395da87eb8cad33ac7eff5bd305de43934cf538eb6b5d50e5769679
size 433821
oid sha256:50e9b36241ae6a9ac0a93b879881f60167f7e80c63a0b7f40f6c6728b9dbcf59
size 434150

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:74f089359a9d9fe371d95a358e0108c5b13e3498d1c67c50764400bd35cb21cf
size 1952488
oid sha256:5e12ad2533531331234f3843bd4526f11191eef092421342b6fa9f9024148ae5
size 1952781

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:09f162c97583aeb0e2c1e34f942729d3add6d358ba4da3098d656bfa3a686839
size 562301
oid sha256:5a3fbdd1bd6a3cc808e1bae34deff9209dae4033dd01a9be481ab897921cb431
size 562872

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:04d0d75481fbaa5b4b401aaee2eaf9e9c882c885bb8e85eab3748bb537e241de
size 2731561
oid sha256:e8333a2d81ad559302ca66b39a8cba61e034b8296c0e52aa135bdd183de267c1
size 2732968

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:3659cb443bb3e3cec55c26709d0e8d0ed76fc47e08b532aabf75303bdc0c2970
size 318559
oid sha256:1e3b8590d21462950bfef28af3ab833473911c4ad6da1631b2eaaee44fc6e291
size 318403

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:ee0e2a2e168637892be0005614e57a38765ef135a4d287bba3b0bc565fd074b7
size 1306856
oid sha256:08f07adf4df1092952a4e704b9e089074d328c72b203f889265f9294700445ac
size 1305863

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:64ea917b07d6a09166b499559fab5dafe938e8f22198298d1ff99eb4de973086
size 467848
oid sha256:49bf376a02132a148f3986ac696bb78e74450b01811803d35c26c7cce3637b14
size 467465

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:767ee6f66f37cbe5c463c762a07c6b9df213d59a91d9cb76beba13eb09baf43d
size 2641589
oid sha256:3fa51df5c65e82045052d4128b7dcf6b2fa2e12a1b703cdc8d5da9a6a7360763
size 2639422

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:50d976f78633d9bd72eca39dd9446512fe5446e5281ba22cd6b0556aa8aeb6c8
size 414069
oid sha256:9d0f57ba80cdad8a846dd446e9c5ac26a13d55b4eaaea10d70f7bec2fa5ed4da
size 414075

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:8efe5f8a3cd298c91fb08564e498e9cc588ebc9dc87738402f9d2dc7b2275656
size 1782196
oid sha256:f6783f4b2fa4d674005962ca74d4cb84f01b80f87a6ad135cb7c56bd94d78735
size 1782660

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:e10a2f0c988546fe04096d7403d9fafc2264de550f3776152ff2343fe074b9df
size 572311
oid sha256:5d570dd2eb20adf65b5b9e08aac77975222543db4c8ed2e61cd7fef2a602a0be
size 571155

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:f24a7288313054472bd1b7e45b3e8d5f45f0165deb2f4c3684f709ddeb417ade
size 1083605
oid sha256:b4bce86affaebecb64e51b041a3bbfc44101d4884449448b290efbcf02a75d2f
size 1082384

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:9dd3cea3f576064887932adbe16820e56166c3864b967e9c7a86a7437b257692
size 533496
oid sha256:56c358b115be6554d05e4f811a5e30d2c27227badc383e5687cddb1c4473a980
size 532826

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:fc7ff433541b5049ae3aa8d4569958f8e3eff9564ef76378d98a5d594025fa73
size 2462010
oid sha256:a3e0bd1025af57ef7e0ab5b4c647950cbc5ee249d00d904246e08390869ca920
size 2459815

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:ca8ed458d807872739b4c219f7e1b45b0c231a2e714b7259ae317f5cd2f56d69
size 742540
oid sha256:50ab2b94c612070b37f148efd309658f14a0e50d2e9e1d07e839f84a62cbf837
size 742903

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:070d61f2c562023f34a8afddb810109063f486ad65c838744b4dd32bd63e23e0
size 3632905
oid sha256:8838043e615720dd25eff04ea3556885fc88928b12962681a3693120c706f7eb
size 3631627

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:460bd603b3315e652202b238d980c0df8c183e6856e911caffb5b28cb079e36d
size 344144
oid sha256:7b36da396baab10873da7420395459307f72aa28c80a8af733f43b4930b09273
size 344091

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:ac4964f3842ab106d49d8eed8de7b9eb75dae7e0ed02db707fd5b1f749b5b0a6
size 1418110
oid sha256:f3c3632ff08e650a11417d6ea77f45574328974043da3250a20c98ad9b0884a2
size 1418992

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:02ea609abef2fbfce5e4406d7e6db8ff3383320a38f04d5c865bdd8b3b34e7ed
size 594647
oid sha256:2e7fcddfb316b9b10a223a60855e7b5ec0580956b48a03aa769add938f6351a6
size 594811

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:ab64dd52eb6dbedc0b0b1d598e97b73efa12c5fdc406b7699db436c9cc4239ab
size 3329123
oid sha256:a1418ee03726d02e9f838bce9f584ad868597b53589614f922374c840a372bd4
size 3329850

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:4366551cc347b104373ea5d6b94b6eaf0c99909b9256642a7d56ad2cce588af1
size 507986
oid sha256:8ebf2702bae4c02c8e49410ea0887fe81df05fdc8950e1071601a54a67fbbc9d
size 508097

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:3d44a88e19b8110d11ba9814eea3731ffa41c31bc48bd8736fea5800c2822191
size 2216516
oid sha256:c76ef591835c3c6d2e378a3b5acc474bc2a53f965aa4386596104349496b3f7b
size 2216834

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:829f1213716a8402dc8ef6052088703bb63ef3e28710fdc4e55b61f4f4cdeb54
size 589274
oid sha256:32bdc3bf852e7e0f4942be181344ba2d36209226a4a8db50f96cd07eb8ba3210
size 589947

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:d2ba87491740fc0c570a7e4f4460605d3cc3663f492a1ad0ea15611278ffc443
size 1119352
oid sha256:db8cb4ce881cadd73f6d79cf6532256f0522d4964e9761207be0fb3d25b13878
size 1120345

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:52cc6f99c4e7e87bd1ec24f8172a037b64a9cf97ca47c58bb4ce8821d12a8a07
size 554570
oid sha256:26f60fc8730afa41feb612de95866da400ce9d256b2966163a75cf0a980e886f
size 554362

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

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:380014040bea00993567e45e12006c6027d92c4c5733ee51f5569b72c19fe4fd
size 2567279
oid sha256:1517aa818f6a74c0d24811142e0a448061c13d656358e3a6bc95adf33e27d691
size 2567576

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