diff --git a/.github/workflows/confirm-internal-staff-work-in-docs.yml b/.github/workflows/confirm-internal-staff-work-in-docs.yml index 76406163c4..cf10eacc96 100644 --- a/.github/workflows/confirm-internal-staff-work-in-docs.yml +++ b/.github/workflows/confirm-internal-staff-work-in-docs.yml @@ -61,7 +61,7 @@ jobs: owner: 'github', repo: 'docs-internal', title: `@${context.payload.sender.login} confirm that \#${issueNo} should be in the public github/docs repo`, - body: `@${context.payload.sender.login} opened https://github.com/github/docs/issues/${issueNo} publicly in the github/docs repo, instead of the private github/docs-internal repo.\n\n@${context.payload.sender.login}, please confirm that this belongs in the public repo and that no sensitive information was disclosed by commenting below and closing the issue.\n\nIf this was not intentional and sensitive information was shared, please delete https://github.com/github/docs/issues/${issueNo} and notify us in the \#docs-open-source channel.\n\nThanks! \n\n/cc @github/docs @github/docs-engineering`, + body: `@${context.payload.sender.login} opened https://github.com/github/docs/issues/${issueNo} publicly in the github/docs repo, instead of the private github/docs-internal repo.\n\n@${context.payload.sender.login}, please confirm that this belongs in the public repo and that no sensitive information was disclosed by commenting below and closing the issue.\n\nIf this was not intentional and sensitive information was shared, please delete https://github.com/github/docs/issues/${issueNo} and notify us in the \#docs-open-source channel.\n\nThanks!`, labels: ['OS confirmation'], }); diff --git a/assets/images/enterprise/github-ae/settings/access-token-scopes-for-ghae.png b/assets/images/enterprise/github-ae/settings/access-token-scopes-for-ghae.png index cc5e7a3d80..6d44a12268 100644 Binary files a/assets/images/enterprise/github-ae/settings/access-token-scopes-for-ghae.png and b/assets/images/enterprise/github-ae/settings/access-token-scopes-for-ghae.png differ diff --git a/assets/images/help/settings/password_recovery_page.png b/assets/images/enterprise/settings/password-recovery-page.png similarity index 100% rename from assets/images/help/settings/password_recovery_page.png rename to assets/images/enterprise/settings/password-recovery-page.png diff --git a/assets/images/help/2fa/2fa-password-reset.png b/assets/images/help/2fa/2fa-password-reset.png new file mode 100644 index 0000000000..72b82bb4ae Binary files /dev/null and b/assets/images/help/2fa/2fa-password-reset.png differ diff --git a/assets/images/help/repository/code-scanning-free-text-search-areas.png b/assets/images/help/repository/code-scanning-free-text-search-areas.png new file mode 100644 index 0000000000..0799feb0a8 Binary files /dev/null and b/assets/images/help/repository/code-scanning-free-text-search-areas.png differ diff --git a/assets/images/help/repository/code-scanning-search-alerts.png b/assets/images/help/repository/code-scanning-search-alerts.png new file mode 100644 index 0000000000..e274f632dd Binary files /dev/null and b/assets/images/help/repository/code-scanning-search-alerts.png differ diff --git a/assets/images/help/settings/password-recovery-email-request.png b/assets/images/help/settings/password-recovery-email-request.png index 557ef8364a..46d2a79f9f 100644 Binary files a/assets/images/help/settings/password-recovery-email-request.png and b/assets/images/help/settings/password-recovery-email-request.png differ diff --git a/assets/images/help/settings/password-recovery-page.png b/assets/images/help/settings/password-recovery-page.png new file mode 100644 index 0000000000..db5d73182d Binary files /dev/null and b/assets/images/help/settings/password-recovery-page.png differ diff --git a/assets/images/help/sponsors/access-github-sponsors-dashboard.png b/assets/images/help/sponsors/access-github-sponsors-dashboard.png index a7744e73f7..6ba167ecad 100644 Binary files a/assets/images/help/sponsors/access-github-sponsors-dashboard.png and b/assets/images/help/sponsors/access-github-sponsors-dashboard.png differ diff --git a/assets/images/help/sponsors/draft-tier-edit.png b/assets/images/help/sponsors/draft-tier-edit.png new file mode 100644 index 0000000000..0bfec63a49 Binary files /dev/null and b/assets/images/help/sponsors/draft-tier-edit.png differ diff --git a/assets/images/help/sponsors/recommended-rewards.png b/assets/images/help/sponsors/recommended-rewards.png new file mode 100644 index 0000000000..8decf45038 Binary files /dev/null and b/assets/images/help/sponsors/recommended-rewards.png differ diff --git a/assets/images/help/sponsors/tier-editor-button.png b/assets/images/help/sponsors/tier-editor-button.png new file mode 100644 index 0000000000..1bed58ebdf Binary files /dev/null and b/assets/images/help/sponsors/tier-editor-button.png differ diff --git a/assets/images/help/stars/starring-a-repository.png b/assets/images/help/stars/starring-a-repository.png new file mode 100644 index 0000000000..017148bce9 Binary files /dev/null and b/assets/images/help/stars/starring-a-repository.png differ diff --git a/assets/images/help/stars/stars_filter_topic.png b/assets/images/help/stars/stars_filter_topic.png new file mode 100644 index 0000000000..8902c08c46 Binary files /dev/null and b/assets/images/help/stars/stars_filter_topic.png differ diff --git a/assets/images/help/stars/unstarring-a-repository.png b/assets/images/help/stars/unstarring-a-repository.png new file mode 100644 index 0000000000..16750ad043 Binary files /dev/null and b/assets/images/help/stars/unstarring-a-repository.png differ diff --git a/components/DefaultLayout.tsx b/components/DefaultLayout.tsx index ba82925984..d740f93263 100644 --- a/components/DefaultLayout.tsx +++ b/components/DefaultLayout.tsx @@ -38,6 +38,7 @@ export const DefaultLayout = (props: Props) => { {page.languageVariants.map((languageVariant) => { return ( { ) : ( )} diff --git a/components/article/ArticleVersionPicker.tsx b/components/article/ArticleVersionPicker.tsx new file mode 100644 index 0000000000..0ab7bcc300 --- /dev/null +++ b/components/article/ArticleVersionPicker.tsx @@ -0,0 +1,58 @@ +import Link from 'next/link' +import { useRouter } from 'next/router' +import { Dropdown } from '@primer/components' + +import { useMainContext } from 'components/context/MainContext' +import { useVersion } from 'components/hooks/useVersion' +import { useTranslation } from 'components/hooks/useTranslation' + +export const ArticleVersionPicker = () => { + const router = useRouter() + const { currentVersion } = useVersion() + const { allVersions, page, enterpriseServerVersions } = useMainContext() + const { t } = useTranslation('pages') + + if (page.permalinks && page.permalinks.length <= 1) { + return null + } + + return ( +
+ + + {t('article_version')}{' '} + {allVersions[currentVersion].versionTitle} + + + + {(page.permalinks || []).map((permalink) => { + if (permalink.pageVersion === 'homepage') { + return null + } + + return ( + + + {permalink.pageVersionTitle} + + + ) + })} +
+ + + See all Enterprise releases + + +
+ + +
+ ) +} diff --git a/components/context/MainContext.tsx b/components/context/MainContext.tsx index 9cdc7f32e5..5b985162eb 100644 --- a/components/context/MainContext.tsx +++ b/components/context/MainContext.tsx @@ -141,7 +141,11 @@ export const getMainContextFromRequest = (req: any): MainContextT => { ), hidden: req.context.page.hidden || false, }, - enterpriseServerReleases: JSON.parse(JSON.stringify(req.context.enterpriseServerReleases)), + enterpriseServerReleases: pick(req.context.enterpriseServerReleases, [ + 'isOldestReleaseDeprecated', + 'oldestSupported', + 'nextDeprecationDate', + ]), enterpriseServerVersions: req.context.enterpriseServerVersions, currentLanguage: req.context.currentLanguage, languages: Object.fromEntries( @@ -158,12 +162,27 @@ export const getMainContextFromRequest = (req: any): MainContextT => { }) ), allVersions: req.context.allVersions, - // this gets rid of some `undefined` values, which is necessary so next.js can serialize the data - currentProductTree: JSON.parse(JSON.stringify(req.context.currentProductTree)), + currentProductTree: getCurrentProductTree(req.context.currentProductTree), featureFlags: {}, } } +// only pull things we need from the product tree, and make sure there are default values instead of `undefined` +const getCurrentProductTree = (input: any): CurrentProductTree => { + return { + href: input.href, + renderedShortTitle: input.renderedShortTitle || '', + renderedFullTitle: input.renderedFullTitle || '', + page: { + hidden: input.page.hidden || false, + documentType: input.page.documentType, + title: input.page.title, + shortTitle: input.page.shortTitle || '', + }, + childPages: (input.childPages || []).map(getCurrentProductTree), + } +} + export const MainContext = createContext(null) export const useMainContext = (): MainContextT => { diff --git a/components/context/ProductLandingContext.tsx b/components/context/ProductLandingContext.tsx index 17aac957d2..df9df83853 100644 --- a/components/context/ProductLandingContext.tsx +++ b/components/context/ProductLandingContext.tsx @@ -1,6 +1,11 @@ import { createContext, useContext } from 'react' import pick from 'lodash/pick' +export type TocItem = { + fullPath: string + title: string + intro?: string +} export type FeaturedLink = { title: string href: string @@ -28,19 +33,12 @@ export type ProductLandingContextT = { intro: string beta_product: boolean product: Product - // primaryAction: LinkButtonT - // secondaryAction?: LinkButtonT introLinks: { quickstart?: string reference?: string overview?: string - } + } | null product_video?: string - // featuredLinks?: { - // guides: Array - // popular: Array - // guideCards: Array - // } guideCards: Array productCodeExamples: Array productUserExamples: Array<{ username: string; description: string }> @@ -53,6 +51,7 @@ export type ProductLandingContextT = { changelog: { label: string; prefix: string } changelogUrl?: string whatsNewChangelog?: Array<{ href: string; title: string; date: string }> + tocItems: Array } export const ProductLandingContext = createContext(null) @@ -97,20 +96,26 @@ export const getProductLandingContextFromRequest = (req: any): ProductLandingCon }) ), - introLinks: { - quickstart: productTree.page.introLinks.quickstart, - reference: productTree.page.introLinks.reference, - overview: productTree.page.introLinks.overview, - }, + introLinks: productTree.page.introLinks + ? { + quickstart: productTree.page.introLinks.quickstart, + reference: productTree.page.introLinks.reference, + overview: productTree.page.introLinks.overview, + } + : null, - guideCards: (req.context.featuredLinks ? (req.context.featuredLinks.guideCards || []) : []).map((link: any) => { - return { - href: link.href, - title: link.title, - intro: link.intro, - authors: link.page.authors || [], + guideCards: (req.context.featuredLinks ? req.context.featuredLinks.guideCards || [] : []).map( + (link: any) => { + return { + href: link.href, + title: link.title, + intro: link.intro, + authors: link.page.authors || [], + } } - }), + ), + + tocItems: req.context.tocItems || [], featuredArticles: Object.entries(req.context.featuredLinks || []) .filter(([key]) => { @@ -119,7 +124,10 @@ export const getProductLandingContextFromRequest = (req: any): ProductLandingCon .map(([key, links]: any) => { return { label: req.context.site.data.ui.toc[key], - viewAllHref: key === 'guides' && !req.context.currentCategory ? `${req.context.currentPath}/${key}` : '', + viewAllHref: + key === 'guides' && !req.context.currentCategory + ? `${req.context.currentPath}/${key}` + : '', articles: links.map((link: any) => { return { hideIntro: key === 'popular', @@ -130,7 +138,6 @@ export const getProductLandingContextFromRequest = (req: any): ProductLandingCon } }), } - } - ), + }), } } diff --git a/components/landing/FeaturedArticles.tsx b/components/landing/FeaturedArticles.tsx index 7bee0321fe..8e8eca6109 100644 --- a/components/landing/FeaturedArticles.tsx +++ b/components/landing/FeaturedArticles.tsx @@ -21,7 +21,7 @@ export const FeaturedArticles = () => { {featuredArticles.map((section, i) => { return (
{
    - {articles.map((link) => { + {articles.map((link, i) => { return (
  • diff --git a/components/landing/ProductArticlesList.tsx b/components/landing/ProductArticlesList.tsx index 5ed708cf24..90f469dd9a 100644 --- a/components/landing/ProductArticlesList.tsx +++ b/components/landing/ProductArticlesList.tsx @@ -16,12 +16,12 @@ export const ProductArticlesList = () => { return (
    - {currentProductTree.childPages.map((childPage) => { + {currentProductTree.childPages.map((childPage, i) => { if (childPage.page.documentType === 'article') { return null } - return + return })}
    ) @@ -45,14 +45,18 @@ const ArticleList = ({ page }: { page: CurrentProductTree }) => { } return ( -
  • = maxArticles ? 'd-none' : null)}> +
  • = maxArticles ? 'd-none' : null)} + > {grandchildPage.page.title} {grandchildPage.page.documentType === 'mapTopic' ? ( - -  • {page.childPages.length} articles - ) : null} + +  • {page.childPages.length} articles + + ) : null}
    • ) })} diff --git a/components/landing/TableOfContents.tsx b/components/landing/TableOfContents.tsx new file mode 100644 index 0000000000..14f4f1514f --- /dev/null +++ b/components/landing/TableOfContents.tsx @@ -0,0 +1,34 @@ +import { useRouter } from 'next/router' +import Link from 'next/link' +import cx from 'classnames' + +import type { TocItem } from '../context/ProductLandingContext' + +export const TableOfContents = (props: { items?: Array }) => { + const router = useRouter() + + return ( +
    + {(props.items || []).map((obj) => { + if (!obj) { + return null + } + const { fullPath: href, title, intro } = obj + const isActive = router.pathname === href + return ( +
    + + +

    + {title} + → +

    +     + + {intro &&

    } +

    + ) + })} +
    + ) +} diff --git a/components/product/ProductSiteTree.tsx b/components/product/SidebarProduct.tsx similarity index 84% rename from components/product/ProductSiteTree.tsx rename to components/product/SidebarProduct.tsx index 499d4a755a..a4472a6a49 100644 --- a/components/product/ProductSiteTree.tsx +++ b/components/product/SidebarProduct.tsx @@ -11,7 +11,7 @@ import { AllProductsLink } from 'components/product/AllProductsLink' // hierarchy of the current page. If an item's URL is also the same as the current URL, the item // also gets an `is-current-page` class. // --> -export const ProductSiteTree = () => { +export const SidebarProduct = () => { const router = useRouter() const { currentProductTree: currentProductTree } = useMainContext() @@ -20,14 +20,16 @@ export const ProductSiteTree = () => { } const productTitle = currentProductTree.renderedShortTitle || currentProductTree.renderedFullTitle + const routePath = `/${router.locale}${router.asPath.split('?')[0]}` // remove query string return ( <> + {!currentProductTree.page.hidden && ( <>
  • - {productTitle} + {productTitle}
    • @@ -37,10 +39,11 @@ export const ProductSiteTree = () => { const isStandaloneCategory = childPage.page.documentType === 'article' const childTitle = childPage.renderedShortTitle || childPage.renderedFullTitle - const isActive = router.asPath.includes(childPage.href) - const isCurrent = router.asPath === childPage.href + const isActive = routePath.includes(childPage.href) + const isCurrent = routePath === childPage.href return (
  • { > {isStandaloneCategory ? ( - + {childTitle} ) : (
    - + {childTitle} @@ -87,19 +88,20 @@ export const ProductSiteTree = () => { )}
    - {router.asPath.includes(childPage.href) || i < 3 ? ( + {routePath.includes(childPage.href) || i < 3 ? ( <> {/* */} {childPage.childPages[0].page.documentType === 'mapTopic' ? (
      - {childPage.childPages.map((grandchildPage) => { + {childPage.childPages.map((grandchildPage, i) => { const grandchildTitle = grandchildPage.renderedShortTitle || grandchildPage.renderedFullTitle - const isActive = router.asPath.includes(grandchildPage.href) - const isCurrent = router.asPath === grandchildPage.href + const isActive = routePath.includes(grandchildPage.href) + const isCurrent = routePath === grandchildPage.href return (
    • { )} > - {grandchildTitle} + {grandchildTitle}
        {grandchildPage.childPages.map( @@ -116,13 +118,13 @@ export const ProductSiteTree = () => { greatgrandchildPage.renderedShortTitle || greatgrandchildPage.renderedFullTitle const isLast = i === arr.length - 1 - const isActive = router.asPath.includes( + const isActive = routePath.includes( greatgrandchildPage.href ) - const isCurrent = - router.asPath === greatgrandchildPage.href + const isCurrent = routePath === greatgrandchildPage.href return (
      • { @@ -156,10 +158,11 @@ export const ProductSiteTree = () => { grandchildPage.renderedShortTitle || grandchildPage.renderedFullTitle const isLast = i === arr.length - 1 - const isActive = router.asPath.includes(grandchildPage.href) - const isCurrent = router.asPath === grandchildPage.href + const isActive = routePath.includes(grandchildPage.href) + const isCurrent = routePath === grandchildPage.href return (
      • { )} > - + {grandchildTitle} diff --git a/content/actions/guides/building-and-testing-xamarin-applications.md b/content/actions/guides/building-and-testing-xamarin-applications.md index dc5108d731..5c1e54b208 100644 --- a/content/actions/guides/building-and-testing-xamarin-applications.md +++ b/content/actions/guides/building-and-testing-xamarin-applications.md @@ -24,7 +24,7 @@ topics: This guide shows you how to create a workflow that performs continuous integration (CI) for your Xamarin project. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. -{% data variables.product.prodname_actions %}-hosted macOS runner stores Xamarin SDK versions and the associated Mono versions as a set of symlinks to Xamarin SDK locations that are available by a single bundle symlink. For a full list of available Xamarin SDK versions and their corresponding bundles, see the runners documentation: +For a full list of available Xamarin SDK versions on the {% data variables.product.prodname_actions %}-hosted macOS runners, see the documentation: * [macOS 10.15](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-10.15-Readme.md#xamarin-bundles) * [macOS 11](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-11-Readme.md#xamarin-bundles) @@ -41,7 +41,7 @@ We recommend that you have a basic understanding of Xamarin, .NET Core SDK, YAML ### Bulding Xamarin.iOS apps -The example below demonstrates how to change the default Xamarin bundle and build a Xamarin.iOS application. +The example below demonstrates how to change the default Xamarin SDK versions and build a Xamarin.iOS application. {% raw %} ```yaml @@ -55,34 +55,33 @@ jobs: runs-on: macos-latest steps: - - uses: actions/checkout@v2 - - name: Select default Xamarin bundle to 6_12_6 - run: | - XAMARIN_SDK=6_12_6 - $VM_ASSETS/select-xamarin-sdk.sh $XAMARIN_SDK + - uses: actions/checkout@v2 + - name: Set default Xamarin SDK versions + run: | + $VM_ASSETS/select-xamarin-sdk-v2.sh --mono=6.12 --ios=14.10 + + - name: Set default Xcode 12.3 + run: | + XCODE_ROOT=/Applications/Xcode_12.3.0.app + echo "MD_APPLE_SDK_ROOT=$XCODE_ROOT" >> $GITHUB_ENV + sudo xcode-select -s $XCODE_ROOT - - name: Set default Xcode 12.3 - run: | - XCODE_ROOT=/Applications/Xcode_12.3.0.app - echo "MD_APPLE_SDK_ROOT=$XCODE_ROOT" >> $GITHUB_ENV - sudo xcode-select -s $XCODE_ROOT + - name: Setup .NET Core SDK 5.0.x + uses: actions/setup-dotnet@v1 + with: + dotnet-version: '5.0.x' - - name: Setup .NET Core SDK 5.0.x - uses: actions/setup-dotnet@v1 - with: - dotnet-version: '5.0.x' + - name: Install dependencies + run: nuget restore - - name: Install dependencies - run: nuget restore - - - name: Build - run: msbuild /p:Configuration=Debug /p:Platform=iPhoneSimulator /t:Rebuild + - name: Build + run: msbuild /p:Configuration=Debug /p:Platform=iPhoneSimulator /t:Rebuild ``` {% endraw %} ### Bulding Xamarin.Android apps -The example below demonstrates how to change default the Xamarin bundle and build a Xamarin.Android application. +The example below demonstrates how to change default Xamarin SDK versions and build a Xamarin.Android application. {% raw %} ```yaml @@ -96,22 +95,21 @@ jobs: runs-on: macos-latest steps: - - uses: actions/checkout@v2 - - name: Select default Xamarin bundle to 6_12_6 - run: | - XAMARIN_SDK=6_12_6 - $VM_ASSETS/select-xamarin-sdk.sh $XAMARIN_SDK + - uses: actions/checkout@v2 + - name: Set default Xamarin SDK versions + run: | + $VM_ASSETS/select-xamarin-sdk-v2.sh --mono=6.10 --android=10.2 - - name: Setup .NET Core SDK 5.0.x - uses: actions/setup-dotnet@v1 - with: - dotnet-version: '5.0.x' + - name: Setup .NET Core SDK 5.0.x + uses: actions/setup-dotnet@v1 + with: + dotnet-version: '5.0.x' - - name: Install dependencies - run: nuget restore + - name: Install dependencies + run: nuget restore - - name: Build - run: msbuild /t:PackageForAndroid /p:Configuration=Debug + - name: Build + run: msbuild /t:PackageForAndroid /p:Configuration=Debug ``` {% endraw %} diff --git a/content/actions/hosting-your-own-runners/about-self-hosted-runners.md b/content/actions/hosting-your-own-runners/about-self-hosted-runners.md index 13af927006..89e5581813 100644 --- a/content/actions/hosting-your-own-runners/about-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/about-self-hosted-runners.md @@ -77,8 +77,8 @@ The following operating systems are supported for the self-hosted runner applica #### Linux -- Red Hat Enterprise Linux 7 -- CentOS 7 +- Red Hat Enterprise Linux 7 or later +- CentOS 7 or later - Oracle Linux 7 - Fedora 29 or later - Debian 9 or later diff --git a/content/admin/configuration/configuring-network-settings/enabling-subdomain-isolation.md b/content/admin/configuration/configuring-network-settings/enabling-subdomain-isolation.md index e511962c4d..24195f507f 100644 --- a/content/admin/configuration/configuring-network-settings/enabling-subdomain-isolation.md +++ b/content/admin/configuration/configuring-network-settings/enabling-subdomain-isolation.md @@ -20,7 +20,7 @@ topics: Subdomain isolation mitigates cross-site scripting and other related vulnerabilities. For more information, see "[Cross-site scripting](http://en.wikipedia.org/wiki/Cross-site_scripting)" on Wikipedia. We highly recommend that you enable subdomain isolation on {% data variables.product.product_location %}. -When subdomain isolation is enabled, {% data variables.product.prodname_ghe_server %} replaces several paths with subdomains. +When subdomain isolation is enabled, {% data variables.product.prodname_ghe_server %} replaces several paths with subdomains. After enabling subdomain isolation, attempts to access the previous paths for some user-supplied content, such as `http(s)://HOSTNAME/raw/`, may return `404` errors. {% if currentVersion == "enterprise-server@2.22" %} To use Docker with {% data variables.product.prodname_registry %}, you must also enable subdomain isolation. For more information, see "[Working with the Docker registry](/enterprise/{{ currentVersion }}/user/packages/working-with-a-github-packages-registry/working-with-the-docker-registry)." diff --git a/content/admin/index.md b/content/admin/index.md index 8bc62e9e4b..4c0e68c0a6 100644 --- a/content/admin/index.md +++ b/content/admin/index.md @@ -22,7 +22,7 @@ featuredLinks: - '{% if currentVersion == "github-ae@latest" %}/admin/user-management/customizing-user-messages-for-your-enterprise{% endif %}' - '{% if currentVersion == "github-ae@latest" %}/admin/github-actions/getting-started-with-github-actions-for-github-ae{% endif %}' popular: - - '{% if currentVersion == "github-ae@latest" %}/admin/overview/github-ae-release-notes{% endif %}' + - '{% if currentVersion == "github-ae@latest" %}/admin/release-notes{% endif %}' - '{% if enterpriseServerVersions contains currentVersion %}/github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-server{% endif %}' - '{% if enterpriseServerVersions contains currentVersion %}/admin/installation{% endif %}' - '{% if currentVersion == "github-ae@latest" %}/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad{% endif %}' @@ -50,14 +50,3 @@ children: - /release-notes - /all-releases --- - - - - - - - - - - - diff --git a/content/admin/overview/about-upgrades-to-new-releases.md b/content/admin/overview/about-upgrades-to-new-releases.md index f36e855192..fbcaefad55 100644 --- a/content/admin/overview/about-upgrades-to-new-releases.md +++ b/content/admin/overview/about-upgrades-to-new-releases.md @@ -45,5 +45,5 @@ To upgrade your enterprise to a new release, see "[Release notes](/enterprise-se - [ {% data variables.product.prodname_roadmap %} ]( {% data variables.product.prodname_roadmap_link %} ) in the `github/roadmap` repository {% if currentVersion == "github-ae@latest" %} -- [ {% data variables.product.prodname_ghe_managed %} release notes](/admin/overview/github-ae-release-notes) +- [ {% data variables.product.prodname_ghe_managed %} release notes](/admin/release-notes) {% endif %} diff --git a/content/admin/overview/github-ae-release-notes.md b/content/admin/overview/github-ae-release-notes.md deleted file mode 100644 index dbd6bc961a..0000000000 --- a/content/admin/overview/github-ae-release-notes.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: GitHub AE release notes -intro: March 1, 2021 -versions: - github-ae: '*' ---- - -### Features - -#### {% data variables.product.prodname_actions %} beta - -[{% data variables.product.prodname_actions %}](https://github.com/features/actions) is a powerful, flexible solution for CI/CD and workflow automation. For more information, see "[Introduction to {% data variables.product.prodname_actions %}](/actions/learn-github-actions/introduction-to-github-actions)." - -{% data variables.product.prodname_actions %} on {% data variables.product.product_name %} uses a new [{% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/about-ae-hosted-runners), only available for {% data variables.product.product_name %}, that enables you to customize the size, image, and networking configuration of the runners. These runners are a finished-service CI compute environment with auto-scaling and management, fully managed by {% data variables.product.company_short %}. During the beta, the use {% data variables.actions.hosted_runner %}s is free of charge. For more information, see "[Adding {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/adding-ae-hosted-runners)." - -Please note that when {% data variables.product.prodname_actions %} is enabled during this upgrade, two organizations named "GitHub Actions" (@**actions** and @**github**) will appear in {% data variables.product.product_location %}. These organizations are required by {% data variables.product.prodname_actions %}. Users named @**ghost** and @**actions** appear as the actors for creation of these organizations in the audit log. - -#### {% data variables.product.prodname_registry %} beta - -[{% data variables.product.prodname_registry %}](https://github.com/features/packages) is a package hosting service, natively integrated with {% data variables.product.prodname_actions %}, APIs, and webhooks. Create an [end-to-end DevOps workflow](/github-ae@latest/packages/quickstart) that includes your code, continuous integration, and deployment solutions. For more information, see "[About {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-github-packages)." - -During this beta, {% data variables.product.prodname_registry %} is free of charge to {% data variables.product.product_name %} customers. - -#### {% data variables.product.prodname_GH_advanced_security %} beta - -{% data variables.product.prodname_GH_advanced_security %} is available in beta and includes both {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}. Repository administrators and organization owners can opt into {% data variables.product.prodname_advanced_security %} features in the settings for a repository or organization, within the **Security and analysis** tab. For more information, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)." - -During this beta, {% data variables.product.prodname_advanced_security %} features are free of charge to {% data variables.product.product_name %} customers. - -#### Manage teams from your identity provider (IdP) - -Customers using SCIM (System for Cross-domain Identity Management) can now sync security groups in Azure Active Directory with {% data variables.product.company_short %} teams. Once a team has been linked to a security group, membership will be automatically updated in {% data variables.product.product_name %} when a user is added or removed from their assigned security group. For more information, see "[Synchronizing a team with an identity provider group](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." - -#### IP allow lists beta - -Enterprise and organization owners can now use IP allow lists to restrict traffic to the enterprise or specific organizations. After you configure an IP allow list, only visitors from IP addresses on the list are permitted to access the resources protected by the list. - -This functionality is provided in addition to the ability to request network security group changes that filter traffic to the entirety of the {% data variables.product.product_name %} tenant. - -For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/restricting-network-traffic-to-your-enterprise)" and "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization)." - -#### Pull request auto-merge - -With auto-merge, pull requests can be set to merge automatically when all merge requirements have been satisfied. This saves users from needing to constantly check the state of their pull requests just to merge them. Auto-merge can be enabled by a user with permission to merge and on pull requests that have unsatisfied merge requirements (like missing approvals or pending or failing required status checks). For more information, see "[Automatically merging a pull request](/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request)." - -### Changes - -#### Developer changes - -- [Organization owners can now disable publication](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization) of {% data variables.product.prodname_pages %} sites from repositories in the organization. This will not unpublish existing sites. -- Repositories that use {% data variables.product.prodname_pages %} can now [build and deploy from any branch](/pages/getting-started-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites). -- When writing an issue or pull request, the list syntax for bullets, numbers, and tasks will now be autocompleted after you press `return` or `enter`. -- You can now delete a directory in a repository from the repository page. When navigating to a directory, a new kebab button next to the "Add file" button gives the option to delete the directory. -- It’s now easier and faster to [reference issues or pull requests](/github/writing-on-github/basic-writing-and-formatting-syntax#referencing-issues-and-pull-requests), with search across multiple words after the "#". - -##### Administration changes - -- Enterprise owners can now [publish a mandatory message](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-mandatory-message). The message is shown to all users and they must acknowledge it. This can be used to display important information, terms of service or policies. -- The {% data variables.product.prodname_github_app%} single file path permission can now [support up to ten files](/developers/apps/creating-a-github-app-using-url-parameters). -- When configuring a {% data variables.product.prodname_github_app%}, the authorization callback URL is a required field. Now we will permit the integrator to specify multiple callback URLs. {% data variables.product.product_name %} denies authorization if the callback URL from the request is not listed. -- A [new API endpoint](/rest/reference/apps#create-a-scoped-access-token) enables the exchange of a user to server token for a user to server token scoped to specific repositories. -- Events are now logged in the audit log on [promoting a team member to be a team maintainer and on demoting a team maintainer to be a team member](/admin/user-management/audited-actions#teams). -- The [OAuth device authorization flow](/developers/apps/authorizing-oauth-apps#device-flow) is now supported. This allows any CLI client or developer tool to authenticate using a secondary system. -- A user can no longer delete their account if SCIM provisioning is enabled. - -##### Default branch renaming - -Enterprise and organization owners can now set the default branch name for new repositories. Enterprise owners can also enforce their choice of default branch name across all organizations or allow individual organizations to choose their own. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-the-default-branch-name)" and "[Managing the default branch name for repositories in your organization](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization)." - -Existing repositories are unaffected by these settings, and their default branch name will not be changed. - -This change is one of many changes {% data variables.product.company_short %} is making to support projects and maintainers that want to rename their default branch. To learn more, see [github/renaming](https://github.com/github/renaming). - - -### Bug fixes -- Users can no longer set a backup email address on their profile. Their email address is set through the IdP only. -- You can no longer enable two-factor authentication after configuring authentication through your IdP. -- {% data variables.product.product_name %} can now connect to Azure Boards. -- Version headers were missing from the APIs, and have now been set to "GitHub AE." -- Links to documentation have been fixed. -- Configuration of audit log forwarding within the enterprise's settings was failing. -- Navigating to gists could result in a 500 error. -- The Support email or URL was failing to save. It now saves after a period of a few minutes. -- Organization level pull request templates were not being applied to all pull requests in the organization. - -### Known issues - -- Geographic location data is not shown in the audit log. Location information can otherwise be discerned from the IP address associated with each event. -- The link to {% data variables.product.prodname_registry %} from a repository page shows an incorrect search page when that repository does not have any packages. diff --git a/content/admin/overview/index.md b/content/admin/overview/index.md index 9f047fd8bd..7c88265d86 100644 --- a/content/admin/overview/index.md +++ b/content/admin/overview/index.md @@ -8,6 +8,7 @@ versions: github-ae: '*' children: - /about-github-ae + - /about-upgrades-to-new-releases - /about-data-residency - /about-enterprise-accounts - /managing-your-github-enterprise-license @@ -15,6 +16,5 @@ children: - /about-upgrades-to-new-releases - /system-overview - /about-the-github-enterprise-api - - /github-ae-release-notes --- For more information, or to purchase {% data variables.product.prodname_enterprise %}, see [{% data variables.product.prodname_enterprise %}](https://github.com/enterprise). diff --git a/content/admin/release-notes.md b/content/admin/release-notes.md index 7dfc63a71c..da80bfef2a 100644 --- a/content/admin/release-notes.md +++ b/content/admin/release-notes.md @@ -1,11 +1,12 @@ --- title: Release notes -intro: 'The release notes for {{ allVersions[currentVersion].versionTitle }}.' layout: release-notes versions: enterprise-server: '*' + github-ae: '*' topics: - Enterprise - Upgrades +redirect_from: + - /admin/overview/github-ae-release-notes --- - diff --git a/content/admin/user-management/managing-organizations-in-your-enterprise/requiring-two-factor-authentication-for-an-organization.md b/content/admin/user-management/managing-organizations-in-your-enterprise/requiring-two-factor-authentication-for-an-organization.md index 4ea6d19864..1ed54604f3 100644 --- a/content/admin/user-management/managing-organizations-in-your-enterprise/requiring-two-factor-authentication-for-an-organization.md +++ b/content/admin/user-management/managing-organizations-in-your-enterprise/requiring-two-factor-authentication-for-an-organization.md @@ -8,7 +8,7 @@ versions: enterprise-server: '*' type: how_to topics: - - 2fa + - 2FA - Enterprise - Organizations - Policies diff --git a/content/billing/managing-billing-for-git-large-file-storage/about-billing-for-git-large-file-storage.md b/content/billing/managing-billing-for-git-large-file-storage/about-billing-for-git-large-file-storage.md index 04ce67f74f..e10c1faaf2 100644 --- a/content/billing/managing-billing-for-git-large-file-storage/about-billing-for-git-large-file-storage.md +++ b/content/billing/managing-billing-for-git-large-file-storage/about-billing-for-git-large-file-storage.md @@ -5,6 +5,7 @@ redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-git-large-file-storage - /articles/about-billing-for-git-large-file-storage - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-git-large-file-storage + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-git-large-file-storage/about-billing-for-git-large-file-storage versions: free-pro-team: '*' type: overview diff --git a/content/billing/managing-billing-for-git-large-file-storage/downgrading-git-large-file-storage.md b/content/billing/managing-billing-for-git-large-file-storage/downgrading-git-large-file-storage.md index 85993efc3b..4be4f764ca 100644 --- a/content/billing/managing-billing-for-git-large-file-storage/downgrading-git-large-file-storage.md +++ b/content/billing/managing-billing-for-git-large-file-storage/downgrading-git-large-file-storage.md @@ -7,6 +7,7 @@ redirect_from: - /articles/downgrading-storage-and-bandwidth-for-an-organization/ - /articles/downgrading-git-large-file-storage - /github/setting-up-and-managing-billing-and-payments-on-github/downgrading-git-large-file-storage + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-git-large-file-storage/downgrading-git-large-file-storage versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-billing-for-git-large-file-storage/upgrading-git-large-file-storage.md b/content/billing/managing-billing-for-git-large-file-storage/upgrading-git-large-file-storage.md index 0578e50af7..9768341301 100644 --- a/content/billing/managing-billing-for-git-large-file-storage/upgrading-git-large-file-storage.md +++ b/content/billing/managing-billing-for-git-large-file-storage/upgrading-git-large-file-storage.md @@ -7,6 +7,7 @@ redirect_from: - /articles/purchasing-additional-storage-and-bandwidth-for-an-organization/ - /articles/upgrading-git-large-file-storage - /github/setting-up-and-managing-billing-and-payments-on-github/upgrading-git-large-file-storage + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-git-large-file-storage/upgrading-git-large-file-storage versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-billing-for-git-large-file-storage/viewing-your-git-large-file-storage-usage.md b/content/billing/managing-billing-for-git-large-file-storage/viewing-your-git-large-file-storage-usage.md index dc767353c3..bd4ba1f153 100644 --- a/content/billing/managing-billing-for-git-large-file-storage/viewing-your-git-large-file-storage-usage.md +++ b/content/billing/managing-billing-for-git-large-file-storage/viewing-your-git-large-file-storage-usage.md @@ -7,6 +7,7 @@ redirect_from: - /articles/viewing-storage-and-bandwidth-usage-for-an-organization/ - /articles/viewing-your-git-large-file-storage-usage - /github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-git-large-file-storage-usage + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-git-large-file-storage/viewing-your-git-large-file-storage-usage versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md b/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md index 4f8e331423..883625b2e6 100644 --- a/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md +++ b/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md @@ -4,6 +4,7 @@ intro: 'If you want to use {% data variables.product.prodname_actions %} beyond product: '{% data reusables.gated-features.actions %}' redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions/about-billing-for-github-actions versions: free-pro-team: '*' type: overview diff --git a/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md b/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md index 8e1a45628e..f0dd743d24 100644 --- a/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md +++ b/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md @@ -4,6 +4,7 @@ intro: 'You can set a spending limit for {% data variables.product.prodname_acti product: '{% data reusables.gated-features.actions %}' redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/managing-your-spending-limit-for-github-actions + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage.md b/content/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage.md index c63d01c376..36ff3ac4bb 100644 --- a/content/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage.md +++ b/content/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage.md @@ -4,6 +4,7 @@ intro: 'You can view details of your usage of minutes and storage for {% data va product: '{% data reusables.gated-features.actions %}' redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-actions-usage + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions/viewing-your-github-actions-usage versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-billing-for-github-marketplace-apps/about-billing-for-github-marketplace.md b/content/billing/managing-billing-for-github-marketplace-apps/about-billing-for-github-marketplace.md index 4aa29f92ff..10d829e631 100644 --- a/content/billing/managing-billing-for-github-marketplace-apps/about-billing-for-github-marketplace.md +++ b/content/billing/managing-billing-for-github-marketplace-apps/about-billing-for-github-marketplace.md @@ -5,6 +5,7 @@ redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-marketplace - /articles/about-billing-for-github-marketplace - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-marketplace + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-marketplace-apps/about-billing-for-github-marketplace versions: free-pro-team: '*' type: overview diff --git a/content/billing/managing-billing-for-github-marketplace-apps/canceling-a-github-marketplace-app.md b/content/billing/managing-billing-for-github-marketplace-apps/canceling-a-github-marketplace-app.md index 59ae7b8013..9f310b8ca2 100644 --- a/content/billing/managing-billing-for-github-marketplace-apps/canceling-a-github-marketplace-app.md +++ b/content/billing/managing-billing-for-github-marketplace-apps/canceling-a-github-marketplace-app.md @@ -7,6 +7,7 @@ redirect_from: - /articles/canceling-an-app-for-your-organization/ - /articles/canceling-a-github-marketplace-app - /github/setting-up-and-managing-billing-and-payments-on-github/canceling-a-github-marketplace-app + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-marketplace-apps/canceling-a-github-marketplace-app versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-billing-for-github-marketplace-apps/downgrading-the-billing-plan-for-a-github-marketplace-app.md b/content/billing/managing-billing-for-github-marketplace-apps/downgrading-the-billing-plan-for-a-github-marketplace-app.md index a739c47130..83a0490228 100644 --- a/content/billing/managing-billing-for-github-marketplace-apps/downgrading-the-billing-plan-for-a-github-marketplace-app.md +++ b/content/billing/managing-billing-for-github-marketplace-apps/downgrading-the-billing-plan-for-a-github-marketplace-app.md @@ -7,6 +7,7 @@ redirect_from: - /articles/downgrading-an-app-for-your-organization/ - /articles/downgrading-the-billing-plan-for-a-github-marketplace-app - /github/setting-up-and-managing-billing-and-payments-on-github/downgrading-the-billing-plan-for-a-github-marketplace-app + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-marketplace-apps/downgrading-the-billing-plan-for-a-github-marketplace-app versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-billing-for-github-marketplace-apps/upgrading-the-billing-plan-for-a-github-marketplace-app.md b/content/billing/managing-billing-for-github-marketplace-apps/upgrading-the-billing-plan-for-a-github-marketplace-app.md index 4d83567639..0efdad0227 100644 --- a/content/billing/managing-billing-for-github-marketplace-apps/upgrading-the-billing-plan-for-a-github-marketplace-app.md +++ b/content/billing/managing-billing-for-github-marketplace-apps/upgrading-the-billing-plan-for-a-github-marketplace-app.md @@ -7,6 +7,7 @@ redirect_from: - /articles/upgrading-an-app-for-your-organization/ - /articles/upgrading-the-billing-plan-for-a-github-marketplace-app - /github/setting-up-and-managing-billing-and-payments-on-github/upgrading-the-billing-plan-for-a-github-marketplace-app + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-marketplace-apps/upgrading-the-billing-plan-for-a-github-marketplace-app versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md b/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md index 25c575a3f2..da5b67bed7 100644 --- a/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md +++ b/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md @@ -4,6 +4,7 @@ intro: 'If you want to use {% data variables.product.prodname_registry %} beyond product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages/about-billing-for-github-packages versions: free-pro-team: '*' type: overview diff --git a/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md b/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md index 7b40b6f92c..26bd5275e7 100644 --- a/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md +++ b/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md @@ -4,6 +4,7 @@ intro: 'You can set a spending limit for {% data variables.product.prodname_regi product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/managing-your-spending-limit-for-github-packages + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-billing-for-github-packages/viewing-your-github-packages-usage.md b/content/billing/managing-billing-for-github-packages/viewing-your-github-packages-usage.md index 10c886da3e..0a3c702fd2 100644 --- a/content/billing/managing-billing-for-github-packages/viewing-your-github-packages-usage.md +++ b/content/billing/managing-billing-for-github-packages/viewing-your-github-packages-usage.md @@ -4,6 +4,7 @@ intro: 'You can view details of your usage of storage and data transfer for {% d product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-packages-usage + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages/viewing-your-github-packages-usage versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-billing-for-github-sponsors/about-billing-for-github-sponsors.md b/content/billing/managing-billing-for-github-sponsors/about-billing-for-github-sponsors.md index a43b116856..f3bc003210 100644 --- a/content/billing/managing-billing-for-github-sponsors/about-billing-for-github-sponsors.md +++ b/content/billing/managing-billing-for-github-sponsors/about-billing-for-github-sponsors.md @@ -5,6 +5,7 @@ redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors - /articles/about-billing-for-github-sponsors - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-sponsors/about-billing-for-github-sponsors versions: free-pro-team: '*' type: overview diff --git a/content/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship.md b/content/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship.md index 557893994e..94dfeb62ad 100644 --- a/content/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship.md +++ b/content/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship.md @@ -5,6 +5,7 @@ redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/downgrading-a-sponsorship - /articles/downgrading-a-sponsorship - /github/setting-up-and-managing-billing-and-payments-on-github/downgrading-a-sponsorship + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-sponsors/downgrading-a-sponsorship versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-billing-for-github-sponsors/upgrading-a-sponsorship.md b/content/billing/managing-billing-for-github-sponsors/upgrading-a-sponsorship.md index 409f337388..acb8cdb86a 100644 --- a/content/billing/managing-billing-for-github-sponsors/upgrading-a-sponsorship.md +++ b/content/billing/managing-billing-for-github-sponsors/upgrading-a-sponsorship.md @@ -5,6 +5,7 @@ redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/upgrading-a-sponsorship - /articles/upgrading-a-sponsorship - /github/setting-up-and-managing-billing-and-payments-on-github/upgrading-a-sponsorship + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-sponsors/upgrading-a-sponsorship versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-billing-for-your-github-account/about-billing-for-github-accounts.md b/content/billing/managing-billing-for-your-github-account/about-billing-for-github-accounts.md index 76a0db667c..eebd6ed209 100644 --- a/content/billing/managing-billing-for-your-github-account/about-billing-for-github-accounts.md +++ b/content/billing/managing-billing-for-your-github-account/about-billing-for-github-accounts.md @@ -12,6 +12,7 @@ redirect_from: - /articles/github-s-billing-plans - /articles/about-billing-for-github-accounts - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-accounts + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-your-github-account/about-billing-for-github-accounts versions: free-pro-team: '*' type: overview diff --git a/content/billing/managing-billing-for-your-github-account/about-per-user-pricing.md b/content/billing/managing-billing-for-your-github-account/about-per-user-pricing.md index 784aa117f6..e831500eb3 100644 --- a/content/billing/managing-billing-for-your-github-account/about-per-user-pricing.md +++ b/content/billing/managing-billing-for-your-github-account/about-per-user-pricing.md @@ -5,6 +5,7 @@ redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/about-per-user-pricing - /articles/about-per-user-pricing - /github/setting-up-and-managing-billing-and-payments-on-github/about-per-user-pricing + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-your-github-account/about-per-user-pricing versions: free-pro-team: '*' type: overview diff --git a/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md b/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md index e4f2b52f18..1d683d8778 100644 --- a/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md +++ b/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md @@ -8,6 +8,7 @@ redirect_from: - /articles/discounted-billing-plans/ - /articles/discounted-subscriptions-for-github-accounts - /github/setting-up-and-managing-billing-and-payments-on-github/discounted-subscriptions-for-github-accounts + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts versions: free-pro-team: '*' type: reference diff --git a/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md b/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md index f2a2c5bf98..4552545a1a 100644 --- a/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md +++ b/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md @@ -17,6 +17,7 @@ redirect_from: - /articles/downgrading-your-github-billing-plan/ - /articles/downgrading-your-github-subscription - /github/setting-up-and-managing-billing-and-payments-on-github/downgrading-your-github-subscription + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-your-github-account/downgrading-your-github-subscription versions: free-pro-team: '*' topics: diff --git a/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md b/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md index c579ae0546..0c84b370b9 100644 --- a/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md +++ b/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md @@ -5,6 +5,7 @@ redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/how-does-upgrading-or-downgrading-affect-the-billing-process - /articles/how-does-upgrading-or-downgrading-affect-the-billing-process - /github/setting-up-and-managing-billing-and-payments-on-github/how-does-upgrading-or-downgrading-affect-the-billing-process + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md b/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md index 7052321252..4d90a55f6b 100644 --- a/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md +++ b/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md @@ -19,6 +19,7 @@ redirect_from: - /articles/upgrading-your-github-billing-plan/ - /articles/upgrading-your-github-subscription - /github/setting-up-and-managing-billing-and-payments-on-github/upgrading-your-github-subscription + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-your-github-account/upgrading-your-github-subscription versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-billing-for-your-github-account/viewing-and-managing-pending-changes-to-your-subscription.md b/content/billing/managing-billing-for-your-github-account/viewing-and-managing-pending-changes-to-your-subscription.md index 4b76304e93..bd16c7fdea 100644 --- a/content/billing/managing-billing-for-your-github-account/viewing-and-managing-pending-changes-to-your-subscription.md +++ b/content/billing/managing-billing-for-your-github-account/viewing-and-managing-pending-changes-to-your-subscription.md @@ -8,6 +8,7 @@ redirect_from: - /articles/viewing-and-managing-pending-changes-to-your-billing-plan/ - /articles/viewing-and-managing-pending-changes-to-your-subscription - /github/setting-up-and-managing-billing-and-payments-on-github/viewing-and-managing-pending-changes-to-your-subscription + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-your-github-account/viewing-and-managing-pending-changes-to-your-subscription versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-licensing-for-github-advanced-security/about-licensing-for-github-advanced-security.md b/content/billing/managing-licensing-for-github-advanced-security/about-licensing-for-github-advanced-security.md index 0f1c9fc5af..ce8aea83f9 100644 --- a/content/billing/managing-licensing-for-github-advanced-security/about-licensing-for-github-advanced-security.md +++ b/content/billing/managing-licensing-for-github-advanced-security/about-licensing-for-github-advanced-security.md @@ -4,6 +4,7 @@ intro: 'If you want to use {% data variables.product.prodname_GH_advanced_securi product: '{% data reusables.gated-features.ghas %}' redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-licensing-for-github-advanced-security/about-licensing-for-github-advanced-security versions: free-pro-team: '*' type: overview diff --git a/content/billing/managing-licensing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md b/content/billing/managing-licensing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md index c3348bdf2c..978818dd58 100644 --- a/content/billing/managing-licensing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md +++ b/content/billing/managing-licensing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md @@ -4,6 +4,7 @@ intro: 'You can view usage of your {% data variables.product.prodname_GH_advance permissions: 'Enterprise owners can manage access to {% data variables.product.prodname_GH_advanced_security %} for their organization or enterprise organizations.' product: '{% data reusables.gated-features.ghas %}' redirect_from: + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-licensing-for-github-advanced-security/viewing-your-github-advanced-security-usage - /github/setting-up-and-managing-your-enterprise/managing-use-of-advanced-security-for-organizations-in-your-enterprise-account - /github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-advanced-security-usage versions: diff --git a/content/billing/managing-your-github-billing-settings/about-billing-on-github.md b/content/billing/managing-your-github-billing-settings/about-billing-on-github.md index 2b985d315d..e43e18a807 100644 --- a/content/billing/managing-your-github-billing-settings/about-billing-on-github.md +++ b/content/billing/managing-your-github-billing-settings/about-billing-on-github.md @@ -5,6 +5,7 @@ redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-on-github - /articles/about-billing-on-github - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-on-github + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-your-github-billing-settings/about-billing-on-github versions: free-pro-team: '*' type: overview diff --git a/content/billing/managing-your-github-billing-settings/adding-information-to-your-receipts.md b/content/billing/managing-your-github-billing-settings/adding-information-to-your-receipts.md index 00cdd0bc2c..d15fa13689 100644 --- a/content/billing/managing-your-github-billing-settings/adding-information-to-your-receipts.md +++ b/content/billing/managing-your-github-billing-settings/adding-information-to-your-receipts.md @@ -13,6 +13,7 @@ redirect_from: - /articles/adding-information-to-your-organization-s-receipts/ - /articles/adding-information-to-your-receipts - /github/setting-up-and-managing-billing-and-payments-on-github/adding-information-to-your-receipts + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-your-github-billing-settings/adding-information-to-your-receipts versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method.md b/content/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method.md index 7b5a7f0b39..11e566c03e 100644 --- a/content/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method.md +++ b/content/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method.md @@ -17,6 +17,7 @@ redirect_from: - /articles/switching-payment-methods-for-your-organization/ - /articles/adding-or-editing-a-payment-method - /github/setting-up-and-managing-billing-and-payments-on-github/adding-or-editing-a-payment-method + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-your-github-billing-settings/adding-or-editing-a-payment-method versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-your-github-billing-settings/changing-the-duration-of-your-billing-cycle.md b/content/billing/managing-your-github-billing-settings/changing-the-duration-of-your-billing-cycle.md index ad5b30ec75..942868a34b 100644 --- a/content/billing/managing-your-github-billing-settings/changing-the-duration-of-your-billing-cycle.md +++ b/content/billing/managing-your-github-billing-settings/changing-the-duration-of-your-billing-cycle.md @@ -8,6 +8,7 @@ redirect_from: - /articles/switching-between-monthly-and-yearly-billing-for-your-organization/ - /articles/changing-the-duration-of-your-billing-cycle - /github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-your-github-billing-settings/changing-the-duration-of-your-billing-cycle versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-your-github-billing-settings/redeeming-a-coupon.md b/content/billing/managing-your-github-billing-settings/redeeming-a-coupon.md index 1a31b9b156..d25097660c 100644 --- a/content/billing/managing-your-github-billing-settings/redeeming-a-coupon.md +++ b/content/billing/managing-your-github-billing-settings/redeeming-a-coupon.md @@ -8,6 +8,7 @@ redirect_from: - /articles/redeeming-a-coupon-for-organizations/ - /articles/redeeming-a-coupon - /github/setting-up-and-managing-billing-and-payments-on-github/redeeming-a-coupon + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-your-github-billing-settings/redeeming-a-coupon versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-your-github-billing-settings/removing-a-payment-method.md b/content/billing/managing-your-github-billing-settings/removing-a-payment-method.md index 7aaddadeba..60b469872b 100644 --- a/content/billing/managing-your-github-billing-settings/removing-a-payment-method.md +++ b/content/billing/managing-your-github-billing-settings/removing-a-payment-method.md @@ -9,6 +9,7 @@ redirect_from: - /articles/removing-a-payment-method-associated-with-your-organization/ - /articles/removing-a-payment-method - /github/setting-up-and-managing-billing-and-payments-on-github/removing-a-payment-method + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-your-github-billing-settings/removing-a-payment-method versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-your-github-billing-settings/setting-your-billing-email.md b/content/billing/managing-your-github-billing-settings/setting-your-billing-email.md index 98938e0354..b0cd87e7b2 100644 --- a/content/billing/managing-your-github-billing-settings/setting-your-billing-email.md +++ b/content/billing/managing-your-github-billing-settings/setting-your-billing-email.md @@ -9,6 +9,7 @@ redirect_from: - /articles/setting-your-organization-s-billing-email/ - /articles/setting-your-billing-email - /github/setting-up-and-managing-billing-and-payments-on-github/setting-your-billing-email + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-your-github-billing-settings/setting-your-billing-email versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-your-github-billing-settings/troubleshooting-a-declined-credit-card-charge.md b/content/billing/managing-your-github-billing-settings/troubleshooting-a-declined-credit-card-charge.md index 67c93522a9..ba51080db7 100644 --- a/content/billing/managing-your-github-billing-settings/troubleshooting-a-declined-credit-card-charge.md +++ b/content/billing/managing-your-github-billing-settings/troubleshooting-a-declined-credit-card-charge.md @@ -6,6 +6,7 @@ redirect_from: - /articles/what-do-i-do-if-my-card-is-declined/ - /articles/troubleshooting-a-declined-credit-card-charge - /github/setting-up-and-managing-billing-and-payments-on-github/troubleshooting-a-declined-credit-card-charge + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-your-github-billing-settings/troubleshooting-a-declined-credit-card-charge versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-your-github-billing-settings/unlocking-a-locked-account.md b/content/billing/managing-your-github-billing-settings/unlocking-a-locked-account.md index b9e0e3255a..5f8325dabb 100644 --- a/content/billing/managing-your-github-billing-settings/unlocking-a-locked-account.md +++ b/content/billing/managing-your-github-billing-settings/unlocking-a-locked-account.md @@ -11,6 +11,7 @@ redirect_from: - /articles/unlocking-a-locked-organization-account/ - /articles/unlocking-a-locked-account - /github/setting-up-and-managing-billing-and-payments-on-github/unlocking-a-locked-account + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-your-github-billing-settings/unlocking-a-locked-account versions: free-pro-team: '*' type: how_to diff --git a/content/billing/managing-your-github-billing-settings/viewing-your-payment-history-and-receipts.md b/content/billing/managing-your-github-billing-settings/viewing-your-payment-history-and-receipts.md index 40c01cd959..2f044896b9 100644 --- a/content/billing/managing-your-github-billing-settings/viewing-your-payment-history-and-receipts.md +++ b/content/billing/managing-your-github-billing-settings/viewing-your-payment-history-and-receipts.md @@ -8,6 +8,7 @@ redirect_from: - /articles/downloading-receipts-for-organizations/ - /articles/viewing-your-payment-history-and-receipts - /github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-payment-history-and-receipts + - /github/setting-up-and-managing-billing-and-payments-on-github/managing-your-github-billing-settings/viewing-your-payment-history-and-receipts versions: free-pro-team: '*' type: how_to diff --git a/content/billing/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md b/content/billing/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md index 12fdf178e6..dcfdf275df 100644 --- a/content/billing/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md +++ b/content/billing/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md @@ -6,6 +6,7 @@ redirect_from: - /articles/about-organizations-for-resellers/ - /articles/about-organizations-for-procurement-companies - /github/setting-up-and-managing-billing-and-payments-on-github/about-organizations-for-procurement-companies + - /github/setting-up-and-managing-billing-and-payments-on-github/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies versions: free-pro-team: '*' type: overview diff --git a/content/billing/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md b/content/billing/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md index 45525a723a..5acfe27859 100644 --- a/content/billing/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md +++ b/content/billing/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md @@ -5,6 +5,7 @@ redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/creating-and-paying-for-an-organization-on-behalf-of-a-client - /articles/creating-and-paying-for-an-organization-on-behalf-of-a-client - /github/setting-up-and-managing-billing-and-payments-on-github/creating-and-paying-for-an-organization-on-behalf-of-a-client + - /github/setting-up-and-managing-billing-and-payments-on-github/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client versions: free-pro-team: '*' type: quick_start diff --git a/content/billing/setting-up-paid-organizations-for-procurement-companies/renewing-your-clients-paid-organization.md b/content/billing/setting-up-paid-organizations-for-procurement-companies/renewing-your-clients-paid-organization.md index fbe9713429..b245ff7e29 100644 --- a/content/billing/setting-up-paid-organizations-for-procurement-companies/renewing-your-clients-paid-organization.md +++ b/content/billing/setting-up-paid-organizations-for-procurement-companies/renewing-your-clients-paid-organization.md @@ -6,6 +6,7 @@ redirect_from: - /articles/renewing-your-client-s-paid-organization - /articles/renewing-your-clients-paid-organization - /github/setting-up-and-managing-billing-and-payments-on-github/renewing-your-clients-paid-organization + - /github/setting-up-and-managing-billing-and-payments-on-github/setting-up-paid-organizations-for-procurement-companies/renewing-your-clients-paid-organization versions: free-pro-team: '*' type: how_to diff --git a/content/billing/setting-up-paid-organizations-for-procurement-companies/upgrading-or-downgrading-your-clients-paid-organization.md b/content/billing/setting-up-paid-organizations-for-procurement-companies/upgrading-or-downgrading-your-clients-paid-organization.md index 14806356d2..9cb24a0a5c 100644 --- a/content/billing/setting-up-paid-organizations-for-procurement-companies/upgrading-or-downgrading-your-clients-paid-organization.md +++ b/content/billing/setting-up-paid-organizations-for-procurement-companies/upgrading-or-downgrading-your-clients-paid-organization.md @@ -6,6 +6,7 @@ redirect_from: - /articles/upgrading-or-downgrading-your-client-s-paid-organization - /articles/upgrading-or-downgrading-your-clients-paid-organization - /github/setting-up-and-managing-billing-and-payments-on-github/upgrading-or-downgrading-your-clients-paid-organization + - /github/setting-up-and-managing-billing-and-payments-on-github/setting-up-paid-organizations-for-procurement-companies/upgrading-or-downgrading-your-clients-paid-organization versions: free-pro-team: '*' type: how_to diff --git a/content/code-security/getting-started/about-securing-your-repository.md b/content/code-security/getting-started/about-securing-your-repository.md deleted file mode 100644 index 18bf6f2aad..0000000000 --- a/content/code-security/getting-started/about-securing-your-repository.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: About securing your repository -intro: '{% data variables.product.product_name %} provides a number of ways that you can help keep your repository secure.' -redirect_from: - - /github/administering-a-repository/about-securing-your-repository - - /articles/securing-your-repository - - /github/administering-a-repository/securing-your-repository -versions: - free-pro-team: '*' - enterprise-server: '>=3.0' - github-ae: '*' -topics: - - Repositories ---- - -### Setting up your repository securely - -The first step to securing a repository is to set up who can see and modify your code. For more information, see "[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." - -### Securing your repository - -{% data variables.product.prodname_dotcom %} has a growing set of security features that help you keep your code secure. You can find these on the **Security** tab for your repository. - -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} -#### Available for all repositories - -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == 'github-ae@next' %} -- **Security policy** - - Make it easy for your users to confidentially report security vulnerabilities they've found in your repository. For more information, see "[Adding a security policy to your repository](/code-security/getting-started/adding-a-security-policy-to-your-repository)." -{% endif %} - -{% if currentVersion == "free-pro-team@latest" %} -- **Security advisories** - - Privately discuss and fix security vulnerabilities in your repository's code. You can then publish a security advisory to alert your community to the vulnerability and encourage them to upgrade. For more information, see "[About {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)." - -- **{% data variables.product.prodname_dependabot_alerts %} and security updates** - - View alerts about dependencies that are known to contain security vulnerabilities, and choose whether to have pull requests generated automatically to update these dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" - and "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." - {% endif %} - -{% if currentVersion ver_gt "enterprise-server@2.22" %} -- **{% data variables.product.prodname_dependabot_alerts %}** - - View alerts about dependencies that are known to contain security vulnerabilities, and manage these alerts. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." - {% endif %} - -{% if currentVersion == "free-pro-team@latest" %} -- **{% data variables.product.prodname_dependabot %} version updates** - - Use {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. This helps reduce your exposure to older versions of dependencies. Using newer versions makes it easier to apply patches if security vulnerabilities are discovered, and also makes it easier for {% data variables.product.prodname_dependabot_security_updates %} to successfully raise pull requests to upgrade vulnerable dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot-version-updates)." - {% endif %} - {% endif %} - -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} - -#### Available {% if currentVersion == "free-pro-team@latest" %}for public repositories and for repositories {% endif %}with {% data variables.product.prodname_advanced_security %} - -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} -These features are available {% if currentVersion == "free-pro-team@latest" %}for all public repositories, and for private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. {% data reusables.advanced-security.more-info-ghas %} - {% endif %} - -- **{% data variables.product.prodname_code_scanning_capc %} alerts** - - Automatically detect security vulnerabilities and coding errors in new or modified code. Potential problems are highlighted, with detailed information, allowing you to fix the code before it's merged into your default branch. For more information, see "[About code scanning](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)." - -- **{% data variables.product.prodname_secret_scanning_caps %} alerts** - - {% if currentVersion == "free-pro-team@latest" %}For private repositories, view {% else %}View {% endif %}any secrets that {% data variables.product.prodname_dotcom %} has found in your code. You should treat tokens or credentials that have been checked into the repository as compromised. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." - -{% endif %} - -{% if currentVersion == "free-pro-team@latest" %} -- **Dependency review** - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)." -{% endif %} - -{% if currentVersion != "github-ae@latest" %} -### Exploring dependencies -{% data variables.product.prodname_dotcom %}'s dependency graph allows you to explore: - -* Ecosystems and packages that your repository depends on -* Repositories and packages that depend on your repository - -You must enable the dependency graph before {% data variables.product.prodname_dotcom %} can generate {% data variables.product.prodname_dependabot_alerts %} for dependencies with security vulnerabilities. {% if currentVersion == "free-pro-team@latest" %}Enabling the dependency graph also enables {% data variables.product.prodname_dotcom %} to run dependency reviews of pull requests.{% endif %} - -You can find the dependency graph on the **Insights** tab for your repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." -{% endif %} diff --git a/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md b/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md index d7bf20ade9..32e3ed3bc3 100644 --- a/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md +++ b/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md @@ -9,8 +9,12 @@ versions: free-pro-team: '*' enterprise-server: '>=3.1' github-ae: 'next' +type: how_to topics: - - Security + - Security policies + - Vulnerabilities + - Repositories + - Health --- ### About security policies @@ -54,6 +58,6 @@ By making security reporting instructions clearly available, you make it easy fo ### Further reading -- "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)"{% if currentVersion != 'github-ae@next' %} +- "[Securing your repository](/code-security/getting-started/securing-your-repository)"{% if currentVersion != 'github-ae@next' %} - "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)"{% endif %}{% if currentVersion == "free-pro-team@latest" %} - [{% data variables.product.prodname_security %}]({% data variables.product.prodname_security_link %}){% endif %} diff --git a/content/code-security/getting-started/github-security-features.md b/content/code-security/getting-started/github-security-features.md new file mode 100644 index 0000000000..6d4fe8d71e --- /dev/null +++ b/content/code-security/getting-started/github-security-features.md @@ -0,0 +1,86 @@ +--- +title: GitHub security features +intro: 'An overview of {% data variables.product.prodname_dotcom %} security features.' +versions: + free-pro-team: '*' + enterprise-server: '>=3.0' + github-ae: '*' +type: overview +topics: + - Repositories + - Dependencies + - Vulnerabilities + - Advanced Security +--- + +### About {% data variables.product.prodname_dotcom %}'s security features + +{% data variables.product.prodname_dotcom %} has security features that help keep code and secrets secure in repositories and across organizations. Some features are available for all repositories and others are only available {% if currentVersion == "free-pro-team@latest" %}for public repositories and for repositories {% endif %}with a {% data variables.product.prodname_GH_advanced_security %} license. + +The {% data variables.product.prodname_advisory_database %} contains a curated list of security vulnerabilities that you can view, search, and filter. {% data reusables.security-advisory.link-browsing-advisory-db %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +### Available for all repositories + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == 'github-ae@next' %} +#### Security policy + +Make it easy for your users to confidentially report security vulnerabilities they've found in your repository. For more information, see "[Adding a security policy to your repository](/code-security/getting-started/adding-a-security-policy-to-your-repository)." +{% endif %} + +{% if currentVersion == "free-pro-team@latest" %} +#### Security advisories + +Privately discuss and fix security vulnerabilities in your repository's code. You can then publish a security advisory to alert your community to the vulnerability and encourage community members to upgrade. For more information, see "[About {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)." + +#### {% data variables.product.prodname_dependabot_alerts %} and security updates + +View alerts about dependencies that are known to contain security vulnerabilities, and choose whether to have pull requests generated automatically to update these dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" +and "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." +{% endif %} + +{% if currentVersion ver_gt "enterprise-server@2.22" %} +#### {% data variables.product.prodname_dependabot_alerts %} + +View alerts about dependencies that are known to contain security vulnerabilities, and manage these alerts. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." +{% endif %} + +{% if currentVersion == "free-pro-team@latest" %} +#### {% data variables.product.prodname_dependabot %} version updates + +Use {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. This helps reduce your exposure to older versions of dependencies. Using newer versions makes it easier to apply patches if security vulnerabilities are discovered, and also makes it easier for {% data variables.product.prodname_dependabot_security_updates %} to successfully raise pull requests to upgrade vulnerable dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot-version-updates)." +{% endif %} + +#### Dependency graph +The dependency graph allows you to explore the ecosystems and packages that your repository depends on and the repositories and packages that depend on your repository. + +You can find the dependency graph on the **Insights** tab for your repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." +{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} + +### Available {% if currentVersion == "free-pro-team@latest" %}for public repositories and for repositories {% endif %}with {% data variables.product.prodname_advanced_security %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +These features are available {% if currentVersion == "free-pro-team@latest" %}for all public repositories, and for private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. {% data reusables.advanced-security.more-info-ghas %} +{% endif %} + +#### {% data variables.product.prodname_code_scanning_capc %} alerts + +Automatically detect security vulnerabilities and coding errors in new or modified code. Potential problems are highlighted, with detailed information, allowing you to fix the code before it's merged into your default branch. For more information, see "[About code scanning](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)." + +#### {% data variables.product.prodname_secret_scanning_caps %} alerts + +{% if currentVersion == "free-pro-team@latest" %}For private repositories, view {% else %}View {% endif %}any secrets that {% data variables.product.prodname_dotcom %} has found in your code. You should treat tokens or credentials that have been checked into the repository as compromised. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." + +{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" %} +#### Dependency review + +Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)." +{% endif %} + +### Further reading +- "[{% data variables.product.prodname_dotcom %}'s products](/github/getting-started-with-github/githubs-products)" +- "[{% data variables.product.prodname_dotcom %} language support](/github/getting-started-with-github/github-language-support)" \ No newline at end of file diff --git a/content/code-security/getting-started/index.md b/content/code-security/getting-started/index.md index c9eb0f723f..45311d7a69 100644 --- a/content/code-security/getting-started/index.md +++ b/content/code-security/getting-started/index.md @@ -7,9 +7,13 @@ versions: enterprise-server: '>=3.0' github-ae: '*' topics: - - Security + - Repositories + - Dependencies + - Vulnerabilities children: - - /about-securing-your-repository + - /github-security-features + - /securing-your-repository + - /securing-your-organization - /adding-a-security-policy-to-your-repository --- diff --git a/content/code-security/getting-started/securing-your-organization.md b/content/code-security/getting-started/securing-your-organization.md new file mode 100644 index 0000000000..10c35231d4 --- /dev/null +++ b/content/code-security/getting-started/securing-your-organization.md @@ -0,0 +1,112 @@ +--- +title: Securing your organization +intro: 'You can use a number of {% data variables.product.prodname_dotcom %} features to help keep your organization secure.' +permissions: 'Organization owners can configure organization security settings.' +versions: + free-pro-team: '*' + enterprise-server: '>=3.0' + github-ae: '*' +type: how_to +topics: + - Organizations + - Dependencies + - Vulnerabilities + - Advanced Security +--- + +### Introduction +This guide shows you how to configure security features for an organization. Your organization's security needs are unique and you may not need to enable every security feature. For more information, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)." + +Some security features are only available {% if currentVersion == "free-pro-team@latest" %}for public repositories, and for private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. {% data reusables.advanced-security.more-info-ghas %} + +### Managing access to your organization + +You can use permission levels to control what actions people can take in your organization. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)." + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@next" %} + +### Creating a default security policy + +You can create a default security policy that will display in any of your organization's public repositories that do not have their own security policy. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." + +{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +### Managing {% data variables.product.prodname_dependabot_alerts %} and the dependency graph + +By default, {% data variables.product.prodname_dotcom %} detects vulnerabilities in public repositories and generates {% data variables.product.prodname_dependabot_alerts %} and a dependency graph. You can enable or disable {% data variables.product.prodname_dependabot_alerts %} and the dependency graph for all repositories owned by your organization. + +1. Click your profile photo, then click **Organizations**. +2. Click **Settings** next to your organization. +3. Click **Security & analysis**. +4. Click **Enable all** or **Disable all** next to the feature that you want to manage. +5. Optionally, select **Automatically enable for new repositories**. + +For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)," "[Exploring the dependencies of a repository](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)," and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." + +{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" %} + +### Managing dependency review + +Dependency review lets you visualize dependency changes in pull requests before they are merged into your repositories. Dependency review is available in all public repositories and in repositories owned by organizations with an {% data variables.product.prodname_advanced_security %} license that have the dependency graph enabled. For more information, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)." + +{% endif %} + +{% if currentVersion == "free-pro-team@latest" %} +### Managing {% data variables.product.prodname_dependabot_security_updates %} + +For any repository that uses {% data variables.product.prodname_dependabot_alerts %}, you can enable {% data variables.product.prodname_dependabot_security_updates %} to raise pull requests with security updates when vulnerabilities are detected. You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories across your organization. + +1. Click your profile photo, then click **Organizations**. +2. Click **Settings** next to your organization. +3. Click **Security & analysis**. +4. Click **Enable all** or **Disable all** next to {% data variables.product.prodname_dependabot_security_updates %}. +5. Optionally, select **Automatically enable for new repositories**. + +For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/about-dependabot-security-updates)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." + +### Managing {% data variables.product.prodname_dependabot_version_updates %} + +You can enable {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/about-dependabot-version-updates)." + +To enable {% data variables.product.prodname_dependabot_version_updates %}, you must create a *dependabot.yml* configuration file. For more information, see "[Enabling and disabling version updates](/code-security/supply-chain-security/enabling-and-disabling-version-updates)." + +{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +### Managing {% data variables.product.prodname_GH_advanced_security %} + +If your organization has an {% data variables.product.prodname_advanced_security %} license, you can enable or disable {% data variables.product.prodname_advanced_security %} features. + +1. Click your profile photo, then click **Organizations**. +2. Click **Settings** next to your organization. +3. Click **Security & analysis**. +4. Click **Enable all** or **Disable all** next to {% data variables.product.prodname_GH_advanced_security %}. +5. Optionally, select **Automatically enable for new private repositories**. + +For more information, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." + +### Configuring {% data variables.product.prodname_secret_scanning %} +{% data variables.product.prodname_secret_scanning_caps %} is available {% if currentVersion == "free-pro-team@latest" %}for all public repositories, and for private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. + +You can enable or disable {% data variables.product.prodname_secret_scanning %} for all repositories across your organization that have {% data variables.product.prodname_advanced_security %} enabled. + +1. Click your profile photo, then click **Organizations**. +2. Click **Settings** next to your organization. +3. Click **Security & analysis**. +4. Click **Enable all** or **Disable all** next to {% data variables.product.prodname_secret_scanning_caps %} ({% data variables.product.prodname_GH_advanced_security %} repositories only). +5. Optionally, select **Automatically enable for private repositories added to {% data variables.product.prodname_advanced_security %}**. + +For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." + +{% endif %} + +### Next steps +{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@next" %}You can view, filter, and sort security alerts for repositories owned by your organization in the security overview. For more information, see "[Exploring security alerts](/code-security/security-overview/exploring-security-alerts)."{% endif %} + +You can view and manage alerts from security features to address dependencies and vulnerabilities in your code. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} "[Viewing and updating vulnerable dependencies in your repository](/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository),"{% endif %} {% if currentVersion == "free-pro-team@latest" %}"[Managing pull requests for dependency updates](/code-security/supply-chain-security/managing-pull-requests-for-dependency-updates)," {% endif %}"[Managing {% data variables.product.prodname_code_scanning %} for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)," and "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)." + +{% if currentVersion == "free-pro-team@latest" %}If you have a security vulnerability, you can create a security advisory to privately discuss and fix the vulnerability. For more information, see "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)" and "[Creating a security advisory](/code-security/security-advisories/creating-a-security-advisory)." +{% endif %} diff --git a/content/code-security/getting-started/securing-your-repository.md b/content/code-security/getting-started/securing-your-repository.md new file mode 100644 index 0000000000..538d63669d --- /dev/null +++ b/content/code-security/getting-started/securing-your-repository.md @@ -0,0 +1,124 @@ +--- +title: Securing your repository +intro: 'You can use a number of {% data variables.product.prodname_dotcom %} features to help keep your repository secure.' +permissions: 'Repository administrators and organization owners can configure repository security settings.' +redirect_from: + - /github/administering-a-repository/about-securing-your-repository + - /github/code-security/getting-started/about-securing-your-repository +versions: + free-pro-team: '*' + enterprise-server: '>=3.0' + github-ae: '*' +type: how_to +topics: + - Repositories + - Dependencies + - Vulnerabilities + - Advanced Security +--- + +### Introduction +This guide shows you how to configure security features for a repository. You must be a repository administrator or organization owner to configure security settings for a repository. + +Your security needs are unique to your repository, so you may not need to enable every feature for your repository. For more information, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)." + +Some security features are only available {% if currentVersion == "free-pro-team@latest" %}for public repositories, and for private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. {% data reusables.advanced-security.more-info-ghas %} + +### Managing access to your repository + +The first step to securing a repository is to set up who can see and modify your code. For more information, see "[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." + +From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %}Settings**, then scroll down to the "Danger Zone." + +- To change who can view your repository, click **Change visibility**. For more information, see "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)."{% if currentVersion == "free-pro-team@latest" %} +- To change who can access your repository and adjust permissions, click **Manage access**. For more information, see"[Managing teams and people with access to your repository](/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository)."{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == 'github-ae@next' %} +### Setting a security policy + +1. From the main page of your repository, click **{% octicon "shield" aria-label="The shield symbol" %} Security**. +2. Click **Security policy**. +3. Click **Start setup**. +4. Add information about supported versions of your project and how to report vulnerabilities. + +For more information, see "[Adding a security policy to your repository](/code-security/getting-started/adding-a-security-policy-to-your-repository)." + +{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +### Managing the dependency graph + +The dependency graph is automatically generated for {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} all public repositories and you can choose to enable it for private repositories.{% else %} all repositories.{% endif %} + +1. From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %} Settings**. +2. Click **Security & analysis**. +3. Next to Dependency graph, click **Enable** or **Disable**. + +For more information, see "[Exploring the dependencies of a repository](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)." + +{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +### Managing {% data variables.product.prodname_dependabot_alerts %} + +By default, {% data variables.product.prodname_dotcom %} detects vulnerabilities in public repositories and generates {% data variables.product.prodname_dependabot_alerts %}. {% data variables.product.prodname_dependabot_alerts %} can also be enabled for private repositories. + +1. Click your profile photo, then click **Settings**. +2. Click **Security & analysis**. +3. Click **Enable all** next to {% data variables.product.prodname_dependabot_alerts %}. + +For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies){% if currentVersion == "free-pro-team@latest" %}" and "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account){% endif %}." + +{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" %} +### Managing dependency review + +Dependency review lets you visualize dependency changes in pull requests before they are merged into your repository. Dependency review is available in all public repositories and in repositories owned by organizations with an {% data variables.product.prodname_advanced_security %} license that have the dependency graph enabled. For more information, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)." + +{% endif %} + +{% if currentVersion == "free-pro-team@latest" %} + +### Managing {% data variables.product.prodname_dependabot_security_updates %} + +For any repository that uses {% data variables.product.prodname_dependabot_alerts %}, you can enable {% data variables.product.prodname_dependabot_security_updates %} to raise pull requests with security updates when vulnerabilities are detected. + +1. From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %}Settings**. +2. Click **Security & analysis**. +3. Next to {% data variables.product.prodname_dependabot_security_updates %}, click **Enable**. + +For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/about-dependabot-security-updates)" and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/configuring-dependabot-security-updates)." + +### Managing {% data variables.product.prodname_dependabot_version_updates %} + +You can enable {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/about-dependabot-version-updates)." + +To enable {% data variables.product.prodname_dependabot_version_updates %}, you must create a *dependabot.yml* configuration file. For more information, see "[Enabling and disabling version updates](/code-security/supply-chain-security/enabling-and-disabling-version-updates)." + +{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +### Configuring {% data variables.product.prodname_code_scanning %} + +{% data variables.product.prodname_code_scanning_capc %} is available {% if currentVersion == "free-pro-team@latest" %}for all public repositories, and for private repositories owned by organizations with {% else %} for organization-owned repositories if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. + +You can set up {% data variables.product.prodname_code_scanning %} to automatically identify vulnerabilities and errors in the code stored in your repository by using a {% data variables.product.prodname_codeql_workflow %} or third-party tool. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)." + +### Configuring {% data variables.product.prodname_secret_scanning %} +{% data variables.product.prodname_secret_scanning_caps %} is available {% if currentVersion == "free-pro-team@latest" %}for all public repositories, and for private repositories owned by organizations with {% else %} for organization-owned repositories if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. + +{% data variables.product.prodname_secret_scanning_caps %} may be enabled for your repository by default depending upon your organization's settings. + +1. From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %}Settings**. +2. Click **Security & analysis**. +3. If {% data variables.product.prodname_GH_advanced_security %} is not already enabled, click **Enable**. +4. Next to {% data variables.product.prodname_secret_scanning_caps %}, click **Enable**. + +{% endif %} + +### Next steps +You can view and manage alerts from security features to address dependencies and vulnerabilities in your code. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} "[Viewing and updating vulnerable dependencies in your repository](/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository),"{% endif %} {% if currentVersion == "free-pro-team@latest" %}"[Managing pull requests for dependency updates](/code-security/supply-chain-security/managing-pull-requests-for-dependency-updates)," {% endif %}"[Managing {% data variables.product.prodname_code_scanning %} for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)," and "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)." + +{% if currentVersion == "free-pro-team@latest" %}If you have a security vulnerability, you can create a security advisory to privately discuss and fix the vulnerability. For more information, see "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)" and "[Creating a security advisory](/code-security/security-advisories/creating-a-security-advisory)." +{% endif %} diff --git a/content/code-security/index.md b/content/code-security/index.md index 1ef97457a4..ac825b049f 100644 --- a/content/code-security/index.md +++ b/content/code-security/index.md @@ -7,7 +7,9 @@ versions: enterprise-server: '>=3.0' github-ae: '*' topics: - - Security + - Repositories + - Dependencies + - Vulnerabilities children: - /getting-started - /secret-security diff --git a/content/code-security/secret-security/about-secret-scanning.md b/content/code-security/secret-security/about-secret-scanning.md index 0760f79fcd..2fb3089672 100644 --- a/content/code-security/secret-security/about-secret-scanning.md +++ b/content/code-security/secret-security/about-secret-scanning.md @@ -11,8 +11,10 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: overview topics: - - Repositories + - Secret scanning + - Advanced Security --- {% data reusables.secret-scanning.beta %} @@ -77,5 +79,5 @@ To monitor results from {% data variables.product.prodname_secret_scanning %} ac ### Further reading -- "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)" +- "[Securing your repository](/code-security/getting-started/securing-your-repository)" - "[Keeping your account and data secure](/github/authenticating-to-github/keeping-your-account-and-data-secure)" diff --git a/content/code-security/secret-security/configuring-secret-scanning-for-your-repositories.md b/content/code-security/secret-security/configuring-secret-scanning-for-your-repositories.md index 9d43db7cd8..7f590ec28d 100644 --- a/content/code-security/secret-security/configuring-secret-scanning-for-your-repositories.md +++ b/content/code-security/secret-security/configuring-secret-scanning-for-your-repositories.md @@ -10,7 +10,10 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: + - Secret scanning + - Advanced Security - Repositories --- diff --git a/content/code-security/secret-security/index.md b/content/code-security/secret-security/index.md index 5326db7b82..39e0d908c4 100644 --- a/content/code-security/secret-security/index.md +++ b/content/code-security/secret-security/index.md @@ -8,6 +8,8 @@ versions: enterprise-server: '>=3.0' github-ae: '*' topics: + - Secret scanning + - Advanced Security - Repositories children: - /about-secret-scanning diff --git a/content/code-security/secret-security/managing-alerts-from-secret-scanning.md b/content/code-security/secret-security/managing-alerts-from-secret-scanning.md index 22d8987f8e..d662b959a5 100644 --- a/content/code-security/secret-security/managing-alerts-from-secret-scanning.md +++ b/content/code-security/secret-security/managing-alerts-from-secret-scanning.md @@ -8,7 +8,11 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: + - Secret scanning + - Advanced Security + - Alerts - Repositories --- diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning.md index a857ac266e..56a42ec52c 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning.md @@ -10,8 +10,11 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: overview topics: - - Security + - Advanced Security + - Code scanning + - CodeQL --- @@ -59,6 +62,6 @@ You can run third-party analysis tools within {% data variables.product.product_ ### Further reading -- "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)" +- "[Securing your repository](/code-security/getting-started/securing-your-repository)" - [{% data variables.product.prodname_security %}](https://securitylab.github.com/) - [OASIS Static Analysis Results Interchange Format (SARIF) TC](https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=sarif) on the OASIS Committee website diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md index a8be77ae97..6472b829e9 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md @@ -11,8 +11,15 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - Actions + - Repositories + - Pull requests + - JavaScript + - Python --- diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md index cec538806d..88ad2e7595 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md @@ -13,8 +13,16 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Actions + - Repositories + - C/C++ + - C# + - Java --- diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md index 11308d3a67..a348f222a2 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md @@ -10,7 +10,8 @@ versions: enterprise-server: '>=3.0' github-ae: '*' topics: - - Security + - Advanced Security + - Code scanning children: - /about-code-scanning - /triaging-code-scanning-alerts-in-pull-requests diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md index 70798cbef9..fcd488f4fe 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md @@ -13,8 +13,12 @@ redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/managing-alerts-from-code-scanning - /github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository - /code-security/secure-coding/managing-code-scanning-alerts-for-your-repository +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - Alerts + - Repositories --- @@ -48,7 +52,7 @@ You need write permission to view a summary of all the alerts for a repository o {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-code-scanning-alerts %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1"%} -1. Optionally, use the drop-down menus to filter alerts. For example, you can filter by the tool that was used to identify alerts. +1. Optionally, use{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.2" %} the free text search box or{% endif %} the drop-down menus to filter alerts. For example, you can filter by the tool that was used to identify alerts. ![Filter by tool](/assets/images/help/repository/code-scanning-filter-by-tool.png){% endif %} 1. Under "{% data variables.product.prodname_code_scanning_capc %}," click the alert you'd like to explore. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1"%} @@ -61,12 +65,49 @@ You need write permission to view a summary of all the alerts for a repository o 1. Alerts from {% data variables.product.prodname_codeql %} analysis include a description of the problem. Click **Show more** for guidance on how to fix your code. ![Details for an alert](/assets/images/help/repository/code-scanning-alert-details.png) +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.2" %} +### Searching {% data variables.product.prodname_code_scanning %} alerts + +You can search the list of alerts. This is useful if there is a large number of alerts in your repository, or if you don't know the exact name for an alert for example. {% data variables.product.product_name %} performs the free text search across: +- The name of the alert +- The alert description +- The alert details (this also includes the information hidden from view by default in the **Show more** collapsible section) + + ![The alert information used in searches](/assets/images/help/repository/code-scanning-free-text-search-areas.png) + +| Supported search | Syntax example | Results | +| ---- | ---- | ---- | +| Single word search | `injection` | Returns all the alerts containing the word `injection` | +| Multiple word search | `sql injection` | Returns all the alerts containing `sql` or `injection` | +| Exact match search
        (use double quotes) | `"sql injection"` | Returns all the alerts containing the exact phrase `sql injection` | +| OR search | `sql OR injection` | Returns all the alerts containing `sql` or `injection` | +| AND search | `sql AND injection` | Returns all the alerts containing both words `sql` and `injection` | + +{% tip %} + +**Tips:** +- The multiple word search is equivalent to an OR search. +- The AND search will return results where the search terms are found _anywhere_, in any order in the alert name, description, or details. + +{% endtip %} + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-security %} +{% data reusables.repositories.sidebar-code-scanning-alerts %} +1. To the right of the **Filters** drop-down menus, type the keywords to search for in the free text search box. + ![The free text search box](/assets/images/help/repository/code-scanning-search-alerts.png) +2. Press return. The alert listing will contain the open {% data variables.product.prodname_code_scanning %} alerts matching your search criteria. + +{% endif %} + ### Fixing an alert Anyone with write permission for a repository can fix an alert by committing a correction to the code. If the repository has {% data variables.product.prodname_code_scanning %} scheduled to run on pull requests, it's best to raise a pull request with your correction. This will trigger {% data variables.product.prodname_code_scanning %} analysis of the changes and test that your fix doesn't introduce any new problems. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)" and "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." If you have write permission for a repository, you can view fixed alerts by viewing the summary of alerts and clicking **Closed**. For more information, see "[Viewing the alerts for a repository](#viewing-the-alerts-for-a-repository)." The "Closed" list shows fixed alerts and alerts that users have dismissed. +You can use{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.2" %} the free text search or{% endif %} the filters to display a subset of alerts and then in turn mark all matching alerts as closed. + Alerts may be fixed in one branch but not in another. You can use the "Branch" drop-down menu, on the summary of alerts, to check whether an alert is fixed in a particular branch. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1"%} @@ -105,7 +146,7 @@ To dismiss or delete alerts: ![Deleting alerts](/assets/images/help/repository/code-scanning-delete-alerts.png) - Optionally, you can use the filters to display a subset of alerts and then delete all matching alerts at once. For example, if you have removed a query from {% data variables.product.prodname_codeql %} analysis, you can use the "Rule" filter to list just the alerts for that query and then select and delete all of those alerts. + Optionally, you can use{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.2" %} the free text search or{% endif %} the filters to display a subset of alerts and then delete all matching alerts at once. For example, if you have removed a query from {% data variables.product.prodname_codeql %} analysis, you can use the "Rule" filter to list just the alerts for that query and then select and delete all of those alerts. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1"%} ![Filter alerts by rule](/assets/images/help/repository/code-scanning-filter-by-rule.png) diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md index c352049717..09f4af869f 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md @@ -10,8 +10,15 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Actions + - Repositories + - Containers + - Java --- diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md index ef66c08a26..37959ec4ff 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md @@ -14,8 +14,12 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - Actions + - Repositories --- diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md index 5ca44a6f23..a00836e0a5 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md @@ -11,8 +11,13 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - Pull requests + - Alerts + - Repositories --- diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md index e8896cfbd9..3d700d8930 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md @@ -11,8 +11,18 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Actions + - Troubleshooting + - Repositories + - Pull requests + - C/C++ + - C# + - Java --- diff --git a/content/code-security/secure-coding/index.md b/content/code-security/secure-coding/index.md index 9950164827..20771af9ec 100644 --- a/content/code-security/secure-coding/index.md +++ b/content/code-security/secure-coding/index.md @@ -11,7 +11,9 @@ versions: enterprise-server: '>=3.0' github-ae: '*' topics: - - Security + - Advanced Security + - Code scanning + - CodeQL children: - /automatically-scanning-your-code-for-vulnerabilities-and-errors - /integrating-with-code-scanning diff --git a/content/code-security/secure-coding/integrating-with-code-scanning/about-integration-with-code-scanning.md b/content/code-security/secure-coding/integrating-with-code-scanning/about-integration-with-code-scanning.md index 5e2e8d287c..47f95c6a79 100644 --- a/content/code-security/secure-coding/integrating-with-code-scanning/about-integration-with-code-scanning.md +++ b/content/code-security/secure-coding/integrating-with-code-scanning/about-integration-with-code-scanning.md @@ -10,8 +10,12 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: overview topics: - - Security + - Advanced Security + - Code scanning + - Webhooks + - Integration --- diff --git a/content/code-security/secure-coding/integrating-with-code-scanning/index.md b/content/code-security/secure-coding/integrating-with-code-scanning/index.md index 364bb25944..fbb1065f22 100644 --- a/content/code-security/secure-coding/integrating-with-code-scanning/index.md +++ b/content/code-security/secure-coding/integrating-with-code-scanning/index.md @@ -11,7 +11,9 @@ versions: enterprise-server: '>=3.0' github-ae: '*' topics: - - Security + - Advanced Security + - Code scanning + - Integration children: - /about-integration-with-code-scanning - /uploading-a-sarif-file-to-github diff --git a/content/code-security/secure-coding/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/content/code-security/secure-coding/integrating-with-code-scanning/sarif-support-for-code-scanning.md index 2d36b12501..0c4a5ef2f0 100644 --- a/content/code-security/secure-coding/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/content/code-security/secure-coding/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -12,8 +12,12 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: reference topics: - - Security + - Advanced Security + - Code scanning + - Integration + - SARIF --- diff --git a/content/code-security/secure-coding/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/content/code-security/secure-coding/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md index be2dd2b57b..31f592307d 100644 --- a/content/code-security/secure-coding/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/content/code-security/secure-coding/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -12,8 +12,15 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - Integration + - Actions + - Repositories + - CI + - SARIF --- diff --git a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system.md b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system.md index 17fff63d94..b8001a51df 100644 --- a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system.md +++ b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system.md @@ -8,7 +8,14 @@ versions: enterprise-server: '>=3.0' github-ae: '*' topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Repositories + - Pull requests + - Integration + - CI + - SARIF redirect_from: - /code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system --- diff --git a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md index 60026b0064..025808b169 100644 --- a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md +++ b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md @@ -13,8 +13,18 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Integration + - CI + - Repositories + - Pull requests + - C/C++ + - C# + - Java --- diff --git a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/index.md b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/index.md index 1efbc2ef8c..5fe2e55854 100644 --- a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/index.md +++ b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/index.md @@ -9,8 +9,13 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - Integration + - CI + - CodeQL children: - /about-codeql-code-scanning-in-your-ci-system - /running-codeql-cli-in-your-ci-system diff --git a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-cli-in-your-ci-system.md b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-cli-in-your-ci-system.md index 3ca4502685..e36f736b8e 100644 --- a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-cli-in-your-ci-system.md +++ b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-cli-in-your-ci-system.md @@ -7,9 +7,17 @@ miniTocMaxHeadingLevel: 4 versions: free-pro-team: '*' enterprise-server: '>=3.1' - github-ae: next + github-ae: 'next' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Repositories + - Pull requests + - Integration + - CI + - SARIF redirect_from: - /code-security/secure-coding/running-codeql-cli-in-your-ci-system --- diff --git a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md index d58df42cb3..e177799902 100644 --- a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md +++ b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md @@ -12,8 +12,16 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Repositories + - Pull requests + - Integration + - CI + - SARIF --- @@ -158,7 +166,7 @@ This example is similar to the previous example, however this time the repositor $ . /srv/checkout/example-repo-2/codeql-runner/codeql-env.sh ``` -1. Build the code. On macOS, you need to prefix the build command with the environment variable `$CODEQL_RUNNER`. For more information, see "[Troubleshooting {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system#no-code-found-during-the-build)#no-code-found-during-the-build)." +1. Build the code. On macOS, you need to prefix the build command with the environment variable `$CODEQL_RUNNER`. For more information, see "[Troubleshooting {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system#no-code-found-during-the-build)." {% data reusables.code-scanning.codeql-runner-analyze-example %} diff --git a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md index b3491880f9..288f962302 100644 --- a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md +++ b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md @@ -12,8 +12,14 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Troubleshooting + - Integration + - CI --- diff --git a/content/code-security/security-advisories/about-coordinated-disclosure-of-security-vulnerabilities.md b/content/code-security/security-advisories/about-coordinated-disclosure-of-security-vulnerabilities.md index 4338399524..e3d8411ea8 100644 --- a/content/code-security/security-advisories/about-coordinated-disclosure-of-security-vulnerabilities.md +++ b/content/code-security/security-advisories/about-coordinated-disclosure-of-security-vulnerabilities.md @@ -4,6 +4,10 @@ intro: 'Vulnerability disclosure is a coordinated effort between security report miniTocMaxHeadingLevel: 4 versions: free-pro-team: '*' +type: overview +topics: + - Security advisories + - Vulnerabilities --- ### About disclosing vulnerabilities in the industry diff --git a/content/code-security/security-advisories/about-github-security-advisories.md b/content/code-security/security-advisories/about-github-security-advisories.md index 70db6331c7..c214bf09e9 100644 --- a/content/code-security/security-advisories/about-github-security-advisories.md +++ b/content/code-security/security-advisories/about-github-security-advisories.md @@ -7,8 +7,11 @@ redirect_from: - /github/managing-security-vulnerabilities/about-github-security-advisories versions: free-pro-team: '*' +type: overview topics: - - Security + - Security advisories + - Vulnerabilities + - CVEs --- {% data reusables.repositories.security-advisory-admin-permissions %} diff --git a/content/code-security/security-advisories/adding-a-collaborator-to-a-security-advisory.md b/content/code-security/security-advisories/adding-a-collaborator-to-a-security-advisory.md index 07fc24a299..7f844c3ef4 100644 --- a/content/code-security/security-advisories/adding-a-collaborator-to-a-security-advisory.md +++ b/content/code-security/security-advisories/adding-a-collaborator-to-a-security-advisory.md @@ -7,8 +7,11 @@ redirect_from: - /github/managing-security-vulnerabilities/adding-a-collaborator-to-a-security-advisory versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Vulnerabilities + - Collaboration --- People with admin permissions to a security advisory can add collaborators to the security advisory. diff --git a/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md b/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md index 73635560ea..19f4e558a3 100644 --- a/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md +++ b/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md @@ -6,8 +6,12 @@ redirect_from: - /github/managing-security-vulnerabilities/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Vulnerabilities + - Collaboration + - Forks --- ### Prerequisites diff --git a/content/code-security/security-advisories/creating-a-security-advisory.md b/content/code-security/security-advisories/creating-a-security-advisory.md index dab420dc4a..1a0e0bf4aa 100644 --- a/content/code-security/security-advisories/creating-a-security-advisory.md +++ b/content/code-security/security-advisories/creating-a-security-advisory.md @@ -7,8 +7,10 @@ redirect_from: - /github/managing-security-vulnerabilities/creating-a-security-advisory versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Vulnerabilities --- Anyone with admin permissions to a repository can create a security advisory. diff --git a/content/code-security/security-advisories/editing-a-security-advisory.md b/content/code-security/security-advisories/editing-a-security-advisory.md index 8664ab31dc..12dab63f8d 100644 --- a/content/code-security/security-advisories/editing-a-security-advisory.md +++ b/content/code-security/security-advisories/editing-a-security-advisory.md @@ -5,8 +5,10 @@ redirect_from: - /github/managing-security-vulnerabilities/editing-a-security-advisory versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Vulnerabilities --- People with admin permissions to a security advisory can edit the security advisory. diff --git a/content/code-security/security-advisories/index.md b/content/code-security/security-advisories/index.md index 08d85d2fb3..ba5b199dde 100644 --- a/content/code-security/security-advisories/index.md +++ b/content/code-security/security-advisories/index.md @@ -8,7 +8,10 @@ redirect_from: versions: free-pro-team: '*' topics: - - Security + - Security advisories + - Vulnerabilities + - Repositories + - CVEs children: - /about-coordinated-disclosure-of-security-vulnerabilities - /about-github-security-advisories diff --git a/content/code-security/security-advisories/permission-levels-for-security-advisories.md b/content/code-security/security-advisories/permission-levels-for-security-advisories.md index a63400c572..56390ba86a 100644 --- a/content/code-security/security-advisories/permission-levels-for-security-advisories.md +++ b/content/code-security/security-advisories/permission-levels-for-security-advisories.md @@ -7,8 +7,11 @@ redirect_from: - /github/managing-security-vulnerabilities/permission-levels-for-security-advisories versions: free-pro-team: '*' +type: reference topics: - - Security + - Security advisories + - Vulnerabilities + - Permissions --- ### Permissions overview diff --git a/content/code-security/security-advisories/publishing-a-security-advisory.md b/content/code-security/security-advisories/publishing-a-security-advisory.md index e009c50cf2..a8d2fb149e 100644 --- a/content/code-security/security-advisories/publishing-a-security-advisory.md +++ b/content/code-security/security-advisories/publishing-a-security-advisory.md @@ -7,8 +7,12 @@ redirect_from: - /github/managing-security-vulnerabilities/publishing-a-security-advisory versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Vulnerabilities + - CVEs + - Repositories --- diff --git a/content/code-security/security-advisories/removing-a-collaborator-from-a-security-advisory.md b/content/code-security/security-advisories/removing-a-collaborator-from-a-security-advisory.md index e1586b3754..5692dbd270 100644 --- a/content/code-security/security-advisories/removing-a-collaborator-from-a-security-advisory.md +++ b/content/code-security/security-advisories/removing-a-collaborator-from-a-security-advisory.md @@ -5,8 +5,11 @@ redirect_from: - /github/managing-security-vulnerabilities/removing-a-collaborator-from-a-security-advisory versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Vulnerabilities + - Collaboration --- People with admin permissions to a security advisory can remove collaborators from the security advisory. diff --git a/content/code-security/security-advisories/withdrawing-a-security-advisory.md b/content/code-security/security-advisories/withdrawing-a-security-advisory.md index 79dbae768e..12270c2484 100644 --- a/content/code-security/security-advisories/withdrawing-a-security-advisory.md +++ b/content/code-security/security-advisories/withdrawing-a-security-advisory.md @@ -5,8 +5,10 @@ redirect_from: - /github/managing-security-vulnerabilities/withdrawing-a-security-advisory versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Vulnerabilities --- If you publish a security advisory in error, you can withdraw the security advisory by contacting {% data variables.contact.contact_support %}. diff --git a/content/code-security/security-overview/exploring-security-alerts.md b/content/code-security/security-overview/exploring-security-alerts.md index ffb1651a8f..4934707319 100644 --- a/content/code-security/security-overview/exploring-security-alerts.md +++ b/content/code-security/security-overview/exploring-security-alerts.md @@ -5,6 +5,13 @@ product: '{% data reusables.gated-features.security-center %}' versions: free-pro-team: '*' github-ae: 'next' +type: how_to +topics: + - Security overview + - Advanced Security + - Alerts + - Organizations + - Teams --- {% data reusables.security-center.beta %} @@ -13,7 +20,7 @@ versions: You can use the security overview for a high-level view of the security status of your organization or to identify problematic repositories that require intervention. At the organization-level, the security overview displays aggregate and repository-specific security information for repositories owned by your organization. At the team-level, the security overview displays repository-specific security information for repositories that the team has admin privileges for. For more information, see "[Managing team access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)." -The security overview indicates whether {% data variables.product.prodname_GH_advanced_security %} features are enabled for repositories owned by your organization and consolidates alerts from {% data variables.product.prodname_advanced_security %} features, including {% data variables.product.prodname_code_scanning %} alerts, {% data variables.product.prodname_dependabot_alerts %}, and {% data variables.product.prodname_secret_scanning %} alerts. For more information, see "[About securing your repository](/code-security/getting-started/about-securing-your-repository)." +The security overview indicates whether {% data variables.product.prodname_GH_advanced_security %} features are enabled for repositories owned by your organization and consolidates alerts from {% data variables.product.prodname_advanced_security %} features, including {% data variables.product.prodname_code_scanning %} alerts, {% data variables.product.prodname_dependabot_alerts %}, and {% data variables.product.prodname_secret_scanning %} alerts. For more information, see "[Securing your repository](/code-security/getting-started/securing-your-repository)" and "[Securing your organization](/code-security/getting-started/securing-your-organization)." In the security overview, you can view, sort, and filter alerts to understand the security risks in your organization and in specific repositories. You can apply multiple filters to focus on areas of interest. For example, you can identify private repositories that have a high number of {% data variables.product.prodname_dependabot_alerts %} or repositories that have no {% data variables.product.prodname_code_scanning %} alerts. diff --git a/content/code-security/security-overview/index.md b/content/code-security/security-overview/index.md index da3b8892a0..121d861380 100644 --- a/content/code-security/security-overview/index.md +++ b/content/code-security/security-overview/index.md @@ -5,7 +5,10 @@ intro: 'View, sort, and filter the security alerts from across your organization product: '{% data reusables.gated-features.security-center %}' versions: free-pro-team: '*' - github-ae: next + github-ae: 'next' +topics: + - Security overview + - Advanced Security children: - /exploring-security-alerts --- diff --git a/content/code-security/supply-chain-security/index.md b/content/code-security/supply-chain-security/index.md index 06dd68e360..26f02658df 100644 --- a/content/code-security/supply-chain-security/index.md +++ b/content/code-security/supply-chain-security/index.md @@ -9,7 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' topics: - - Security + - Dependabot + - Dependencies + - Repositories children: - /understanding-your-software-supply-chain - /keeping-your-dependencies-updated-automatically diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates.md index 8d01da1eae..8967866401 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates.md @@ -9,8 +9,13 @@ redirect_from: - /code-security/supply-chain-security/about-dependabot-version-updates versions: free-pro-team: '*' +type: overview topics: + - Dependabot + - Version updates - Repositories + - Dependencies + - Pull requests --- ### About {% data variables.product.prodname_dependabot_version_updates %} diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates.md index e8caa1a624..525ea937dd 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates.md @@ -8,8 +8,13 @@ redirect_from: miniTocMaxHeadingLevel: 4 versions: free-pro-team: '*' +type: reference topics: + - Dependabot + - Version updates - Repositories + - Dependencies + - Pull requests --- ### About the *dependabot.yml* file @@ -944,3 +949,17 @@ registries: token: ${{secrets.MY_GITHUB_PERSONAL_TOKEN}} ``` {% endraw %} + +#### `terraform-registry` + +The `terraform-registry` type supports a token. + +{% raw %} +```yaml +registries: + terraform-example: + type: terraform-registry + url: https://terraform.example.com + token: ${{secrets.MY_TERRAFORM_API_TOKEN}} +``` +{% endraw %} diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md index 3e7a411b73..31aa2d374c 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md @@ -7,8 +7,15 @@ redirect_from: - /code-security/supply-chain-security/customizing-dependency-updates versions: free-pro-team: '*' +type: how_to topics: + - Dependabot + - Version updates + - Security updates - Repositories + - Dependencies + - Pull requests + - Vulnerabilities --- ### About customizing dependency updates diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-version-updates.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-version-updates.md index db653a02a7..9ede734d6f 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-version-updates.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-version-updates.md @@ -7,8 +7,13 @@ redirect_from: - /code-security/supply-chain-security/enabling-and-disabling-version-updates versions: free-pro-team: '*' +type: how_to topics: + - Dependabot + - Version updates - Repositories + - Dependencies + - Pull requests --- diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/index.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/index.md index 946d617301..0d9fda6298 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/index.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/index.md @@ -7,6 +7,10 @@ versions: free-pro-team: '*' topics: - Repositories + - Dependabot + - Version updates + - Dependencies + - Pull requests children: - /about-dependabot-version-updates - /upgrading-from-dependabotcom-to-github-native-dependabot diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md index 1582a893f2..370462752a 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md @@ -7,8 +7,12 @@ redirect_from: - /code-security/supply-chain-security/keeping-your-actions-up-to-date-with-dependabot versions: free-pro-team: '*' +type: how_to topics: - Repositories + - Dependabot + - Version updates + - Actions --- ### About {% data variables.product.prodname_dependabot_version_updates %} for actions diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/listing-dependencies-configured-for-version-updates.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/listing-dependencies-configured-for-version-updates.md index 7e51fb81da..d36e451296 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/listing-dependencies-configured-for-version-updates.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/listing-dependencies-configured-for-version-updates.md @@ -6,8 +6,12 @@ redirect_from: - /code-security/supply-chain-security/listing-dependencies-configured-for-version-updates versions: free-pro-team: '*' +type: how_to topics: - Repositories + - Dependabot + - Version updates + - Dependencies --- ### Viewing dependencies monitored by {% data variables.product.prodname_dependabot %} diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot.md index a91e7a3de6..b9e9cdaf5b 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot.md @@ -6,6 +6,13 @@ redirect_from: - /code-security/supply-chain-security/managing-encrypted-secrets-for-dependabot versions: free-pro-team: '*' +type: how_to +topics: + - Dependabot + - Version updates + - Secret store + - Repositories + - Dependencies --- ### About encrypted secrets for {% data variables.product.prodname_dependabot %} diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md index b84c596853..e4de9c94be 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md @@ -6,8 +6,14 @@ redirect_from: - /code-security/supply-chain-security/managing-pull-requests-for-dependency-updates versions: free-pro-team: '*' +type: how_to topics: - Repositories + - Version updates + - Security updates + - Pull requests + - Dependencies + - Vulnerabilities --- ### About {% data variables.product.prodname_dependabot %} pull requests diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md index d27aa13db1..476f4ff94c 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md @@ -3,8 +3,12 @@ title: Upgrading from Dependabot.com to GitHub-native Dependabot intro: You can upgrade to GitHub-native Dependabot by merging a pull request that will allow your dependencies to continue being updated. versions: free-pro-team: '*' +type: how_to topics: - Repositories + - Dependabot + - Version updates + - Dependencies redirect_from: - /code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot --- diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md index 0947e29647..28ea3e52fc 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md @@ -9,8 +9,13 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' +type: overview topics: - - Security + - Dependabot + - Alerts + - Vulnerabilities + - Repositories + - Dependencies --- diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md index 248d7bb1de..3192e829c7 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md @@ -8,8 +8,14 @@ redirect_from: - /code-security/supply-chain-security/about-dependabot-security-updates versions: free-pro-team: '*' +type: overview topics: - - Security + - Dependabot + - Security updates + - Vulnerabilities + - Repositories + - Dependencies + - Pull requests --- diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-managing-vulnerable-dependencies.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-managing-vulnerable-dependencies.md index 2a96479ef9..bebdc22998 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-managing-vulnerable-dependencies.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-managing-vulnerable-dependencies.md @@ -6,8 +6,13 @@ redirect_from: - /code-security/supply-chain-security/about-managing-vulnerable-dependencies versions: free-pro-team: '*' +type: overview topics: - - Security + - Dependabot + - Vulnerabilities + - Repositories + - Dependencies + - Pull requests --- diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md index d5471b8dba..fac43820d6 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md @@ -7,8 +7,13 @@ redirect_from: - /code-security/supply-chain-security/browsing-security-vulnerabilities-in-the-github-advisory-database versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Alerts + - Dependabot + - Vulnerabilities + - CVEs --- diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md index 0d764859de..919f28f31b 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md @@ -11,8 +11,14 @@ redirect_from: - /code-security/supply-chain-security/configuring-dependabot-security-updates versions: free-pro-team: '*' +type: how_to topics: - - Security + - Dependabot + - Security updates + - Alerts + - Dependencies + - Pull requests + - Repositories --- diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md index f1a8d81b33..805dafad46 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md @@ -8,8 +8,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' +type: how_to topics: - - Security + - Dependabot + - Alerts + - Notifications + - Vulnerabilities + - Dependencies + - Repositories --- diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md index c11b0e35db..d1ebfc41d2 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md @@ -10,6 +10,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' +topics: + - Repositories + - Dependabot + - Version updates + - Dependencies + - Pull requests + - Vulnerabilities + - Alerts children: - /about-managing-vulnerable-dependencies - /browsing-security-vulnerabilities-in-the-github-advisory-database diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors.md index 1e80a7fc5b..2a2dc7b0ee 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors.md @@ -8,8 +8,16 @@ redirect_from: - /code-security/supply-chain-security/troubleshooting-dependabot-errors versions: free-pro-team: '*' +type: how_to topics: - - Security + - Dependabot + - Security updates + - Version updates + - Repositories + - Pull requests + - Troubleshooting + - Errors + - Dependencies --- ### About {% data variables.product.prodname_dependabot %} errors diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md index 5f9369368b..b73bc87ce1 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md @@ -8,8 +8,19 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' +type: how_to topics: - - Security + - Dependabot + - Alerts + - Troubleshooting + - Errors + - Security updates + - Dependencies + - Vulnerabilities + - Dependency graph + - Alerts + - CVEs + - Repositories --- The results of dependency detection reported by {% data variables.product.product_name %} may be different from the results returned by other tools. There are good reasons for this and it's helpful to understand how {% data variables.product.prodname_dotcom %} determines dependencies for your project. diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md index 68507ae33e..e4c339979e 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md @@ -10,8 +10,14 @@ shortTitle: Viewing and updating vulnerable dependencies versions: free-pro-team: '*' enterprise-server: '>=3.0' +type: how_to topics: - - Security + - Dependabot + - Security updates + - Alerts + - Dependencies + - Pull requests + - Repositories --- Your repository's {% data variables.product.prodname_dependabot %} alerts tab lists all open and closed {% data variables.product.prodname_dependabot_alerts %}{% if currentVersion == "free-pro-team@latest" %} and corresponding {% data variables.product.prodname_dependabot_security_updates %}{% endif %}. You can sort the list of alerts using the drop-down menu, and you can click into specific alerts for more details. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md index f3d8594362..4ad228ec86 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md @@ -3,7 +3,12 @@ title: About dependency review intro: 'Dependency review lets you catch vulnerable dependencies before you introduce them to your environment, and provides information on license, dependents, and age of dependencies.' versions: free-pro-team: '*' +type: overview topics: + - Advanced Security + - Dependency review + - Vulnerabilities + - Dependencies - Pull requests redirect_from: - /code-security/supply-chain-security/about-dependency-review diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md index 23ead0bca8..2db33ec284 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md @@ -7,7 +7,10 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' +type: overview topics: + - Dependency graph + - Dependencies - Repositories --- diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md index 5068cac8be..43100e062e 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md @@ -12,7 +12,10 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' +type: how_to topics: + - Dependency graph + - Dependencies - Repositories --- diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/index.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/index.md index e1ee0a8325..9e1bca0732 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/index.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/index.md @@ -3,6 +3,10 @@ title: Understanding your software supply chain versions: free-pro-team: '*' enterprise-server: '>=3.0' +topics: + - Dependency graph + - Dependencies + - Repositories children: - /about-the-dependency-graph - /exploring-the-dependencies-of-a-repository diff --git a/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md b/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md index 70bec916fc..d6a393c4fc 100644 --- a/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md +++ b/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md @@ -51,8 +51,10 @@ When you create a new codespace, {% data variables.product.prodname_dotcom %} cl * _install_ * _bootstrap.sh_ * _bootstrap_ +* _script/bootstrap_ * _setup.sh_ * _setup_ +* _script/setup_ If none of these files are found, then any files or folders in `dotfiles` starting with `.` are symlinked to the codespace's `~` or `$HOME` directory. diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index 8eaaef8458..95710b4ff1 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -1,6 +1,6 @@ --- title: Creating a default community health file -intro: 'You can create default community health files, such as CONTRIBUTING and CODE_OF_CONDUCT. Default files will be used for any public repository owned by the account that does not contain its own file of that type.' +intro: 'You can create default community health files, such as CONTRIBUTING and CODE_OF_CONDUCT. Default files will be used for any repository owned by the account that does not contain its own file of that type.' redirect_from: - /articles/creating-a-default-community-health-file-for-your-organization - /github/building-a-strong-community/creating-a-default-community-health-file-for-your-organization @@ -16,12 +16,12 @@ topics: You can add default community health files to the root of a public repository called `.github` that is owned by an organization{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. -{% data variables.product.product_name %} will use and display default files for any public repository owned by the account that does not have its own file of that type in any of the following places: +{% data variables.product.product_name %} will use and display default files for any repository owned by the account that does not have its own file of that type in any of the following places: - the root of the repository - the `.github` folder - the `docs` folder -For example, anyone who creates an issue or pull request in a public repository that does not have its own CONTRIBUTING file will see a link to the default CONTRIBUTING file. If a repository has any files in its own `.github/ISSUE_TEMPLATE` folder{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}, including issue templates or a *config.yml* file,{% endif %} none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used. +For example, anyone who creates an issue or pull request in a repository that does not have its own CONTRIBUTING file will see a link to the default CONTRIBUTING file. If a repository has any files in its own `.github/ISSUE_TEMPLATE` folder{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}, including issue templates or a *config.yml* file,{% endif %} none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used. Default files are not included in clones, packages, or downloads of individual repositories because they are stored only in the `.github` repository. diff --git a/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md b/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md index 91135e082a..8ebf5b6f86 100644 --- a/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md +++ b/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md @@ -10,7 +10,7 @@ versions: --- ### About {% data variables.product.prodname_desktop %} installation -You can install {% data variables.product.prodname_desktop %} on supported operating systems. If you have an account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you can connect your account to {% data variables.product.prodname_desktop %}. For more information about creating an account, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/articles/signing-up-for-a-new-github-account/)" or contact your {% data variables.product.prodname_enterprise %} site administrator. +You can install {% data variables.product.prodname_desktop %} on supported operating systems, which currently include {% data variables.desktop.mac-osx-versions %} and {% data variables.desktop.windows-versions %}. If you have an account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you can connect your account to {% data variables.product.prodname_desktop %}. For more information about creating an account, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/articles/signing-up-for-a-new-github-account/)" or contact your {% data variables.product.prodname_enterprise %} site administrator. {% windows %} diff --git a/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md b/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md index e73617e48b..565436341a 100644 --- a/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md +++ b/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md @@ -14,21 +14,30 @@ topics: ### About {% data variables.product.prodname_github_app %} URL parameters You can add query parameters to these URLs to preselect the configuration of a {% data variables.product.prodname_github_app %} on a personal or organization account: + * **User account:** `{% data variables.product.oauth_host_code %}/settings/apps/new` * **Organization account:** `{% data variables.product.oauth_host_code %}/organizations/:org/settings/apps/new` The person creating the app can edit the preselected values from the {% data variables.product.prodname_github_app %} registration page, before submitting the app. If you do not include required parameters in the URL query string, like `name`, the person creating the app will need to input a value before submitting the app. +{% if currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@next" %} +For apps that require a secret to secure their webhook, the secret's value must be set in the form by the person creating the app, not by using query parameters. For more information, see "[Securing your webhooks](/developers/webhooks-and-events/webhooks/securing-your-webhooks)." +{% endif %} + The following URL creates a new public app called `octocat-github-app` with a preconfigured description and callback URL. This URL also selects read and write permissions for `checks`, subscribes to the `check_run` and `check_suite` webhook events, and selects the option to request user authorization (OAuth) during installation: {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@next" or currentVersion ver_gt "enterprise-server@3.0" %} -``` + +```text {% data variables.product.oauth_host_code %}/settings/apps/new?name=octocat-github-app&description=An%20Octocat%20App&callback_urls[]=https://example.com&request_oauth_on_install=true&public=true&checks=write&events[]=check_run&events[]=check_suite ``` + {% else %} -``` + +```text {% data variables.product.oauth_host_code %}/settings/apps/new?name=octocat-github-app&description=An%20Octocat%20App&callback_url=https://example.com&request_oauth_on_install=true&public=true&checks=write&events[]=check_run&events[]=check_suite ``` + {% endif %} The complete list of available query parameters, permissions, and events is listed in the sections below. @@ -47,11 +56,11 @@ The complete list of available query parameters, permissions, and events is list `setup_on_update` | `boolean` | Set to `true` to redirect people to the setup URL when installations have been updated, for example, after repositories are added or removed. `public` | `boolean` | Set to `true` when your {% data variables.product.prodname_github_app %} is available to the public or `false` when it is only accessible to the owner of the app. `webhook_url` | `string` | The full URL that you would like to send webhook event payloads to. -`webhook_secret` | `string` | You can specify a secret to secure your webhooks. See "[Securing your webhooks](/webhooks/securing/)" for more details. -`events` | `array of strings` | Webhook events. Some webhook events require `read` or `write` permissions for a resource before you can select the event when registering a new {% data variables.product.prodname_github_app %}. See the "[{% data variables.product.prodname_github_app %} webhook events](#github-app-webhook-events)" section for available events and their required permissions. You can select multiple events in a query string. For example, `events[]=public&events[]=label`. +{% if currentVersion ver_lt "enterprise-server@3.2" or currentVersion == "github-ae@latest" %}`webhook_secret` | `string` | You can specify a secret to secure your webhooks. See "[Securing your webhooks](/webhooks/securing/)" for more details. +{% endif %}`events` | `array of strings` | Webhook events. Some webhook events require `read` or `write` permissions for a resource before you can select the event when registering a new {% data variables.product.prodname_github_app %}. See the "[{% data variables.product.prodname_github_app %} webhook events](#github-app-webhook-events)" section for available events and their required permissions. You can select multiple events in a query string. For example, `events[]=public&events[]=label`. `domain` | `string` | The URL of a content reference. `single_file_name` | `string` | This is a narrowly-scoped permission that allows the app to access a single file in any repository. When you set the `single_file` permission to `read` or `write`, this field provides the path to the single file your {% data variables.product.prodname_github_app %} will manage. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} If you need to manage multiple files, see `single_file_paths` below. {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} -`single_file_paths` | `array of strings` | This allows the app to access up ten specified files in a repository. When you set the `single_file` permission to `read` or `write`, this array can store the paths for up to ten files that your {% data variables.product.prodname_github_app %} will manage. These files all receive the same permission set by `single_file`, and do not have separate individual permissions. When two or more files are configured, the API returns `multiple_single_files=true`, otherwise it returns `multiple_single_files=false`.{% endif %} +`single_file_paths` | `array of strings` | This allows the app to access up ten specified files in a repository. When you set the `single_file` permission to `read` or `write`, this array can store the paths for up to ten files that your {% data variables.product.prodname_github_app %} will manage. These files all receive the same permission set by `single_file`, and do not have separate individual permissions. When two or more files are configured, the API returns `multiple_single_files=true`, otherwise it returns `multiple_single_files=false`.{% endif %} ### {% data variables.product.prodname_github_app %} permissions diff --git a/content/developers/apps/guides/using-content-attachments.md b/content/developers/apps/guides/using-content-attachments.md index 406cfcaefb..2ad873ee87 100644 --- a/content/developers/apps/guides/using-content-attachments.md +++ b/content/developers/apps/guides/using-content-attachments.md @@ -68,7 +68,7 @@ The `body` parameter can contain markdown: ```shell curl -X POST \ - https://api.github.com/Codertocat/Hello-World/content_references/17/attachments \ + https://api.github.com/repos/Codertocat/Hello-World/content_references/17/attachments \ -H 'Accept: application/vnd.github.corsair-preview+json' \ -H 'Authorization: Bearer $INSTALLATION_TOKEN' \ -d '{ @@ -160,7 +160,7 @@ To create a Probot App, follow these steps: await context.github.request({ method: 'POST', headers: { accept: 'application/vnd.github.corsair-preview+json' }, - url: `/${context.payload.repository.full_name}/content_references/${context.payload.content_reference.id}/attachments`, + url: `/repos/${context.payload.repository.full_name}/content_references/${context.payload.content_reference.id}/attachments`, // Parameters title: '[A-1234] Error found in core/models.py file', body: 'You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\nself.save()' diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md index 77bec30c4a..c4897b9add 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md @@ -13,12 +13,33 @@ versions: {% data variables.product.prodname_campus_program %} is a package of premium {% data variables.product.prodname_dotcom %} access for teaching-focused institutions that grant degrees, diplomas, or certificates. {% data variables.product.prodname_campus_program %} includes: - No-cost access to {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %} for all of your technical and academic departments -- Teacher training to master Git and {% data variables.product.prodname_dotcom %} with our Campus Advisor program +- 50,000 {% data variables.product.prodname_actions %} minutes and 50 GB {% data variables.product.prodname_registry %} storage +- Teacher training to master Git and {% data variables.product.prodname_dotcom %} with our [Campus Advisor program](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/about-campus-advisors) - Exclusive access to new features, GitHub Education-specific swag, and free developer tools from {% data variables.product.prodname_dotcom %} partners - Automated access to premium {% data variables.product.prodname_education %} features, like the {% data variables.product.prodname_student_pack %} -Any school that can agree to the [terms of the program](https://education.github.com/schools/terms) is welcome to join. +To read about how GitHub is used by educators, see [GitHub Education stories.](https://education.github.com/stories) + +### {% data variables.product.prodname_campus_program %} terms and conditions + +- The license is free for one year and will automatically renew for free every 2 years. You may continue on the free license so long as you continue to operate within the terms of the agreement. Any school that can agree to the [terms of the program](https://education.github.com/schools/terms) is welcome to join. + +- Please note that the licenses are for use by the whole school. Internal IT departments, academic research groups, collaborators, students, and other non-academic departments are eligible to use the licenses so long as they are not making a profit from its use. Externally funded research groups that are housed at the university may not use the free licenses. + +- You must offer {% data variables.product.prodname_dotcom %} to all of your technical and academic departments and your school’s logo will be shared on the GitHub Education website as a {% data variables.product.prodname_campus_program %} Partner. + +- New organizations in your enterprise are automatically added to your enterprise account. To add organizations that existed before your school joined the {% data variables.product.prodname_campus_program %}, please contact [GitHub Education Support](https://support.github.com/contact/education). For more information about administrating your enterprise, see "[Setting up and managing your enterprise](/github/setting-up-and-managing-your-enterprise)." New organizations in your enterprise are automatically added to your enterprise account. To add organizations that existed before your school joined the {% data variables.product.prodname_campus_program %}, please contact GitHub Education Support. + + +To read more about {% data variables.product.prodname_dotcom %}'s privacy practices, see ["Global Privacy Practices"](/github/site-policy/global-privacy-practices) + +### {% data variables.product.prodname_campus_program %} Application Eligibility + +- Often times, a campus CTO/CIO, Dean, Department Chair, or Technology Officer signs the terms of the program on behalf of the campus. + +- If your school does not issue email addresses, {% data variables.product.prodname_dotcom %} will reach out to your account administrators with an alternative option to allow you to distribute the student developer pack to your students. For more information, see the [official {% data variables.product.prodname_campus_program %}](https://education.github.com/schools) page. -If you're a student or academic faculty and your school isn't partnered with {% data variables.product.prodname_dotcom %} as a {% data variables.product.prodname_campus_program %} school, then you can still individually apply for discounts to use {% data variables.product.prodname_dotcom %}. For more information, see "[Use {% data variables.product.prodname_dotcom %} for your schoolwork](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork)" or "[Use {% data variables.product.prodname_dotcom %} in your classroom and research](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-in-your-classroom-and-research/)." +If you're a student or academic faculty and your school isn't partnered with {% data variables.product.prodname_dotcom %} as a {% data variables.product.prodname_campus_program %} school, then you can still individually apply for discounts to use {% data variables.product.prodname_dotcom %}. To apply for the Student Developer Pack, [see the application form](https://education.github.com/pack/join). + diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md index faae07451a..9e1c37690f 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md @@ -59,8 +59,10 @@ If your course already has a roster, you can update the students on the roster o {% data reusables.classroom.click-students %} 1. To connect {% data variables.product.prodname_classroom %} to your LMS and import a roster, click {% octicon "mortar-board" aria-label="The mortar board icon" %} **Import from a learning management system** and follow the instructions. For more information, see "[Connect a learning management system to {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)." !["Import from a learning management system" button](/assets/images/help/classroom/click-import-from-a-learning-management-system-button.png) -1. To create a roster manually, type your student identifiers. Optionally, click **Upload a CSV or text file** to upload a file containing the identifiers. - ![Text field for typing student identifiers and "Upload a CSV or text file" button](/assets/images/help/classroom/type-or-upload-student-identifiers.png) +1. Provide the student identifiers for your roster. + - To import a roster by uploading a file containing student identifiers, click **Upload a CSV or text file**. + - To create a roster manually, type your student identifiers. + ![Text field for typing student identifiers and "Upload a CSV or text file" button](/assets/images/help/classroom/type-or-upload-student-identifiers.png) 1. Click **Create roster**. !["Create roster" button](/assets/images/help/classroom/click-create-roster-button.png) diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md b/content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md index 12c920336a..78f4c382a7 100644 --- a/content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md +++ b/content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md @@ -25,7 +25,7 @@ You can choose the default branch for a repository. The default branch is the ba {% endnote %} {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} You can also rename the default branch. For more information, see "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)." diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository/renaming-a-branch.md b/content/github/administering-a-repository/managing-branches-in-your-repository/renaming-a-branch.md index 8991e75833..def3ed1b1a 100644 --- a/content/github/administering-a-repository/managing-branches-in-your-repository/renaming-a-branch.md +++ b/content/github/administering-a-repository/managing-branches-in-your-repository/renaming-a-branch.md @@ -4,7 +4,7 @@ intro: You can change the name of a branch in a repository. permissions: People with write permissions to a repository can rename a branch in the repository. People with admin permissions can rename the default branch. versions: free-pro-team: '*' - enterprise-server: '>=3.2' + enterprise-server: '>=3.1' topics: - Repositories redirect_from: @@ -18,7 +18,7 @@ When you rename a branch on {% data variables.product.product_location %}, any U Although file URLs are automatically redirected, raw file URLs are not redirected. Also, {% data variables.product.prodname_dotcom %} does not perform any redirects if users perform a `git pull` for the previous branch name. -{% data variables.product.prodname_actions %} workflows do not follow renames, so if your repository publishes an action, anyone using that action with `@{old-branch-name}` will break. You should consider adding a new branch with the original content plus an additional commit reporting that the banch name is deprecated and suggesting that users migrate to the new branch name. +{% data variables.product.prodname_actions %} workflows do not follow renames, so if your repository publishes an action, anyone using that action with `@{old-branch-name}` will break. You should consider adding a new branch with the original content plus an additional commit reporting that the branch name is deprecated and suggesting that users migrate to the new branch name. ### Renaming a branch diff --git a/content/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository.md b/content/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository.md index 6dcb49d8c2..aaf3de1a8f 100644 --- a/content/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository.md +++ b/content/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository.md @@ -12,7 +12,13 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: + - Dependabot + - Alerts + - Advanced Security + - Dependency graph + - Secret scanning - Repositories --- {% if currentVersion == "free-pro-team@latest" %} @@ -104,5 +110,5 @@ Organization owners and repository administrators can only grant access to view ### Further reading -- "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)" +- "[Securing your repository](/code-security/getting-started/securing-your-repository)" - "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" diff --git a/content/github/administering-a-repository/managing-repository-settings/setting-repository-visibility.md b/content/github/administering-a-repository/managing-repository-settings/setting-repository-visibility.md index fe6a28813c..6660cc035f 100644 --- a/content/github/administering-a-repository/managing-repository-settings/setting-repository-visibility.md +++ b/content/github/administering-a-repository/managing-repository-settings/setting-repository-visibility.md @@ -20,6 +20,20 @@ Organization owners can restrict the ability to change repository visibility to We recommend reviewing the following caveats before you change the visibility of a repository. +{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} + +{% warning %} + +**Warning:** Changes to the visibility of a large repository or repository network may affect data integrity. Visibility changes can also have unintended effects on forks. {% data variables.product.company_short %} recommends the following before changing the visibility of a repository network. + +- Wait for a period of reduced activity on {% data variables.product.product_location %}. + +- Contact your {% if enterpriseServerVersions contains currentVersion %}site administrator{% elsif currentVersion == "github-ae@latest" %}enterprise owner{% endif %} before proceeding. Your {% if enterpriseServerVersions contains currentVersion %}site administrator{% elsif currentVersion == "github-ae@latest" %}enterprise owner{% endif %} can contact {% data variables.contact.contact_ent_support %} for further guidance. + +{% endwarning %} + +{% endif %} + #### Making a repository private {% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %} * {% data variables.product.product_name %} will detach public forks of the public repository and put them into a new network. Public forks are not made private.{% endif %} @@ -52,7 +66,7 @@ We recommend reviewing the following caveats before you change the visibility of * If you're converting your private repository to a public repository as part of a move toward creating an open source project, see the [Open Source Guides](http://opensource.guide) for helpful tips and guidelines. You can also take a free course on managing an open source project with [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). Once your repository is public, you can also view your repository's community profile to see whether your project meets best practices for supporting contributors. For more information, see "[Viewing your community profile](/articles/viewing-your-community-profile)." * The repository will automatically gain access to {% data variables.product.prodname_GH_advanced_security %} features. -For information about improving repository security, see "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)."{% endif %} +For information about improving repository security, see "[Securing your repository](/code-security/getting-started/securing-your-repository)."{% endif %} {% endif %} diff --git a/content/github/authenticating-to-github/index.md b/content/github/authenticating-to-github/index.md index da0c8d0f60..b148d49abb 100644 --- a/content/github/authenticating-to-github/index.md +++ b/content/github/authenticating-to-github/index.md @@ -18,7 +18,7 @@ versions: enterprise-server: '*' github-ae: '*' topics: - - 2fa + - 2FA - Identity - Access management - Usernames diff --git a/content/github/authenticating-to-github/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md b/content/github/authenticating-to-github/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md index f8170cbe79..f8014fa5e3 100644 --- a/content/github/authenticating-to-github/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md +++ b/content/github/authenticating-to-github/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md @@ -21,8 +21,11 @@ topics: 2. Enter the email address associated with your personal {% data variables.product.product_name %} account, then click **Send password reset email.** The email will be sent to the backup email address if you have one configured. ![Password reset email request dialog](/assets/images/help/settings/password-recovery-email-request.png) 3. We'll email you a link that will allow you to reset your password. You must click on this link within 3 hours of receiving the email. If you didn't receive an email from us, make sure to check your spam folder. -4. After clicking on the link in your email, you'll be asked to enter a new password. - ![Password recovery box](/assets/images/help/settings/password_recovery_page.png) +4. If you have enabled two-factor authentication, you will be prompted for your 2FA credentials. Type your 2FA credentials or one of your 2FA recovery codes and click **Verify**. + ![Two-factor authentication prompt](/assets/images/help/2fa/2fa-password-reset.png) +5. Type a new password, confirm your new password, and click **Change password**. For help creating a strong password, see "[Creating a strong password](/articles/creating-a-strong-password)." + {% if currentVersion == "free-pro-team@latest" %}![Password recovery box](/assets/images/help/settings/password-recovery-page.png){% else %} + ![Password recovery box](/assets/images/enterprise/settings/password-recovery-page.png){% endif %} {% tip %} diff --git a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md index 1d606c9943..fdd3188522 100644 --- a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md +++ b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md @@ -8,7 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' topics: - - 2fa + - 2FA --- For {% data variables.product.product_name %}, the second form of authentication is a code that's generated by an application on your mobile device{% if currentVersion == "free-pro-team@latest" %} or sent as a text message (SMS){% endif %}. After you enable 2FA, {% data variables.product.product_name %} generates an authentication code any time someone attempts to sign into your {% data variables.product.product_name %} account. The only way someone can sign into your account is if they know both your password and have access to the authentication code on your phone. diff --git a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md index 29b4e76fc8..dfe25fe708 100644 --- a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md +++ b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md @@ -11,7 +11,7 @@ versions: free-pro-team: '*' enterprise-server: '*' topics: - - 2fa + - 2FA --- With two-factor authentication enabled, you'll need to provide an authentication code when accessing {% data variables.product.product_name %} through your browser. If you access {% data variables.product.product_name %} using other methods, such as the API or the command line, you'll need to use an alternative form of authentication. For more information, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/about-authentication-to-github)." diff --git a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md index 6524b7a8a3..0fd2837baf 100644 --- a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md +++ b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md @@ -8,7 +8,7 @@ redirect_from: versions: free-pro-team: '*' topics: - - 2fa + - 2FA --- {% note %} diff --git a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods.md b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods.md index f9e9d4ed5b..ba0f98eb02 100644 --- a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods.md +++ b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods.md @@ -13,7 +13,7 @@ versions: free-pro-team: '*' enterprise-server: '*' topics: - - 2fa + - 2FA --- In addition to securely storing your two-factor authentication recovery codes, we strongly recommend configuring one or more additional recovery methods. diff --git a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md index 3189aa3b15..58e5ea2ad4 100644 --- a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md +++ b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md @@ -11,7 +11,7 @@ versions: free-pro-team: '*' enterprise-server: '*' topics: - - 2fa + - 2FA --- You can configure two-factor authentication using a mobile app{% if currentVersion == "free-pro-team@latest" %} or via text message{% endif %}. You can also add a security key. diff --git a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported.md b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported.md index 1230bcb8dc..71f6b4e2d4 100644 --- a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported.md +++ b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported.md @@ -7,7 +7,7 @@ redirect_from: versions: free-pro-team: '*' topics: - - 2fa + - 2FA --- If we don't support two-factor authentication via text message for your country of residence, you can set up authentication via a TOTP mobile application. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)." diff --git a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md index c733c4d604..c1ef7998b7 100644 --- a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md +++ b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md @@ -8,7 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' topics: - - 2fa + - 2FA --- We strongly recommend using two-factor authentication to secure your account. If you need to disable 2FA, we recommend re-enabling it as soon as possible. diff --git a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/index.md b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/index.md index 1dde6ff69e..5cb69a8555 100644 --- a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/index.md +++ b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/index.md @@ -9,7 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' topics: - - 2fa + - 2FA children: - /about-two-factor-authentication - /configuring-two-factor-authentication diff --git a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md index 6737e6471c..b488bde6a8 100644 --- a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md +++ b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md @@ -10,7 +10,7 @@ versions: free-pro-team: '*' enterprise-server: '*' topics: - - 2fa + - 2FA --- {% if currentVersion == "free-pro-team@latest" %} @@ -46,7 +46,8 @@ If you configured two-factor authentication using a security key, you can use yo {% if currentVersion == "free-pro-team@latest" %} ### Authenticating with a verified device, SSH token, or personal access token -If you lose access to the two-factor authentication credentials and don't have your two-factor authentication recovery codes, you can have a one-time password sent to your verified email address to begin the verification process and regain access to your account. + +If you know your {% data variables.product.product_name %} password but don't have the two-factor authentication credentials or your two-factor authentication recovery codes, you can have a one-time password sent to your verified email address to begin the verification process and regain access to your account. {% note %} @@ -56,7 +57,7 @@ If you lose access to the two-factor authentication credentials and don't have y You can use your two-factor authentication credentials or two-factor authentication recovery codes to regain access to your account anytime during the 3-5 day waiting period. -{% data reusables.two_fa.username-password %} +1. Type your username and password to prompt authentication. If you do not know your {% data variables.product.product_name %} password, you will not be able to generate a one-time password. 2. Under "Having Problems?", click **Can't access your two factor device or valid recovery codes?** ![Link if you don't have your 2fa device or recovery codes](/assets/images/help/2fa/no-access-link.png) 3. Click **I understand, get started** to request a reset of your authentication settings. diff --git a/content/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md b/content/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md index be9ea3449d..cd8ea1906a 100644 --- a/content/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md +++ b/content/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md @@ -3,8 +3,13 @@ title: Reviewing dependency changes in a pull request intro: 'If a pull request contains changes to dependencies, you can view a summary of what has changed and whether there are known vulnerabilities in any of the dependencies.' versions: free-pro-team: '*' +type: how_to topics: - Pull requests + - Dependency review + - Advanced Security + - Vulnerabilities + - Dependencies redirect_from: - /github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request - /github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request diff --git a/content/github/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md b/content/github/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md index a211155626..967292d662 100644 --- a/content/github/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md +++ b/content/github/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md @@ -49,9 +49,9 @@ We strongly discourage force pushing, since this changes the history of your rep **Changing the message of the most recently pushed commit** 1. Follow the [steps above](/articles/changing-a-commit-message#commit-has-not-been-pushed-online) to amend the commit message. -2. Use the `push --force` command to force push over the old commit. +2. Use the `push --force-with-lease` command to force push over the old commit. ```shell - $ git push --force example-branch + $ git push --force-with-lease example-branch ``` **Changing the message of older or multiple commit messages** diff --git a/content/github/getting-started-with-github/exploring-projects-on-github/saving-repositories-with-stars.md b/content/github/getting-started-with-github/exploring-projects-on-github/saving-repositories-with-stars.md index d5c788b9fa..5ffcebc578 100644 --- a/content/github/getting-started-with-github/exploring-projects-on-github/saving-repositories-with-stars.md +++ b/content/github/getting-started-with-github/exploring-projects-on-github/saving-repositories-with-stars.md @@ -15,39 +15,49 @@ versions: topics: - Repositories --- -You can search, sort, and filter your starred repositories and topics on your {% data variables.explore.your_stars_page %}.' +You can search, sort, and filter your starred repositories and topics on your {% data variables.explore.your_stars_page %}. ### About stars Starring makes it easy to find a repository or topic again later. You can see all the repositories and topics you have starred by going to your {% data variables.explore.your_stars_page %}. {% if currentVersion == "free-pro-team@latest" %} -You can star repositories and topics to discover similar projects on {% data variables.product.product_name %}. When you star repositories or topics, {% data variables.product.product_name %} may recommend related content in the discovery view of your news feed. For more information, see "[Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)." +You can star repositories and topics to discover similar projects on {% data variables.product.product_name %}. When you star repositories or topics, {% data variables.product.product_name %} may recommend related content in the discovery view of your news feed. For more information, see "[Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)". {% endif %} Starring a repository also shows appreciation to the repository maintainer for their work. Many of {% data variables.product.prodname_dotcom %}'s repository rankings depend on the number of stars a repository has. In addition, [Explore](https://github.com/explore) shows popular repositories based on the number of stars they have. +### Starring a repository + +Starring a repository is a simple two-step process. + +{% data reusables.repositories.navigate-to-repo %} +1. In the top-right corner of the page, click **Star**. +![Starring a repository](/assets/images/help/stars/starring-a-repository.png) +1. Optionally, to unstar a previously starred repository, click **Unstar**. +![Untarring a repository](/assets/images/help/stars/unstarring-a-repository.png) + ### Searching stars +You can use the search bar on your {% data variables.explore.your_stars_page %} to quickly find repositories and topics you've starred. + +1. Go to your {% data variables.explore.your_stars_page %}. +1. Use the search bar to find your starred repositories or topics by their name. ![Searching through stars](/assets/images/help/stars/stars_search_bar.png) -You can use the search bar to quickly find repositories and topics you've starred. The search bar only searches based on the name of a repository or topic, and not on any other qualifiers (such as the size of the repository or when it was last updated). +The search bar only searches based on the name of a repository or topic, and not on any other qualifiers (such as the size of the repository or when it was last updated). ### Sorting and filtering stars +You can use sorting or filtering to customize how you see starred repositories and topics on your stars page. + +1. Go to your {% data variables.explore.your_stars_page %}. +1. To sort stars, select the **Sort** drop-down menu, then select **Recently starred**, **Recently active**, or **Most stars**. ![Sorting stars](/assets/images/help/stars/stars_sort_menu.png) - -In the upper-right corner of your stars page, you can sort your starred repositories and topics by recently starred, recently active, and most stars. - -On the right side of the page, you can filter your list of starred repositories based on their language. - +1. To filter your list of stars based on their language, click on the desired language under **Filter by languages**. ![Filter stars by language](/assets/images/help/stars/stars_filter_language.png) - -### Browsing your friends' stars - - In the lower-right corner of the page, you can also browse your friends' stars. You can use this to find new repositories and topics to star. - -![Viewing your friends' stars](/assets/images/help/stars/stars_jump_to_a_friend.png) +1. To filter your list of stars based on repository or topic, click on the desired option. +![Filter stars by topic](/assets/images/help/stars/stars_filter_topic.png) ### Further reading diff --git a/content/github/getting-started-with-github/getting-started-with-git/caching-your-github-credentials-in-git.md b/content/github/getting-started-with-github/getting-started-with-git/caching-your-github-credentials-in-git.md index 5165823fbb..421d52615e 100644 --- a/content/github/getting-started-with-github/getting-started-with-git/caching-your-github-credentials-in-git.md +++ b/content/github/getting-started-with-github/getting-started-with-git/caching-your-github-credentials-in-git.md @@ -95,6 +95,8 @@ Turn on the credential helper so that Git will save your password in memory for # Set the cache to timeout after 1 hour (setting is in seconds) ``` +For more options for storing your credentials on Linux, see [Credential Storage](https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage) in Pro Git. + {% endlinux %} ### Further reading diff --git a/content/github/getting-started-with-github/learning-about-github/about-github-advanced-security.md b/content/github/getting-started-with-github/learning-about-github/about-github-advanced-security.md index 3f3e662e15..34e99e77e7 100644 --- a/content/github/getting-started-with-github/learning-about-github/about-github-advanced-security.md +++ b/content/github/getting-started-with-github/learning-about-github/about-github-advanced-security.md @@ -29,7 +29,7 @@ A {% data variables.product.prodname_GH_advanced_security %} license provides th - **Dependency review** - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)." {% endif %} -For information about {% data variables.product.prodname_advanced_security %} features that are in development, see "[{% data variables.product.prodname_dotcom %} public roadmap](https://github.com/github/roadmap)." For an overview of all security features, see "[About securing your repository](/github/administering-a-repository/about-securing-your-repository#setting-up-your-repository-securely)." +For information about {% data variables.product.prodname_advanced_security %} features that are in development, see "[{% data variables.product.prodname_dotcom %} public roadmap](https://github.com/github/roadmap)." For an overview of all security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)." {% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.product_name %} diff --git a/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md index c05df1885b..2fb1200184 100644 --- a/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md @@ -141,7 +141,7 @@ You can disable some of the badges for {% data variables.product.prodname_dotcom ### List of qualifying repositories for Mars 2020 Helicopter Contributor badge -If you authored any commit(s) present in the commit history for the listed tag of one or more of the repositories below, you'll receive the Mars 2020 Helicopter Contributor badge on your profile. The authored commit must be with a verified email address, associated with your account at the time {% data variables.product.prodname_dotcom %} determined the eligible contributions, in order to be attributed to you. Future changes to verified emails will not have an effect on the badge. We built the list based on information received from NASA's Jet Propulsion Laboratory. +If you authored any commit(s) present in the commit history for the listed tag of one or more of the repositories below, you'll receive the Mars 2020 Helicopter Contributor badge on your profile. The authored commit must be with a verified email address, associated with your account at the time {% data variables.product.prodname_dotcom %} determined the eligible contributions, in order to be attributed to you. You can be the original author or [one of the co-authors](/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors) of the commit. Future changes to verified emails will not have an effect on the badge. We built the list based on information received from NASA's Jet Propulsion Laboratory. | {% data variables.product.prodname_dotcom %} Repository | Version | Tag | |---|---|---| @@ -212,7 +212,7 @@ If you authored any commit(s) present in the commit history for the listed tag o | [HdrHistogram/HdrHistogram](https://github.com/HdrHistogram/HdrHistogram) | 2.1.9 | [HdrHistogram-2.1.9](https://github.com/HdrHistogram/HdrHistogram/releases/tag/HdrHistogram-2.1.9) | | [locationtech/spatial4j](https://github.com/locationtech/spatial4j) | 0.7 | [spatial4j-0.7](https://github.com/locationtech/spatial4j/releases/tag/spatial4j-0.7) | | [locationtech/jts](https://github.com/locationtech/jts) | 1.15.0 | [jts-1.15.0](https://github.com/locationtech/jts/releases/tag/jts-1.15.0) | -| [apache/log4j](https://github.com/apache/log4j) | 2.11 | [v1_2_11](https://github.com/apache/log4j/releases/tag/v1_2_11) | +| [apache/logging-log4j2](https://github.com/apache/logging-log4j2) | 2.11 | [log4j-2.11.0](https://github.com/apache/logging-log4j2/releases/tag/log4j-2.11.0) | ### Further reading diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-security-and-analysis-settings-for-your-user-account.md b/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-security-and-analysis-settings-for-your-user-account.md index 4fa1d5675f..14a5b1ae0e 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-security-and-analysis-settings-for-your-user-account.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-security-and-analysis-settings-for-your-user-account.md @@ -18,7 +18,7 @@ You can still manage the security and analysis features for individual repositor {% data reusables.security.security-and-analysis-features-enable-read-only %} -For an overview of repository-level security, see "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)." +For an overview of repository-level security, see "[Securing your repository](/code-security/getting-started/securing-your-repository)." ### Enabling or disabling features for existing repositories diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md b/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md index 478b73c7c8..a650b3b22c 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md @@ -31,7 +31,7 @@ The repository owner has full control of the repository. In addition to the acti | :- | :- | | {% if currentVersion == "free-pro-team@latest" %}Invite collaborators{% else %}Add collaborators{% endif %} | "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)" | | Change the visibility of the repository | "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)" |{% if currentVersion == "free-pro-team@latest" %} -| Limit interactions with the repository | "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)" |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" %} +| Limit interactions with the repository | "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)" |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} | Rename a branch, including the default branch | "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)" |{% endif %} | Merge a pull request on a protected branch, even if there are no approving reviews | "[About protected branches](/github/administering-a-repository/about-protected-branches)" | | Delete the repository | "[Deleting a repository](/github/administering-a-repository/deleting-a-repository)" | diff --git a/content/github/site-policy/dmca-takedown-policy.md b/content/github/site-policy/dmca-takedown-policy.md index 05b3bb5538..2c42ece488 100644 --- a/content/github/site-policy/dmca-takedown-policy.md +++ b/content/github/site-policy/dmca-takedown-policy.md @@ -27,6 +27,8 @@ The DMCA provides a safe harbor for service providers that host user-generated c The DMCA addresses this issue by creating a [copyright liability safe harbor](https://www.copyright.gov/title17/92chap5.html#512) for internet service providers hosting allegedly infringing user-generated content. Essentially, so long as a service provider follows the DMCA's notice-and-takedown rules, it won't be liable for copyright infringement based on user-generated content. Because of this, it is important for GitHub to maintain its DMCA safe-harbor status. +The DMCA also prohibits the [circumvention of technical measures](https://www.copyright.gov/title17/92chap12.html) that effectively control access to works protected by copyright. + ### DMCA Notices In a Nutshell The DMCA provides two simple, straightforward procedures that all GitHub users should know about: (i) a [takedown-notice](/articles/guide-to-submitting-a-dmca-takedown-notice) procedure for copyright holders to request that content be removed; and (ii) a [counter-notice](/articles/guide-to-submitting-a-dmca-counter-notice) procedure for users to get content reenabled when content is taken down by mistake or misidentification. @@ -66,23 +68,40 @@ One of the best features of GitHub is the ability for users to "fork" one anothe GitHub *will not* automatically disable forks when disabling a parent repository. This is because forks belong to different users, may have been altered in significant ways, and may be licensed or used in a different way that is protected by the fair-use doctrine. GitHub does not conduct any independent investigation into forks. We expect copyright owners to conduct that investigation and, if they believe that the forks are also infringing, expressly include forks in their takedown notice. -In rare cases, you may be alleging copyright infringement in a full repository that is actively being forked. If at the time that you submitted your notice, you identified all existing forks of that repository as allegedly infringing, we would process a valid claim against all forks in that network at the time we process the notice. We would do this given the likelihood that all newly created forks would contain the same content. In addition, if the reported network that contains the allegedly infringing content is larger than one hundred (100) repositories and thus would be difficult to review in its entirety, we may consider disabling the entire network if you state in your notice that, "Based on the representative number of forks you have reviewed, I believe that all or most of the forks are infringing to the same extent as the parent repository." Your sworn statement would apply to this statement. +In rare cases, you may be alleging copyright infringement in a full repository that is actively being forked. If at the time that you submitted your notice, you identified all existing forks of that repository as allegedly infringing, we would process a valid claim against all forks in that network at the time we process the notice. We would do this given the likelihood that all newly created forks would contain the same content. In addition, if the reported network that contains the allegedly infringing content is larger than one hundred (100) repositories and thus would be difficult to review in its entirety, we may consider disabling the entire network if you state in your notice that, "Based on the representative number of forks I have reviewed, I believe that all or most of the forks are infringing to the same extent as the parent repository." Your sworn statement would apply to this statement. -### C. What If I Inadvertently Missed the Window to Make Changes? +### C. What about Circumvention Claims? + +The DMCA prohibits the [circumvention of technical measures](https://www.copyright.gov/title17/92chap12.html) that effectively control access to works protected by copyright. Given that these types of claims are often highly technical in nature, GitHub requires claimants to provide [detailed information about these claims](/github/site-policy/guide-to-submitting-a-dmca-takedown-notice#complaints-about-anti-circumvention-technology), and we undertake a more extensive review. + +A circumvention claim must include the following details about the technical measures in place and the manner in which the accused project circumvents them. Specifically, the notice to GitHub must include detailed statements that describe: +1. What the technical measures are; +2. How they effectively control access to the copyrighted material; and +3. How the accused project is designed to circumvent their previously described technological protection measures. + +GitHub will review circumvention claims closely, including by both technical and legal experts. In the technical review, we will seek to validate the details about the manner in which the technical protection measures operate and the way the project allegedly circumvents them. In the legal review, we will seek to ensure that the claims do not extend beyond the boundaries of the DMCA. In cases where we are unable to determine whether a claim is valid, we will err on the side of the developer, and leave the content up. If the claimant wishes to follow up with additional detail, we would start the review process again to evaluate the revised claims. + +Where our experts determine that a claim is complete, legal, and technically legitimate, we will contact the repository owner and give them a chance to respond to the claim or make changes to the repo to avoid a takedown. If they do not respond, we will attempt to contact the repository owner again before taking any further steps. In other words, we will not disable a repository based on a claim of circumvention technology without attempting to contact a repository owner to give them a chance to respond or make changes first. If we are unable to resolve the issue by reaching out to the repository owner first, we will always be happy to consider a response from the repository owner even after the content has been disabled if they would like an opportunity to dispute the claim, present us with additional facts, or make changes to have the content restored. When we need to disable content, we will ensure that repository owners can export their issues and pull requests and other repository data that do not contain the alleged circumvention code to the extent legally possible. + +Please note, our review process for circumvention technology does not apply to content that would otherwise violate our Acceptable Use Policy restrictions against sharing unauthorized product licensing keys, software for generating unauthorized product licensing keys, or software for bypassing checks for product licensing keys. Although these types of claims may also violate the DMCA provisions on circumvention technology, these are typically straightforward and do not warrant additional technical and legal review. Nonetheless, where a claim is not straightforward, for example in the case of jailbreaks, the circumvention technology claim review process would apply. + +When GitHub processes a DMCA takedown under our circumvention technology claim review process, we will offer to connect the repository owner with legal resources, in case the repository owner wishes to obtain third party legal advice. + +### D. What If I Inadvertently Missed the Window to Make Changes? We recognize that there are many valid reasons that you may not be able to make changes within the window of approximately 1 business day we provide before your repository gets disabled. Maybe our message got flagged as spam, maybe you were on vacation, maybe you don't check that email account regularly, or maybe you were just busy. We get it. If you respond to let us know that you would have liked to make the changes, but somehow missed the first opportunity, we will re-enable the repository one additional time for approximately 1 business day to allow you to make the changes. Again, you must notify us that you have made the changes in order to keep the repository enabled after that window of approximately 1 business day, as noted above in [Step A.4](#a-how-does-this-actually-work). Please note that we will only provide this one additional chance. -### D. Transparency +### E. Transparency We believe that transparency is a virtue. The public should know what content is being removed from GitHub and why. An informed public can notice and surface potential issues that would otherwise go unnoticed in an opaque system. We post redacted copies of any legal notices we receive (including original notices, counter notices or retractions) at . We will not publicly publish your personal contact information; we will remove personal information (except for usernames in URLs) before publishing notices. We will not, however, redact any other information from your notice unless you specifically ask us to. Here are some examples of a published [notice](https://github.com/github/dmca/blob/master/2014/2014-05-28-Delicious-Brains.md) and [counter notice](https://github.com/github/dmca/blob/master/2014/2014-05-01-Pushwoosh-SDK-counternotice.md) for you to see what they look like. When we remove content, we will post a link to the related notice in its place. Please also note that, although we will not publicly publish unredacted notices, we may provide a complete unredacted copy of any notices we receive directly to any party whose rights would be affected by it. -### E. Repeated Infringement +### F. Repeated Infringement It is the policy of GitHub, in appropriate circumstances and in its sole discretion, to disable and terminate the accounts of users who may infringe upon the copyrights or other intellectual property rights of GitHub or others. -### F. Submitting Notices +### G. Submitting Notices If you are ready to submit a notice or a counter notice: - [How to Submit a DMCA Notice](/articles/guide-to-submitting-a-dmca-takedown-notice) diff --git a/content/github/site-policy/github-acceptable-use-policies.md b/content/github/site-policy/github-acceptable-use-policies.md index 1867db65ce..b0e0861d23 100644 --- a/content/github/site-policy/github-acceptable-use-policies.md +++ b/content/github/site-policy/github-acceptable-use-policies.md @@ -31,7 +31,9 @@ Under no circumstances will Users upload, post, host, execute, or transmit any C - is or contains false, inaccurate, or intentionally deceptive information that is likely to adversely affect the public interest (including health, safety, election integrity, and civic participation); -- contains or installs any active malware or exploits, or uses our platform for exploit delivery (such as part of a command and control system); or +- contains or installs any active malware or exploits, or uses our platform for exploit delivery (such as part of a command and control system); + +- shares unauthorized product licensing keys, software for generating unauthorized product licensing keys, or software for bypassing checks for product licensing keys, including extension of a free license beyond its trial period; or - infringes any proprietary right of any party, including patent, trademark, trade secret, copyright, right of publicity, or other right. diff --git a/content/github/site-policy/github-additional-product-terms.md b/content/github/site-policy/github-additional-product-terms.md deleted file mode 100644 index 69fb523266..0000000000 --- a/content/github/site-policy/github-additional-product-terms.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: GitHub Additional Product Terms -versions: - free-pro-team: '*' -topics: - - Policy - - Legal ---- - -Version Effective Date: February 22, 2021 - -When you create an Account, you're given access to lots of different features and products that are all a part of the Service. Because many of these features and products offer different functionality, they may require additional terms and conditions specific to that feature or product. Below, we've listed those features and products, along with the corresponding additional terms that apply to your use of them. - -Your use of the Service is subject to your applicable terms (the "Agreement"). By using additional products and features, you also agree to these Additional Product Terms. Any violation of the Additional Product Terms is a violation of the Agreement. Capitalized terms not defined in the Additional Product Terms will have the meaning given to them in the Agreement. - -If you are using GitHub AE, then you may only access the following features and products: Third Party Integrations, Git LFS Support, Pages. - -### 1. Marketplace - -If you list a Developer Product through GitHub Marketplace, then you must agree to the [GitHub Marketplace Developer Agreement](/github/site-policy/github-marketplace-developer-agreement), prior to submitting the project to be listed. - -If you buy Developer Products through GitHub Marketplace, the [GitHub Marketplace Terms of Service](/github/site-policy/github-marketplace-terms-of-service) controls your purchase. The Agreement, as well as the [GitHub Marketplace Terms of Service](/github/site-policy/github-marketplace-terms-of-service), will govern your use of GitHub Marketplace. - -### 2. Third Party Integrations - -#### a. Creating Applications -If you create a third-party application or other developer product that collects User Personal Information or User-Generated Content and integrates with the Service through GitHub's API, OAuth mechanism, or otherwise ("Developer Product"), and make it available for other Users, then you must comply with the following requirements: -- You must comply with this Agreement and the GitHub Privacy Statement. -- Except as otherwise permitted, such as by law or by a license, you must limit your usage of the User Personal Information or User-Generated Content you collect to that purpose for which the User has authorized its collection. -- You must take all reasonable security measures appropriate to the risks, such as against accidental or unlawful destruction, or accidental loss, alteration, unauthorized disclosure or access, presented by processing the User Personal Information or User-Generated Content. -- You must not hold yourself out as collecting any User Personal Information or User-Generated Content on GitHub’s behalf, and provide sufficient notice of your privacy practices to the User, such as by posting a privacy policy. -- You must provide Users with a method of deleting any User Personal Information or User-Generated Content you have collected through GitHub after it is no longer needed for the limited and specified purposes for which the User authorized its collection, except where retention is required by law or otherwise permitted, such as through a license. - -#### b. Using Third-Party Applications -You may grant a Developer Product authorization to use, access, and disclose the contents of your repositories, including your private repositories. Some Developer Products are available through [GitHub Marketplace](https://github.com/marketplace). Some Developer Products can be used for performing automated tasks, and often times multiple Users may direct the actions of a Developer Product. However, if you purchase and/or set up a Developer Product on your Account, or you are an owner of an Account with an integrated Developer Product, then you will be responsible for the Developer Product's actions that are performed on or through your Account. Please see our [Privacy Statement](/github/site-policy/github-privacy-statement#third-party-applications) for more information about how we share data with Developer Products. - -**GitHub makes no warranties of any kind in relation to Developer Products and is not liable for disclosures to third parties that you authorize to access Your Content. Your use of any third-party applications is at your sole risk.** - -### 3. Git LFS Support - -If you enable Git Large File Storage ("Git LFS") on your Account, you'll be able to fetch, modify, and push large files just as you would expect with any file that Git manages. Your Account comes with a certain amount of bandwidth and storage for use with Git LFS, which can be found in the [Git LFS documentation](/github/managing-large-files/about-storage-and-bandwidth-usage). Git LFS bandwidth and storage usage is displayed within your [account settings](https://github.com/settings/billing). If you want to use Git LFS beyond your allotted bandwidth and storage, then you may [purchase additional data packs](/billing/managing-billing-for-git-large-file-storage/upgrading-git-large-file-storage). - -### 4. Pages - -Each Account comes with access to the [GitHub Pages static hosting service](/github/working-with-github-pages/about-github-pages). This hosting service is intended to host static web pages for All Users, but primarily as a showcase for personal and organizational projects. - -GitHub Pages is not intended for or allowed to be used as a free web hosting service to run your online business, e-commerce site, or any other website that is primarily directed at either facilitating commercial transactions or providing commercial software as a service (SaaS). Some monetization efforts are permitted on Pages, such as donation buttons and crowdfunding links. - -#### a. Bandwidth and Usage Limits -GitHub Pages are subject to some specific bandwidth and usage limits, and may not be appropriate for some high-bandwidth uses. Please see our [GitHub Pages guidelines](/github/working-with-github-pages/about-github-pages) for more information. - -#### b. Prohibited Uses -Prohibited uses of GitHub Pages include -- Content or activity that is illegal or otherwise prohibited by our [Terms of Service](/github/site-policy/github-terms-of-service), [Acceptable Use Policies](/github/site-policy/github-acceptable-use-policies) or [Community Guidelines](/github/site-policy/github-community-guidelines) -- Violent or threatening content or activity -- Excessive automated bulk activity (for example, spamming) -- Activity that compromises GitHub users or GitHub services -- Get-rich-quick schemes -- Sexually obscene content -- Content that misrepresents your identity or site purpose - -If you have questions about whether your use or intended use falls into these categories, please contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com/). GitHub reserves the right at all times to reclaim any GitHub subdomain without liability. - -### 5. Actions and Packages - -#### a. Actions Usage -GitHub Actions is billed on a usage basis. The [Actions documentation](/actions) includes details, including compute and storage quantities (depending on your Account plan), and how to monitor your Actions minutes usage and set usage limits. - -Actions and any elements of the Actions service may not be used in violation of the Agreement, the [GitHub Acceptable Use Polices](/github/site-policy/github-acceptable-use-policies), or the GitHub Actions service limitations set forth in the [Actions documentation](/actions). Additionally, Actions should not be used for: -- cryptomining; -- using our servers to disrupt, or to gain or to attempt to gain unauthorized access to, any service, device, data, account, or network (other than those authorized by the [GitHub Bug Bounty program](https://bounty.github.com)); -- the provision of a stand-alone or integrated application or service offering Actions or any elements of Actions for commercial purposes; -- any activity that places a burden on our servers, where that burden is disproportionate to the benefits provided to users (for example, don't use Actions as a content delivery network or as part of a serverless application, but a low benefit Action could be ok if it’s also low burden); or -- any other activity unrelated to the production, testing, deployment, or publication of the software project associated with the repository where GitHub Actions are used. - -In order to prevent violations of these limitations and abuse of GitHub Actions, GitHub may monitor your use of GitHub Actions. Misuse of GitHub Actions may result in termination of jobs, restrictions in your ability to use GitHub Actions, or the disabling of repositories created to run Actions in a way that violates these Terms. - -#### b. Packages Usage -GitHub Packages is billed on a usage basis. The [Packages documentation](/packages) includes details, including bandwidth and storage quantities (depending on your Account plan), and how to monitor your Packages usage and set usage limits. Packages bandwidth usage is limited by the [GitHub Acceptable Use Polices](/github/site-policy/github-acceptable-use-policies). - -### 6. Learning Lab - -**Enrollment.** To complete enrollment in Learning Lab for Organizations, you agree to create a separate organization for Learning Lab purposes, and you authorize us to add Learning Lab course materials to that organization on your behalf. - -**Learning Lab Course Materials.** Any course materials GitHub provides are owned solely by GitHub; provided, however, that GitHub grants you a worldwide, non-exclusive, limited-term, non-transferable, royalty-free license to copy, maintain, use and run such course materials for your internal business purposes associated with Learning Lab use. This license grant is subject to any additional open source licensing agreements that may be provided along with the source code. Course materials you create are owned solely by you, provided, however, that you grant to GitHub a worldwide, non-exclusive, perpetual, non-transferable, royalty-free license to copy, maintain, use, host, and run (as applicable) on the Service, such course materials. Your use of GitHub course materials and your creation and storage of your own course materials does not constitute joint ownership in either party's respective intellectual property by the other party. - -**Privacy.** Learning Lab may collect personal information. You control what information Learning Lab collects in your GitHub.com profile settings panel. If Learning Lab collects personal information on GitHub's behalf, GitHub will process that information in accordance with the [GitHub Privacy Statement](/github/site-policy/github-privacy-statement). If you enroll in or are completing a private course through Learning Lab, GitHub may share your enrollment information and course progress through completion with the organization admins. This may include individual data such as your GitHub username, course start date, and course end date. Course completion data may also be presented in aggregate form to help guide improvements to the course content. - -### 7. Connect - -In order to access GitHub Connect, Customer must have at least one (1) Account on GitHub.com and one (1) licensed instance of the Software. Customer's access to and use of github.com through Connect is governed by its Agreement applicable to its use of the Service. GitHub Connect may be used for performing automated tasks. In addition, multiple Users may direct certain actions with GitHub Connect. Customer is responsible for actions that are performed on or through its Accounts. GitHub may collect information about how Customer uses GitHub Connect to provide and improve the feature. By using GitHub Connect, Customer authorizes GitHub to collect protected data, which includes Private Repository data and User Personal Information (as defined in the GitHub Privacy Statement), from Customer’s Accounts. Customer also authorizes the transfer of identifying instance information to GitHub through GitHub Connect, which information is governed by the GitHub Privacy Statement. - -### 8. Sponsors Program - -In order to become a Sponsored Developer, you must agree to the [GitHub Sponsors Program Additional Terms](/github/site-policy/github-sponsors-additional-terms). - -### 9. GitHub Advanced Security - -GitHub Advanced Security is licensed on a "Unique Committer" basis. A "Unique Committer" is a licensed user of GitHub Enterprise, GitHub Enterprise Cloud, GitHub Enterprise Server, or GitHub AE, who has made a code commit in the last 90 days to any repository with any GitHub Advanced Security functionality activated. You must acquire a GitHub Advanced Security User license for each of your Unique Committers. You may only use GitHub Advanced Security on codebases that are developed by or for you. If you are using GitHub Advanced Security as part of GitHub Enterprise Cloud, many features of GitHub Advanced Security, including automated code scanning of private repositories, also require the use of GitHub Actions. - -### 10. Dependabot Preview - -Your use of Dependabot Preview is governed by a separate [Terms of Service](https://dependabot.com/terms) and [Privacy Policy](https://dependabot.com/privacy). - -### 11. Spectrum - -Your use of Spectrum is governed by the GitHub [Terms of Service](/github/site-policy/github-terms-of-service) and [Privacy Statement](/github/site-policy/github-privacy-statement). - -### 12. Advisory Database - -#### a. License Grant to Us - -We need the legal right to submit your contributions to the GitHub Advisory Database into public domain datasets such as the [National Vulnerability Database](https://nvd.nist.gov/) and to license the GitHub Advisory Database under open terms for use by security researchers, the open source community, industry, and the public. You agree to release your contributions to the GitHub Advisory Database under the [Creative Commons Zero license](https://creativecommons.org/publicdomain/zero/1.0/). - -#### b. License to the GitHub Advisory Database - -The GitHub Advisory Database is licensed under the [Creative Commons Attribution 4.0 license](https://creativecommons.org/licenses/by/4.0/). The attribution term may be fulfilled by linking to the GitHub Advisory Database at or to individual GitHub Advisory Database records used, prefixed by . - -### 13. GitHub Enterprise Server - -#### a. SQL Server Images - -You may download Microsoft SQL Server Standard Edition container image for Linux files ("SQL Server Images"). You must uninstall the SQL Server Images when your right to use the Software ends. Microsoft Corporation may disable SQL Server Images at any time. - -#### b. Third-party components - -The Software includes components licensed to GitHub by third parties, including software whose licenses require GitHub to make the source code for those components available. The source code for such components will be provided upon request. diff --git a/content/github/site-policy/github-terms-for-additional-products-and-features.md b/content/github/site-policy/github-terms-for-additional-products-and-features.md new file mode 100644 index 0000000000..4869ce6753 --- /dev/null +++ b/content/github/site-policy/github-terms-for-additional-products-and-features.md @@ -0,0 +1,109 @@ +--- +title: GitHub Terms for Additional Products and Features +redirect_from: + - /github/site-policy/github-additional-product-terms +versions: + free-pro-team: '*' +topics: + - Policy + - Legal +--- + +Version Effective Date: May 26, 2021 + +When you use GitHub, you may be given access to lots of additional products and features ("Additional Products and Features"). Because many of the Additional Products and Features offer different functionality, specific terms for that product or feature may apply in addition to your main agreement with us—the GitHub Terms of Service, GitHub Corporate Terms of Service, GitHub General Terms, or Microsoft volume licensing agreement (each, the "Agreement"). Below, we've listed those products and features, along with the corresponding additional terms that apply to your use of them. + +By using the Additional Products and Features, you also agree to the applicable GitHub Terms for Additional Products and Features listed below. A violation of these GitHub terms for Additional Product and Features is a violation of the Agreement. Capitalized terms not defined here have the meaning given in the Agreement. + +**For Enterprise users** +- **GitHub Enterprise Cloud** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Codespaces, Dependabot Preview, Learning Lab, Octoshift, Packages and Pages. + +- **GitHub Enterprise Server** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Connect, Dependabot Preview, Learning Lab, Octoshift, Packages, Pages and SQL Server Images. + +- **GitHub AE** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, {% if currentVersion == "github-ae@next" %}Connect, {% endif %}Dependabot Preview, Octoshift, Packages and Pages. + +### Actions +GitHub Actions enables you to create custom software development lifecycle workflows directly in your GitHub repository. Actions is billed on a usage basis. The [Actions documentation](/actions) includes details, including compute and storage quantities (depending on your Account plan), and how to monitor your Actions minutes usage and set usage limits. + +Actions and any elements of the Actions service may not be used in violation of the Agreement, the [GitHub Acceptable Use Polices](/github/site-policy/github-acceptable-use-policies), or the GitHub Actions service limitations set forth in the [Actions documentation](/actions/reference/usage-limits-billing-and-administration). Additionally, Actions should not be used for: +- cryptomining; +- using our servers to disrupt, or to gain or to attempt to gain unauthorized access to, any service, device, data, account, or network (other than those authorized by the [GitHub Bug Bounty program](https://bounty.github.com)); +- the provision of a stand-alone or integrated application or service offering Actions or any elements of Actions for commercial purposes; +- any activity that places a burden on our servers, where that burden is disproportionate to the benefits provided to users (for example, don't use Actions as a content delivery network or as part of a serverless application, but a low benefit Action could be ok if it’s also low burden); or +- any other activity unrelated to the production, testing, deployment, or publication of the software project associated with the repository where GitHub Actions are used. + +In order to prevent violations of these limitations and abuse of GitHub Actions, GitHub may monitor your use of GitHub Actions. Misuse of GitHub Actions may result in termination of jobs, restrictions in your ability to use GitHub Actions, or the disabling of repositories created to run Actions in a way that violates these Terms. + + +### Advanced Security +GitHub makes extra security features available to customers under an Advanced Security license. These features include code scanning, secret scanning, and dependency review. The [Advanced Security documentation](/github/getting-started-with-github/about-github-advanced-security) provides more details. + +Advanced Security is licensed on a "Unique Committer" basis. A "Unique Committer" is a licensed user of GitHub Enterprise, GitHub Enterprise Cloud, GitHub Enterprise Server, or GitHub AE, who has made a code commit in the last 90 days to any repository with any GitHub Advanced Security functionality activated. You must acquire a GitHub Advanced Security User license for each of your Unique Committers. You may only use GitHub Advanced Security on codebases that are developed by or for you. For GitHub Enterprise Cloud users, some Advanced Security features also require the use of GitHub Actions. + +### Advisory Database +The GitHub Advisory Database allows you to browse or search for vulnerabilities that affect open source projects on GitHub. + +_License Grant to Us_ + +We need the legal right to submit your contributions to the GitHub Advisory Database into public domain datasets such as the [National Vulnerability Database](https://nvd.nist.gov/) and to license the GitHub Advisory Database under open terms for use by security researchers, the open source community, industry, and the public. You agree to release your contributions to the GitHub Advisory Database under the [Creative Commons Zero license](https://creativecommons.org/publicdomain/zero/1.0/). + +_License to the GitHub Advisory Database_ + +The GitHub Advisory Database is licensed under the [Creative Commons Attribution 4.0 license](https://creativecommons.org/licenses/by/4.0/). The attribution term may be fulfilled by linking to the GitHub Advisory Database at or to individual GitHub Advisory Database records used, prefixed by . + +### Connect +With GitHub Connect, you can share certain features and data between your GitHub Enterprise Server {% if currentVersion == "github-ae@next" %}or GitHub AE {% endif %}instance and your GitHub Enterprise Cloud organization or enterprise account on GitHub.com. In order to enable GitHub Connect, you must have at least one (1) account on GitHub Enterprise Cloud or GitHub.com, and one (1) licensed instance of GitHub Enterprise Server{% if currentVersion == "github-ae@next" %} or GitHub AE{% endif %}. Your use of GitHub Enterprise Cloud or GitHub.com through Connect is governed by the terms under which you license GitHub Enterprise Cloud or GitHub.com. Use of Personal Data is governed by the [GitHub Privacy Statement](/github/site-policy/github-privacy-statement). + +### Dependabot Preview +You can use Dependabot to keep the packages you use updated to the latest versions. Your use of Dependabot Preview is governed by a separate [Terms of Service](https://dependabot.com/terms) and [Privacy Policy](https://dependabot.com/privacy). + +### Learning Lab +GitHub Learning Lab offers free interactive courses that are built into GitHub with instant automated feedback and help. + +*Course Materials.* GitHub owns course materials that it provides and grants you a worldwide, non-exclusive, limited-term, non-transferable, royalty-free license to copy, maintain, use and run such course materials for your internal business purposes associated with Learning Lab use. + +Open source license terms may apply to portions of source code provided in the course materials. + +You own course materials that you create and grant GitHub a worldwide, non-exclusive, perpetual, non-transferable, royalty-free license to copy, maintain, use, host, and run such course materials. + +The use of GitHub course materials and creation and storage of your own course materials do not constitute joint ownership to either party's respective intellectual property. + +Use of Personal Data is governed by the [GitHub Privacy Statement](/github/site-policy/github-privacy-statement). + +### npm +npm is a software package hosting service that allows you to host your software packages privately or publicly and use packages as dependencies in your projects. npm is the registry of record for the JavaScript ecosystem. The npm public registry is free to use but customers are billed if they want to publish private packages or manage private packages using teams. The [npm documentation](https://docs.npmjs.com/) includes details about the limitation of account types and how to manage [private packages](https://docs.npmjs.com/about-private-packages) and [organizations](https://docs.npmjs.com/organizations). Acceptable use of the npm registry is outlined in the [open-source terms](https://www.npmjs.com/policies/open-source-terms). There are supplementary terms for both the npm [solo](https://www.npmjs.com/policies/solo-plan) and [org](https://www.npmjs.com/policies/orgs-plan) plans. The npm [Terms of Use](https://www.npmjs.com/policies/terms) apply to your use of npm. + +### Octoshift +Octoshift is a framework for exporting data from other sources to be imported to the GitHub platform. Octoshift is provided “AS-IS”. + +### Packages +GitHub Packages is a software package hosting service that allows you to host your software packages privately or publicly and use packages as dependencies in your projects. GitHub Packages is billed on a usage basis. The [Packages documentation](/packages/learn-github-packages/introduction-to-github-packages) includes details, including bandwidth and storage quantities (depending on your Account plan), and how to monitor your Packages usage and set usage limits. Packages bandwidth usage is limited by the [GitHub Acceptable Use Polices](/github/site-policy/github-acceptable-use-policies). + +### Pages + +Each Account comes with access to the [GitHub Pages static hosting service](/github/working-with-github-pages/about-github-pages). GitHub Pages is intended to host static web pages, but primarily as a showcase for personal and organizational projects. + +GitHub Pages is not intended for or allowed to be used as a free web hosting service to run your online business, e-commerce site, or any other website that is primarily directed at either facilitating commercial transactions or providing commercial software as a service (SaaS). Some monetization efforts are permitted on Pages, such as donation buttons and crowdfunding links. + +#### a. Bandwidth and Usage Limits +GitHub Pages are subject to some specific bandwidth and usage limits, and may not be appropriate for some high-bandwidth uses. Please see our [GitHub Pages guidelines](/github/working-with-github-pages/about-github-pages) for more information. + +#### b. Prohibited Uses +Prohibited uses of GitHub Pages include +- Content or activity that is illegal or otherwise prohibited by our [Terms of Service](/github/site-policy/github-terms-of-service), [Acceptable Use Policies](/github/site-policy/github-acceptable-use-policies) or [Community Guidelines](/github/site-policy/github-community-guidelines) +- Violent or threatening content or activity +- Excessive automated bulk activity (for example, spamming) +- Activity that compromises GitHub users or GitHub services +- Get-rich-quick schemes +- Sexually obscene content +- Content that misrepresents your identity or site purpose + +If you have questions about whether your use or intended use falls into these categories, please contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com/). GitHub reserves the right at all times to reclaim any GitHub subdomain without liability. + +### Sponsors Program + +GitHub Sponsors allows the developer community to financially support the people and organizations who design, build, and maintain the open source projects they depend on, directly on GitHub. In order to become a Sponsored Developer, you must agree to the [GitHub Sponsors Program Additional Terms](/github/site-policy/github-sponsors-additional-terms). + +### SQL Server Images + +You may download Microsoft SQL Server Standard Edition container image for Linux files ("SQL Server Images"). You must uninstall the SQL Server Images when your right to use the Software ends. Microsoft Corporation may disable SQL Server Images at any time. diff --git a/content/github/site-policy/guide-to-submitting-a-dmca-takedown-notice.md b/content/github/site-policy/guide-to-submitting-a-dmca-takedown-notice.md index d2a5d0f82f..d2494ab6d9 100644 --- a/content/github/site-policy/guide-to-submitting-a-dmca-takedown-notice.md +++ b/content/github/site-policy/guide-to-submitting-a-dmca-takedown-notice.md @@ -73,7 +73,10 @@ GitHub exercises little discretion in the process other than determining whether ### Complaints about Anti-Circumvention Technology -The Copyright Act also prohibits the circumvention of technological measures that effectively control access to works protected by copyright. If you believe that content hosted on GitHub violates this prohibition, please send us a report through our {% data variables.contact.contact_dmca %}, and include specific information about what content violates that prohibition, what technological measures you had in place, and why the content violates the prohibition. +The Copyright Act also prohibits the circumvention of technological measures that effectively control access to works protected by copyright. If you believe that content hosted on GitHub violates this prohibition, please send us a report through our {% data variables.contact.contact_dmca %}. A circumvention claim must include the following details about the technical measures in place and the manner in which the accused project circumvents them. Specifically, the notice to GitHub must include detailed statements that describe: +1. What the technical measures are; +2. How they effectively control access to the copyrighted material; and +3. How the accused project is designed to circumvent their previously described technological protection measures. ### How to Submit Your Complaint diff --git a/content/github/site-policy/index.md b/content/github/site-policy/index.md index 8b9664b7e4..144b71b8d3 100644 --- a/content/github/site-policy/index.md +++ b/content/github/site-policy/index.md @@ -16,7 +16,7 @@ children: - /global-privacy-practices - /github-insights-and-data-protection-for-your-organization - /github-sponsors-additional-terms - - /github-additional-product-terms + - /github-terms-for-additional-products-and-features - /github-logo-policy - /github-username-policy - /submitting-content-removal-requests @@ -50,4 +50,3 @@ children: - /github-event-code-of-conduct - /github-gpl-cooperation-commitment --- - diff --git a/content/github/writing-on-github/index.md b/content/github/writing-on-github/index.md index c5c59645bb..7dfdcaae03 100644 --- a/content/github/writing-on-github/index.md +++ b/content/github/writing-on-github/index.md @@ -5,6 +5,7 @@ redirect_from: - /articles/github-flavored-markdown/ - /articles/writing-on-github/ - /categories/writing-on-github +intro: 'You can structure the information shared on {% data variables.product.product_name %} with various formatting options.' versions: free-pro-team: '*' enterprise-server: '*' @@ -15,4 +16,3 @@ children: - /working-with-saved-replies - /editing-and-sharing-content-with-gists --- - diff --git a/content/issues/index.md b/content/issues/index.md index 2c90a52df9..dcc6bd2276 100644 --- a/content/issues/index.md +++ b/content/issues/index.md @@ -1,7 +1,7 @@ --- -title: Issues and Projects -shortTitle: Issues and Projects -intro: Use issues and projects to manage your work on {% data variables.product.prodname_dotcom %} +title: Issues and projects +shortTitle: Issues and projects +intro: Use issues and projects to manage your work on {% data variables.product.prodname_dotcom %}. versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization.md index af44d60838..a2e911da2f 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization.md @@ -149,7 +149,7 @@ You can manage access to {% data variables.product.prodname_GH_advanced_security ### Further reading -- "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)" +- "[Securing your repository](/code-security/getting-started/securing-your-repository)" - "[About secret scanning](/github/administering-a-repository/about-secret-scanning)"{% if currentVersion == "free-pro-team@latest" %} - "[Keeping your dependencies updated automatically](/github/administering-a-repository/keeping-your-dependencies-updated-automatically)"{% endif %}{% if currentVersion != "github-ae@latest" %} - "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)" diff --git a/content/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization.md b/content/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization.md index 1fe4a31162..ef375f63ef 100644 --- a/content/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization.md +++ b/content/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization.md @@ -112,7 +112,7 @@ In addition to managing organization-level settings, organization owners have ad | Make a repository a template (see "[Creating a template repository](/articles/creating-a-template-repository)") | | | | | **X** | | Change a repository's settings | | | | | **X** | | Manage team and collaborator access to the repository | | | | | **X** | -| Edit the repository's default branch | | | | | **X** |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" %} +| Edit the repository's default branch | | | | | **X** |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} | Rename the repository's default branch (see "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)") | | | | | **X** | | Rename a branch other than the repository's default branch (see "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)") | | | **X** | **X** | **X** |{% endif %} | Manage webhooks and deploy keys | | | | | **X** |{% if currentVersion == "free-pro-team@latest" %} diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index 9f7e9cabc8..c0f268adf8 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -100,7 +100,7 @@ When using an apex domain, we recommend configuring your {% data variables.produ To set up a `www` subdomain alongside the apex domain, you must first configure an apex domain, which will create an `ALIAS`, `ANAME`, or `A` record with your DNS provider. For more information, see "[Configuring an apex domain](#configuring-an-apex-domain)." -After you configure the apex domain, you must to configure a CNAME record with your DNS provider. +After you configure the apex domain, you must configure a CNAME record with your DNS provider. 1. Navigate to your DNS provider and create a `CNAME` record that points `www.example.com` to the default domain for your site: `.github.io` or `.github.io`. Do not include the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} 2. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your `www` subdomain variant. diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md index ac1383ed32..c6952a580b 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md @@ -45,6 +45,11 @@ Your theme includes default layouts, includes, and stylesheets that will automat {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_file_change %} +{% data reusables.files.choose_pull_request %} +{% data reusables.files.merge_pull_request %} +{% data reusables.files.write_commit_message_pull_request %} +{% data reusables.files.confirm_merge %} +{% data reusables.files.delete_branch %} ### Adding a new post to your site @@ -64,6 +69,11 @@ Your theme includes default layouts, includes, and stylesheets that will automat {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_file_change %} +{% data reusables.files.choose_pull_request %} +{% data reusables.files.merge_pull_request %} +{% data reusables.files.write_commit_message_pull_request %} +{% data reusables.files.confirm_merge %} +{% data reusables.files.delete_branch %} Your post should now be up on your site! If the base URL of your site is `https://octocat.github.io`, then your new post will be located at `https://octocat.github.io/YYYY/MM/DD/TITLE.html`. diff --git a/content/rest/overview/libraries.md b/content/rest/overview/libraries.md index ae3d3f5e07..e97d3bd1f1 100644 --- a/content/rest/overview/libraries.md +++ b/content/rest/overview/libraries.md @@ -101,14 +101,10 @@ Library name | Repository | metacpan Website for the Library Library name | Repository |---|---| -**GitHub PHP Client**|[tan-tan-kanarek/github-php-client](https://github.com/tan-tan-kanarek/github-php-client) **PHP GitHub API**|[KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api) **GitHub API**|[yiiext/github-api](https://github.com/yiiext/github-api) **GitHub Joomla! Package**|[joomla-framework/github-api](https://github.com/joomla-framework/github-api) -**GitHub Nette Extension**|[kdyby/github](https://github.com/kdyby/github) -**GitHub API Easy Access**|[milo/github-api](https://github.com/milo/github-api) **GitHub bridge for Laravel**|[GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub) -**PHP7 Client & WebHook wrapper**|[FlexyProject/GitHubAPI](https://github.com/FlexyProject/GitHubAPI) ### PowerShell diff --git a/content/rest/reference/code-scanning.md b/content/rest/reference/code-scanning.md index 56f7a494cc..11833f581a 100644 --- a/content/rest/reference/code-scanning.md +++ b/content/rest/reference/code-scanning.md @@ -7,8 +7,11 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +type: reference topics: - API + - Code scanning + - REST --- {% data reusables.code-scanning.beta %} diff --git a/content/rest/reference/repos.md b/content/rest/reference/repos.md index 550c0eec06..b9b984d3c1 100644 --- a/content/rest/reference/repos.md +++ b/content/rest/reference/repos.md @@ -369,4 +369,4 @@ Name | Type | Description ``hub.mode``|`string` | **Required**. Either `subscribe` or `unsubscribe`. ``hub.topic``|`string` |**Required**. The URI of the GitHub repository to subscribe to. The path must be in the format of `/{owner}/{repo}/events/{event}`. ``hub.callback``|`string` | The URI to receive the updates to the topic. -``hub.secret``|`string` | A shared secret key that generates a SHA1 HMAC of the outgoing body content. You can verify a push came from GitHub by comparing the raw request body with the contents of the `X-Hub-Signature` header. You can see [the PubSubHubbub documentation](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) for more details. +``hub.secret``|`string` | A shared secret key that generates a hash signature of the outgoing body content. You can verify a push came from GitHub by comparing the raw request body with the contents of the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}`X-Hub-Signature` or `X-Hub-Signature-256` headers{% elsif currentVersion ver_lt "enterprise-server@2.23" %}`X-Hub-Signature` header{% elsif currentVersion == "github-ae@latest" %}`X-Hub-Signature-256` header{% endif %}. You can see [the PubSubHubbub documentation](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) for more details. diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md index 7f5f951ecd..035f3d8ec5 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md @@ -23,6 +23,12 @@ topics: {% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.navigate-to-sponsor-tiers-tab %} +1. If you are setting up tiers for the first time, we recommend you review the suggested tier examples to see how some other open source contributors have set up {% data variables.product.prodname_sponsors %}. Decide whether you want to start with some suggested draft tiers, which you can customize in the tier editor. + - To use a suggested tier, select the rewards you'd like to include in your draft tier or tiers. Then, click **Continue to tier editor**. + - To create tiers without using with any of the draft suggestions, click **Skip this step**. + !["Skip this step" option and "Continue to tier editor" button](/assets/images/help/sponsors/tier-editor-button.png) +1. Optionally, to edit a draft tier, find the draft tier and click **Edit**. + ![Edit button next to draft tier](/assets/images/help/sponsors/draft-tier-edit.png) {% data reusables.sponsors.click-add-tier %} {% data reusables.sponsors.tier-price-description %} {% data reusables.sponsors.save-tier-draft %} @@ -33,6 +39,11 @@ topics: {% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.navigate-to-sponsor-tiers-tab %} {% data reusables.sponsors.edit-tier %} + {% note %} + + **Note:** To see ideas of tier descriptions, scroll down. + + {% endnote %} {% data reusables.sponsors.tier-price-description %} {% data reusables.sponsors.tier-update %} {% data reusables.sponsors.retire-tier %} diff --git a/data/allowed-topics.js b/data/allowed-topics.js index be77a0493c..d0cafc9144 100644 --- a/data/allowed-topics.js +++ b/data/allowed-topics.js @@ -11,132 +11,149 @@ // content and/or content strategy team for review. module.exports = [ - '2fa', + '2FA', + 'Access management', + 'Accounts', 'Action development', 'Actions', 'Administrator', 'Advanced Security', + 'Alerts', 'Amazon ECS', + 'Analytics', 'Android', 'Ant', - 'Analytics', 'API', 'Auditing', 'Authentication', 'Azure App Service', 'Azure Pipelines', 'Backups', + 'Billing', + 'C/C++', + 'C#', 'Cancellation', 'CD', 'CI', 'CircleCI', + 'CLI', 'Clustering', + 'Code scanning', + 'CodeQL', + 'Codespaces', + 'Collaboration', + 'Community', 'Contacting sponsors', 'Containers', - 'Code scanning', - 'Codespaces', + 'CVEs', + 'Dependabot', + 'Dependencies', + 'Dependency graph', + 'Dependency review', + 'Desktop', 'Developer', + 'Device verification', + 'Discounts', 'Discussions', 'Docker', 'Downgrades', + 'Early access', 'Education', - 'Events', + 'Enterprise', 'Errors', + 'Events', + 'Forks', 'Fundamentals', 'Git', + 'GitHub Apps', 'GitHub Connect', + 'GitHub search', + 'GitHub', 'GitLab', 'Google Kubernetes Engine', 'Gradle', 'GraphQL', + 'Health', 'High availability', + 'Identity', 'Infrastructure', + 'Integration', 'iOS', + 'Issues', 'Java', 'JavaScript', 'Jenkins', + 'Jobs', + 'Legal', + 'LFS', 'Licensing', 'Logging', + 'Maintenance', 'Marketplace', 'Maven', 'Migration', + 'Mobile', 'Monitoring', 'Networking', 'Node', 'Nonprofits', + 'Notifications', + 'OAuth Apps', 'Open Source', 'Organizations', 'Packages', 'Packaging', - 'Performance', - 'Powershell', - 'Pre-receive hooks', - 'Privacy', - 'Project management', - 'Publishing', - 'Python', - 'Ruby', - 'Secret scanning', - 'Security', - 'Sponsors', - 'Sponsors payments', - 'Sponsors profile', - 'Storage', - 'Support', - 'Swift', - 'Travis CI', - 'Upgrades', - 'User account', - 'Webhooks', - 'Workflows', - 'Access management', - 'Accounts', - 'Billing', - 'CLI', - 'Codespaces', - 'Community', - 'Desktop', - 'Device verification', - 'Discounts', - 'Early access', - 'Enterprise', - 'GitHub', - 'GitHub Apps', - 'GitHub search', - 'Identity', - 'Issues', - 'Jobs', - 'Legal', - 'LFS', - 'Maintenance', - 'Marketplace', - 'Mobile', - 'Notifications', - 'OAuth Apps', 'Pages', + 'Performance', 'Permissions', 'Policies', 'Policy', + 'Powershell', + 'Pre-receive hooks', + 'Privacy', 'Profile', 'Profiles', + 'Project management', 'Projects', + 'Publishing', 'Pull requests', + 'Python', 'Receipts', 'Repositories', + 'REST', + 'Ruby', + 'SARIF', + 'Secret scanning', + 'Secret store', + 'Security advisories', + 'Security overview', + 'Security policies', + 'Security updates', 'Security', - 'Spending limits', - 'Support', 'Set up', + 'Spending limits', + 'Sponsors payments', + 'Sponsors profile', + 'Sponsors', 'SSH', 'SSO', + 'Storage', + 'Support', + 'Swift', 'Teams', + 'Travis CI', 'Trials', 'Troubleshooting', 'Upgrades', + 'User account', 'Usernames', + 'Version updates', 'Visual Studio Code', - 'Xamarin', - 'Xamarin.iOS', + 'Vulnerabilities', + 'Webhooks', + 'Workflows', 'Xamarin.Android', + 'Xamarin.iOS', + 'Xamarin', 'Xcode' ] diff --git a/data/release-notes/2-20/0.yml b/data/release-notes/enterprise-server/2-20/0.yml similarity index 100% rename from data/release-notes/2-20/0.yml rename to data/release-notes/enterprise-server/2-20/0.yml diff --git a/data/release-notes/2-20/1.yml b/data/release-notes/enterprise-server/2-20/1.yml similarity index 100% rename from data/release-notes/2-20/1.yml rename to data/release-notes/enterprise-server/2-20/1.yml diff --git a/data/release-notes/2-20/10.yml b/data/release-notes/enterprise-server/2-20/10.yml similarity index 100% rename from data/release-notes/2-20/10.yml rename to data/release-notes/enterprise-server/2-20/10.yml diff --git a/data/release-notes/2-20/11.yml b/data/release-notes/enterprise-server/2-20/11.yml similarity index 100% rename from data/release-notes/2-20/11.yml rename to data/release-notes/enterprise-server/2-20/11.yml diff --git a/data/release-notes/2-20/12.yml b/data/release-notes/enterprise-server/2-20/12.yml similarity index 100% rename from data/release-notes/2-20/12.yml rename to data/release-notes/enterprise-server/2-20/12.yml diff --git a/data/release-notes/2-20/13.yml b/data/release-notes/enterprise-server/2-20/13.yml similarity index 100% rename from data/release-notes/2-20/13.yml rename to data/release-notes/enterprise-server/2-20/13.yml diff --git a/data/release-notes/2-20/14.yml b/data/release-notes/enterprise-server/2-20/14.yml similarity index 100% rename from data/release-notes/2-20/14.yml rename to data/release-notes/enterprise-server/2-20/14.yml diff --git a/data/release-notes/2-20/15.yml b/data/release-notes/enterprise-server/2-20/15.yml similarity index 100% rename from data/release-notes/2-20/15.yml rename to data/release-notes/enterprise-server/2-20/15.yml diff --git a/data/release-notes/2-20/16.yml b/data/release-notes/enterprise-server/2-20/16.yml similarity index 100% rename from data/release-notes/2-20/16.yml rename to data/release-notes/enterprise-server/2-20/16.yml diff --git a/data/release-notes/2-20/17.yml b/data/release-notes/enterprise-server/2-20/17.yml similarity index 100% rename from data/release-notes/2-20/17.yml rename to data/release-notes/enterprise-server/2-20/17.yml diff --git a/data/release-notes/2-20/18.yml b/data/release-notes/enterprise-server/2-20/18.yml similarity index 100% rename from data/release-notes/2-20/18.yml rename to data/release-notes/enterprise-server/2-20/18.yml diff --git a/data/release-notes/2-20/19.yml b/data/release-notes/enterprise-server/2-20/19.yml similarity index 100% rename from data/release-notes/2-20/19.yml rename to data/release-notes/enterprise-server/2-20/19.yml diff --git a/data/release-notes/2-20/2.yml b/data/release-notes/enterprise-server/2-20/2.yml similarity index 100% rename from data/release-notes/2-20/2.yml rename to data/release-notes/enterprise-server/2-20/2.yml diff --git a/data/release-notes/2-20/20.yml b/data/release-notes/enterprise-server/2-20/20.yml similarity index 100% rename from data/release-notes/2-20/20.yml rename to data/release-notes/enterprise-server/2-20/20.yml diff --git a/data/release-notes/2-20/21.yml b/data/release-notes/enterprise-server/2-20/21.yml similarity index 100% rename from data/release-notes/2-20/21.yml rename to data/release-notes/enterprise-server/2-20/21.yml diff --git a/data/release-notes/2-20/22.yml b/data/release-notes/enterprise-server/2-20/22.yml similarity index 100% rename from data/release-notes/2-20/22.yml rename to data/release-notes/enterprise-server/2-20/22.yml diff --git a/data/release-notes/2-20/23.yml b/data/release-notes/enterprise-server/2-20/23.yml similarity index 100% rename from data/release-notes/2-20/23.yml rename to data/release-notes/enterprise-server/2-20/23.yml diff --git a/data/release-notes/2-20/24.yml b/data/release-notes/enterprise-server/2-20/24.yml similarity index 100% rename from data/release-notes/2-20/24.yml rename to data/release-notes/enterprise-server/2-20/24.yml diff --git a/data/release-notes/2-20/3.yml b/data/release-notes/enterprise-server/2-20/3.yml similarity index 100% rename from data/release-notes/2-20/3.yml rename to data/release-notes/enterprise-server/2-20/3.yml diff --git a/data/release-notes/2-20/4.yml b/data/release-notes/enterprise-server/2-20/4.yml similarity index 100% rename from data/release-notes/2-20/4.yml rename to data/release-notes/enterprise-server/2-20/4.yml diff --git a/data/release-notes/2-20/5.yml b/data/release-notes/enterprise-server/2-20/5.yml similarity index 100% rename from data/release-notes/2-20/5.yml rename to data/release-notes/enterprise-server/2-20/5.yml diff --git a/data/release-notes/2-20/6.yml b/data/release-notes/enterprise-server/2-20/6.yml similarity index 100% rename from data/release-notes/2-20/6.yml rename to data/release-notes/enterprise-server/2-20/6.yml diff --git a/data/release-notes/2-20/7.yml b/data/release-notes/enterprise-server/2-20/7.yml similarity index 100% rename from data/release-notes/2-20/7.yml rename to data/release-notes/enterprise-server/2-20/7.yml diff --git a/data/release-notes/2-20/8.yml b/data/release-notes/enterprise-server/2-20/8.yml similarity index 100% rename from data/release-notes/2-20/8.yml rename to data/release-notes/enterprise-server/2-20/8.yml diff --git a/data/release-notes/2-20/9.yml b/data/release-notes/enterprise-server/2-20/9.yml similarity index 100% rename from data/release-notes/2-20/9.yml rename to data/release-notes/enterprise-server/2-20/9.yml diff --git a/data/release-notes/2-21/0.yml b/data/release-notes/enterprise-server/2-21/0.yml similarity index 100% rename from data/release-notes/2-21/0.yml rename to data/release-notes/enterprise-server/2-21/0.yml diff --git a/data/release-notes/2-21/1.yml b/data/release-notes/enterprise-server/2-21/1.yml similarity index 100% rename from data/release-notes/2-21/1.yml rename to data/release-notes/enterprise-server/2-21/1.yml diff --git a/data/release-notes/2-21/10.yml b/data/release-notes/enterprise-server/2-21/10.yml similarity index 100% rename from data/release-notes/2-21/10.yml rename to data/release-notes/enterprise-server/2-21/10.yml diff --git a/data/release-notes/2-21/11.yml b/data/release-notes/enterprise-server/2-21/11.yml similarity index 100% rename from data/release-notes/2-21/11.yml rename to data/release-notes/enterprise-server/2-21/11.yml diff --git a/data/release-notes/2-21/12.yml b/data/release-notes/enterprise-server/2-21/12.yml similarity index 100% rename from data/release-notes/2-21/12.yml rename to data/release-notes/enterprise-server/2-21/12.yml diff --git a/data/release-notes/2-21/13.yml b/data/release-notes/enterprise-server/2-21/13.yml similarity index 100% rename from data/release-notes/2-21/13.yml rename to data/release-notes/enterprise-server/2-21/13.yml diff --git a/data/release-notes/2-21/14.yml b/data/release-notes/enterprise-server/2-21/14.yml similarity index 100% rename from data/release-notes/2-21/14.yml rename to data/release-notes/enterprise-server/2-21/14.yml diff --git a/data/release-notes/2-21/15.yml b/data/release-notes/enterprise-server/2-21/15.yml similarity index 100% rename from data/release-notes/2-21/15.yml rename to data/release-notes/enterprise-server/2-21/15.yml diff --git a/data/release-notes/2-21/16.yml b/data/release-notes/enterprise-server/2-21/16.yml similarity index 100% rename from data/release-notes/2-21/16.yml rename to data/release-notes/enterprise-server/2-21/16.yml diff --git a/data/release-notes/2-21/17.yml b/data/release-notes/enterprise-server/2-21/17.yml similarity index 100% rename from data/release-notes/2-21/17.yml rename to data/release-notes/enterprise-server/2-21/17.yml diff --git a/data/release-notes/2-21/18.yml b/data/release-notes/enterprise-server/2-21/18.yml similarity index 100% rename from data/release-notes/2-21/18.yml rename to data/release-notes/enterprise-server/2-21/18.yml diff --git a/data/release-notes/2-21/19.yml b/data/release-notes/enterprise-server/2-21/19.yml similarity index 100% rename from data/release-notes/2-21/19.yml rename to data/release-notes/enterprise-server/2-21/19.yml diff --git a/data/release-notes/2-21/2.yml b/data/release-notes/enterprise-server/2-21/2.yml similarity index 100% rename from data/release-notes/2-21/2.yml rename to data/release-notes/enterprise-server/2-21/2.yml diff --git a/data/release-notes/2-21/20.yml b/data/release-notes/enterprise-server/2-21/20.yml similarity index 100% rename from data/release-notes/2-21/20.yml rename to data/release-notes/enterprise-server/2-21/20.yml diff --git a/data/release-notes/2-21/21.yml b/data/release-notes/enterprise-server/2-21/21.yml similarity index 100% rename from data/release-notes/2-21/21.yml rename to data/release-notes/enterprise-server/2-21/21.yml diff --git a/data/release-notes/2-21/22.yml b/data/release-notes/enterprise-server/2-21/22.yml similarity index 100% rename from data/release-notes/2-21/22.yml rename to data/release-notes/enterprise-server/2-21/22.yml diff --git a/data/release-notes/2-21/3.yml b/data/release-notes/enterprise-server/2-21/3.yml similarity index 100% rename from data/release-notes/2-21/3.yml rename to data/release-notes/enterprise-server/2-21/3.yml diff --git a/data/release-notes/2-21/4.yml b/data/release-notes/enterprise-server/2-21/4.yml similarity index 100% rename from data/release-notes/2-21/4.yml rename to data/release-notes/enterprise-server/2-21/4.yml diff --git a/data/release-notes/2-21/5.yml b/data/release-notes/enterprise-server/2-21/5.yml similarity index 100% rename from data/release-notes/2-21/5.yml rename to data/release-notes/enterprise-server/2-21/5.yml diff --git a/data/release-notes/2-21/6.yml b/data/release-notes/enterprise-server/2-21/6.yml similarity index 100% rename from data/release-notes/2-21/6.yml rename to data/release-notes/enterprise-server/2-21/6.yml diff --git a/data/release-notes/2-21/7.yml b/data/release-notes/enterprise-server/2-21/7.yml similarity index 100% rename from data/release-notes/2-21/7.yml rename to data/release-notes/enterprise-server/2-21/7.yml diff --git a/data/release-notes/2-21/8.yml b/data/release-notes/enterprise-server/2-21/8.yml similarity index 100% rename from data/release-notes/2-21/8.yml rename to data/release-notes/enterprise-server/2-21/8.yml diff --git a/data/release-notes/2-21/9.yml b/data/release-notes/enterprise-server/2-21/9.yml similarity index 100% rename from data/release-notes/2-21/9.yml rename to data/release-notes/enterprise-server/2-21/9.yml diff --git a/data/release-notes/2-22/0.yml b/data/release-notes/enterprise-server/2-22/0.yml similarity index 100% rename from data/release-notes/2-22/0.yml rename to data/release-notes/enterprise-server/2-22/0.yml diff --git a/data/release-notes/2-22/1.yml b/data/release-notes/enterprise-server/2-22/1.yml similarity index 100% rename from data/release-notes/2-22/1.yml rename to data/release-notes/enterprise-server/2-22/1.yml diff --git a/data/release-notes/2-22/10.yml b/data/release-notes/enterprise-server/2-22/10.yml similarity index 100% rename from data/release-notes/2-22/10.yml rename to data/release-notes/enterprise-server/2-22/10.yml diff --git a/data/release-notes/2-22/11.yml b/data/release-notes/enterprise-server/2-22/11.yml similarity index 100% rename from data/release-notes/2-22/11.yml rename to data/release-notes/enterprise-server/2-22/11.yml diff --git a/data/release-notes/2-22/12.yml b/data/release-notes/enterprise-server/2-22/12.yml similarity index 100% rename from data/release-notes/2-22/12.yml rename to data/release-notes/enterprise-server/2-22/12.yml diff --git a/data/release-notes/2-22/13.yml b/data/release-notes/enterprise-server/2-22/13.yml similarity index 100% rename from data/release-notes/2-22/13.yml rename to data/release-notes/enterprise-server/2-22/13.yml diff --git a/data/release-notes/2-22/14.yml b/data/release-notes/enterprise-server/2-22/14.yml similarity index 100% rename from data/release-notes/2-22/14.yml rename to data/release-notes/enterprise-server/2-22/14.yml diff --git a/data/release-notes/2-22/2.yml b/data/release-notes/enterprise-server/2-22/2.yml similarity index 100% rename from data/release-notes/2-22/2.yml rename to data/release-notes/enterprise-server/2-22/2.yml diff --git a/data/release-notes/2-22/3.yml b/data/release-notes/enterprise-server/2-22/3.yml similarity index 100% rename from data/release-notes/2-22/3.yml rename to data/release-notes/enterprise-server/2-22/3.yml diff --git a/data/release-notes/2-22/4.yml b/data/release-notes/enterprise-server/2-22/4.yml similarity index 100% rename from data/release-notes/2-22/4.yml rename to data/release-notes/enterprise-server/2-22/4.yml diff --git a/data/release-notes/2-22/5.yml b/data/release-notes/enterprise-server/2-22/5.yml similarity index 100% rename from data/release-notes/2-22/5.yml rename to data/release-notes/enterprise-server/2-22/5.yml diff --git a/data/release-notes/2-22/6.yml b/data/release-notes/enterprise-server/2-22/6.yml similarity index 100% rename from data/release-notes/2-22/6.yml rename to data/release-notes/enterprise-server/2-22/6.yml diff --git a/data/release-notes/2-22/7.yml b/data/release-notes/enterprise-server/2-22/7.yml similarity index 100% rename from data/release-notes/2-22/7.yml rename to data/release-notes/enterprise-server/2-22/7.yml diff --git a/data/release-notes/2-22/8.yml b/data/release-notes/enterprise-server/2-22/8.yml similarity index 100% rename from data/release-notes/2-22/8.yml rename to data/release-notes/enterprise-server/2-22/8.yml diff --git a/data/release-notes/2-22/9.yml b/data/release-notes/enterprise-server/2-22/9.yml similarity index 100% rename from data/release-notes/2-22/9.yml rename to data/release-notes/enterprise-server/2-22/9.yml diff --git a/data/release-notes/3-0/0-rc1.yml b/data/release-notes/enterprise-server/3-0/0-rc1.yml similarity index 100% rename from data/release-notes/3-0/0-rc1.yml rename to data/release-notes/enterprise-server/3-0/0-rc1.yml diff --git a/data/release-notes/3-0/0-rc2.yml b/data/release-notes/enterprise-server/3-0/0-rc2.yml similarity index 100% rename from data/release-notes/3-0/0-rc2.yml rename to data/release-notes/enterprise-server/3-0/0-rc2.yml diff --git a/data/release-notes/3-0/0.yml b/data/release-notes/enterprise-server/3-0/0.yml similarity index 100% rename from data/release-notes/3-0/0.yml rename to data/release-notes/enterprise-server/3-0/0.yml diff --git a/data/release-notes/3-0/1.yml b/data/release-notes/enterprise-server/3-0/1.yml similarity index 100% rename from data/release-notes/3-0/1.yml rename to data/release-notes/enterprise-server/3-0/1.yml diff --git a/data/release-notes/3-0/2.yml b/data/release-notes/enterprise-server/3-0/2.yml similarity index 100% rename from data/release-notes/3-0/2.yml rename to data/release-notes/enterprise-server/3-0/2.yml diff --git a/data/release-notes/3-0/3.yml b/data/release-notes/enterprise-server/3-0/3.yml similarity index 100% rename from data/release-notes/3-0/3.yml rename to data/release-notes/enterprise-server/3-0/3.yml diff --git a/data/release-notes/3-0/4.yml b/data/release-notes/enterprise-server/3-0/4.yml similarity index 100% rename from data/release-notes/3-0/4.yml rename to data/release-notes/enterprise-server/3-0/4.yml diff --git a/data/release-notes/3-0/5.yml b/data/release-notes/enterprise-server/3-0/5.yml similarity index 100% rename from data/release-notes/3-0/5.yml rename to data/release-notes/enterprise-server/3-0/5.yml diff --git a/data/release-notes/3-0/6.yml b/data/release-notes/enterprise-server/3-0/6.yml similarity index 100% rename from data/release-notes/3-0/6.yml rename to data/release-notes/enterprise-server/3-0/6.yml diff --git a/data/release-notes/3-0/7.yml b/data/release-notes/enterprise-server/3-0/7.yml similarity index 100% rename from data/release-notes/3-0/7.yml rename to data/release-notes/enterprise-server/3-0/7.yml diff --git a/data/release-notes/3-0/8.yml b/data/release-notes/enterprise-server/3-0/8.yml similarity index 100% rename from data/release-notes/3-0/8.yml rename to data/release-notes/enterprise-server/3-0/8.yml diff --git a/data/release-notes/3-1/0-rc1.yml b/data/release-notes/enterprise-server/3-1/0-rc1.yml similarity index 95% rename from data/release-notes/3-1/0-rc1.yml rename to data/release-notes/enterprise-server/3-1/0-rc1.yml index 3d06e0e705..5b28c70d8d 100644 --- a/data/release-notes/3-1/0-rc1.yml +++ b/data/release-notes/enterprise-server/3-1/0-rc1.yml @@ -18,6 +18,11 @@ sections: Administrators using {% data variables.product.prodname_GH_advanced_security %} can [enable and configure](/enterprise-server@3.1/admin/configuration/configuring-secret-scanning-for-your-appliance) {% data variables.product.prodname_GH_advanced_security %} secret scanning. You can review the [updated minimum requirements for your platform](/enterprise-server@3.1/admin/installation/setting-up-a-github-enterprise-server-instance) before you turn on {% data variables.product.prodname_GH_advanced_security %} secret scanning. + - heading: GitHub Advanced Security Code Scanning + notes: + - | + [{% data variables.product.prodname_GH_advanced_security %} code scanning](https://github.com/features/security) is now generally available on {% data variables.product.prodname_ghe_server %} 3.1+. Organizations who have purchased {% data variables.product.prodname_GH_advanced_security %} can use this capability to do static analysis security testing against their code, and prevent vulnerabilities from making it to their production code using CodeQL, our semantic analysis engine. For more information, see "[Configuring code scanning on your appliance](/en/enterprise-server@3.1/admin/configuration/configuring-code-scanning-for-your-appliance#running-code-scanning-using-github-actions)." + - heading: GitHub Advanced Security billing improvements notes: - | diff --git a/data/release-notes/enterprise-server/README.md b/data/release-notes/enterprise-server/README.md new file mode 100644 index 0000000000..5a488316c8 --- /dev/null +++ b/data/release-notes/enterprise-server/README.md @@ -0,0 +1,37 @@ +# Release notes for GitHub Enterprise Server + +Rendered here: https://docs.github.com/en/enterprise-server@latest/admin/release-notes + +## How it works + +### Placeholder content file + +A content file exists in `content/admin/release-notes.md`. It has a special frontmatter property `layout: release-notes` and no Markdown content. The source of the release notes comes from YAML data. + +### YAML source + +The source data for the release notes lives in this directory (`data/release-notes/enterprise-server`). + +The directories are named by GHES release number (with a hyphen instead of a period). + +The YAML files in each directory are named by patch number. Some patch filenames may end with `-rc.yml`, which means it's a release candidate. A release candidate file also requires `release_candidate: true` in the YAML data. + +Release notes of deprecated GHES versions (see `lib/enterprise-server-releases.js`) are **not** removed from the site and will always be displayed alongside currently supported versions. + +Note that patch files can be deprecated individually (i.e., hidden on the docs site) by an optional `deprecated: true` property. + +### Middleware processing + +The YAML data is processed and sorted by `middleware/contextualizers/release-notes.js` and added to the `context` object. + +### Layouts + +The `context` object data is rendered by `layouts/release-notes.html` and `includes/enterprise-server-release-notes.html`. + +The release notes page has a custom design with CSS in `stylesheets/release-notes.scss` and client-side JavaScript in `javascripts/release-notes.js`. + +### Schema + +The schema that validates the YAML data lives in `tests/helpers/schemas/ghes-release-notes-schema.js`. See the schema file to find out the required and optional properties. + +The schema is exercised by a test in `tests/linting/lint-files.js`. The test will fail if the data does not pass validation. diff --git a/data/release-notes/github-ae/2021-03/2021-03-03.yml b/data/release-notes/github-ae/2021-03/2021-03-03.yml new file mode 100644 index 0000000000..7185cd78c4 --- /dev/null +++ b/data/release-notes/github-ae/2021-03/2021-03-03.yml @@ -0,0 +1,83 @@ +date: '2021-03-03' +friendlyDate: 'March 3, 2021' +title: 'Week of March 3, 2021' +currentWeek: false +sections: + features: + - heading: 'GitHub Actions beta' + notes: + - | + [{% data variables.product.prodname_actions %}](https://github.com/features/actions) is a powerful, flexible solution for CI/CD and workflow automation. For more information, see "[Introduction to {% data variables.product.prodname_actions %}](/actions/learn-github-actions/introduction-to-github-actions)." + + {% data variables.product.prodname_actions %} on {% data variables.product.product_name %} uses a new [{% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/about-ae-hosted-runners), only available for {% data variables.product.product_name %}, that enables you to customize the size, image, and networking configuration of the runners. These runners are a finished-service CI compute environment with auto-scaling and management, fully managed by {% data variables.product.company_short %}. During the beta, the use {% data variables.actions.hosted_runner %}s is free of charge. For more information, see "[Adding {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/adding-ae-hosted-runners)." + + Please note that when {% data variables.product.prodname_actions %} is enabled during this upgrade, two organizations named "GitHub Actions" (@**actions** and @**github**) will appear in {% data variables.product.product_location %}. These organizations are required by {% data variables.product.prodname_actions %}. Users named @**ghost** and @**actions** appear as the actors for creation of these organizations in the audit log. + - heading: 'GitHub Packages beta' + notes: + - | + [{% data variables.product.prodname_registry %}](https://github.com/features/packages) is a package hosting service, natively integrated with {% data variables.product.prodname_actions %}, APIs, and webhooks. Create an [end-to-end DevOps workflow](/github-ae@latest/packages/quickstart) that includes your code, continuous integration, and deployment solutions. During this beta, {% data variables.product.prodname_registry %} is offered free of charge to {% data variables.product.product_name %} customers. + - heading: 'GitHub Advanced Security beta' + notes: + - | + {% data variables.product.prodname_GH_advanced_security %} is available in beta and includes both code scanning and secret scanning. During this beta, {% data variables.product.prodname_GH_advanced_security %} features are being offered free of charge to {% data variables.product.product_name %} customers. Repository and organization administrators can opt-in to use {% data variables.product.prodname_GH_advanced_security %} in the Security and Analysis tab under settings. + + Learn more about {% data variables.product.prodname_GH_advanced_security %} [code scanning](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning) and [secret scanning](/github/administering-a-repository/about-secret-scanning) on {% data variables.product.prodname_ghe_managed %}. + + - heading: Manage teams from your identity provider (IdP) + notes: + - | + Customers using SCIM (System for Cross-domain Identity Management) can now sync security groups in Azure Active Directory with {% data variables.product.company_short %} teams. Once a team has been linked to a security group, membership will be automatically updated in {% data variables.product.product_name %} when a user is added or removed from their assigned security group. + + - heading: IP allow lists beta + notes: + - | + [{% data variables.product.company_short %} IP allow lists](/admin/configuration/restricting-network-traffic-to-your-enterprise) provide the ability to filter traffic from administrator-specified IP ranges, defined by CIDR notation. The allow list is defined at the enterprise or organization account level in Security > Settings. All traffic that attempts to reach resources within the enterprise account and organizations are filtered by the IP allow lists. This functionality is provided in addition to the ability to request network security group changes that filter traffic to the entirety of the GHAE tenant. + + changes: + - heading: Developer Changes + notes: + - | + [Organization owners can now disable publication](/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization) of {% data variables.product.prodname_pages %} sites from repositories in the organization. This will not unpublish existing sites. + - Repositories that use {% data variables.product.prodname_pages %} can now [build and deploy from any branch](/github/working-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites). + - When writing an issue or pull request, the list syntax for bullets, numbers, and tasks will now be autocompleted after you press `return` or `enter`. + - You can now delete a directory in a repository from the repository page. When navigating to a directory, a new kebab button next to the "Add file" button gives the option to delete the directory. + - It's now easier and faster to [reference issues or pull requests](/github/writing-on-github/basic-writing-and-formatting-syntax#referencing-issues-and-pull-requests), with search across multiple words after the "#". + + - heading: Administration changes + notes: + - Enterprise owners can now publish a mandatory message. The message is shown to all users and they must acknowledge it. This can be used to display important information, terms of service or policies. + - The {% data variables.product.prodname_github_app%} single file path permission can now [support up to ten files](/developers/apps/creating-a-github-app-using-url-parameters). + - When configuring a {% data variables.product.prodname_github_app%}, the authorization callback URL is a required field. Now we will permit the integrator to specify multiple callback URLs. {% data variables.product.product_name %} denies authorization if the callback URL from the request is not listed. + - A [new API endpoint](/rest/reference/apps#create-a-scoped-access-token) enables the exchange of a user to server token for a user to server token scoped to specific repositories. + - Events are now logged in the audit log on [promoting a team member to be a team maintainer and on demoting a team maintainer to be a team member](/admin/user-management/audited-actions#teams). + - The [OAuth device authorization flow](/developers/apps/authorizing-oauth-apps#device-flow) is now supported. This allows any CLI client or developer tool to authenticate using a secondary system. + - A user can no longer delete their account if SCIM provisioning is enabled. + + - heading: Default branch renaming + notes: + - | + Enterprise and organization owners can now set the default branch name for new repositories. Enterprise owners can also enforce their choice of default branch name across all organizations or allow individual organizations to choose their own. + + Existing repositories are unaffected by these settings, and their default branch name will not be changed. + + This change is one of many changes {% data variables.product.company_short %} is making to support projects and maintainers that want to rename their default branch. To learn more, see [github/renaming](https://github.com/github/renaming). + + bugs: + - heading: Bug fixes + notes: + - Users can no longer set a backup email address on their profile. Their email address is set through the IdP only. + - You can no longer enable two-factor authentication after configuring authentication through your IdP. + - | + {% data variables.product.product_name %} can now connect to Azure Boards. + - Version headers were missing from the APIs, and have now been set to "GitHub AE." + - Links to documentation have been fixed. + - Configuration of audit log forwarding within the enterprise's settings was failing. + - Navigating to gists could result in a 500 error. + - The Support email or URL was failing to save. It now saves after a period of a few minutes. + - Organization level pull request templates were not being applied to all pull requests in the organization. + + known_issues: + - heading: Known issues + notes: + - Geographic location data is not shown in the audit log. Location information can otherwise be discerned from the IP address associated with each event. + - The link to {% data variables.product.prodname_registry %} from a repository page shows an incorrect search page when that repository does not have any packages. diff --git a/data/release-notes/github-ae/README.md b/data/release-notes/github-ae/README.md new file mode 100644 index 0000000000..b20276bebd --- /dev/null +++ b/data/release-notes/github-ae/README.md @@ -0,0 +1,35 @@ +# Release notes for GitHub AE + +Rendered here: https://docs.github.com/en/github-ae@latest/admin/release-notes + +## How it works + +### Placeholder content file + +A content file exists in `content/admin/release-notes.md`. It has a special frontmatter property `layout: release-notes` and no Markdown content. The source of the release notes comes from YAML data. + +### YAML source + +The source data for the release notes lives in this directory (`data/release-notes/github-ae`). + +The directories are named by month. The YAML files are named by the data of a weekly release. + +A boolean property called `currentWeek` must be set in each YAML file. No more than one file at a time can have this property set to true. + +Note that patch files can be deprecated individually (i.e., hidden on the docs site) by an optional `deprecated: true` property. + +### Middleware processing + +The YAML data is processed and sorted by `middleware/contextualizers/release-notes.js` and added to the `context` object. + +### Layouts + +The `context` object data is rendered by `layouts/release-notes.html` and `includes/github-ae-release-notes.html`. + +The release notes page has a custom design with CSS in `stylesheets/release-notes.scss` and client-side JavaScript in `javascripts/release-notes.js`. + +### Schema + +The schema that validates the YAML data lives in `tests/helpers/schemas/ghae-release-notes-schema.js`. See the schema file to find out the required and optional properties. + +The schema is exercised by a test in `tests/linting/lint-files.js`. The test will fail if the data does not pass validation. diff --git a/data/reusables/enterprise_migrations/locking-repositories.md b/data/reusables/enterprise_migrations/locking-repositories.md index f44ff52c94..ea0ecd6bcf 100644 --- a/data/reusables/enterprise_migrations/locking-repositories.md +++ b/data/reusables/enterprise_migrations/locking-repositories.md @@ -1,6 +1,6 @@ {% tip %} -**Note:** Locking a repository prevents users from pushing to the repository or modifying a repository's resources, like issues, labels, milestones, wikis, and comments. New teams and collaborators can't be associated with a locked repository. +**Note:** Locking a repository prevents all read or write access to the repository. You cannot associate new teams or collaborators with a locked repository. -If you're performing a trial run, you don't need to lock repositories. Otherwise, it's highly recommended. For more information, see "[About Migrations](/enterprise/admin/migrations/about-migrations#types-of-migrations)." +If you're performing a trial run, you do not need to lock the repository. When you migrate data from a repository that's in use, {% data variables.product.company_short %} strongly recommends locking the repository. For more information, see "[About Migrations](/enterprise/admin/migrations/about-migrations#types-of-migrations)." {% endtip %} diff --git a/data/reusables/files/choose_pull_request.md b/data/reusables/files/choose_pull_request.md new file mode 100644 index 0000000000..0f44609362 --- /dev/null +++ b/data/reusables/files/choose_pull_request.md @@ -0,0 +1,2 @@ +1. Create a pull request for your proposed changes. +2. In the "Pull Requests" list, click the pull request you would like to merge. diff --git a/data/reusables/files/confirm_merge.md b/data/reusables/files/confirm_merge.md new file mode 100644 index 0000000000..44576e1a37 --- /dev/null +++ b/data/reusables/files/confirm_merge.md @@ -0,0 +1 @@ +1. Click **Confirm merge**. diff --git a/data/reusables/files/delete_branch.md b/data/reusables/files/delete_branch.md new file mode 100644 index 0000000000..651f7eae61 --- /dev/null +++ b/data/reusables/files/delete_branch.md @@ -0,0 +1 @@ +1. Optionally, delete the branch. For more information, see "[Creating and deleting branches within your repository](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository)." diff --git a/data/reusables/files/merge_pull_request.md b/data/reusables/files/merge_pull_request.md new file mode 100644 index 0000000000..21365cb488 --- /dev/null +++ b/data/reusables/files/merge_pull_request.md @@ -0,0 +1 @@ +1. Click **Merge pull request**. For more information, see "[Merging a pull request](/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request)." diff --git a/data/reusables/files/write_commit_message_pull_request.md b/data/reusables/files/write_commit_message_pull_request.md new file mode 100644 index 0000000000..ba5c7925d7 --- /dev/null +++ b/data/reusables/files/write_commit_message_pull_request.md @@ -0,0 +1,2 @@ +1. If prompted, type a commit message, or accept the default message. + ![Commit message field](/assets/images/help/pull_requests/merge_box/pullrequest-commitmessage.png) diff --git a/data/reusables/sponsors/navigate-to-sponsors-dashboard.md b/data/reusables/sponsors/navigate-to-sponsors-dashboard.md index 6391060874..2ebe7f6417 100644 --- a/data/reusables/sponsors/navigate-to-sponsors-dashboard.md +++ b/data/reusables/sponsors/navigate-to-sponsors-dashboard.md @@ -1,4 +1,4 @@ -1. In the upper-right corner of any page, click your profile photo, then click **{% data variables.product.prodname_sponsors %}**. +1. In the upper-right corner of any page, click your profile photo, then click **Your sponsors**. ![{% data variables.product.prodname_sponsors %} button](/assets/images/help/sponsors/access-github-sponsors-dashboard.png) 2. If a list of your sponsored and eligible accounts is shown, to the right of the account you want to manage, click **Dashboard**. ![Developer sponsors dashboard button](/assets/images/help/sponsors/dev-sponsors-dashboard-button.png) diff --git a/data/reusables/sponsors/tier-details.md b/data/reusables/sponsors/tier-details.md index 78c40c1054..2aed4e826b 100644 --- a/data/reusables/sponsors/tier-details.md +++ b/data/reusables/sponsors/tier-details.md @@ -1,3 +1,10 @@ -You can create up to ten sponsorship tiers for sponsors to choose from. Each tier has its own monthly or one-time payment amount in US dollars and benefits, such as receiving early access to new versions or being featured in the project's README. In addition, you can choose to enable tiers for custom amounts (monthly and one-time). +You can create up to 10 one-time sponsorship tiers and 10 monthly tiers for sponsors to choose from. Each tier has its own one-time or monthly payment amount in US dollars, and you can choose to enable tiers for custom amounts. In addition, you can choose to enable tiers for custom amounts (monthly and one-time). -Once you have published a tier, you can't edit the price of that tier. Instead, you must retire the tier and create a new tier. Existing sponsors will remain on the retired tier until they change their sponsorship tier, cancel their sponsorship, or their one-time sponsorship period expires. +You can customize the rewards for each tier. For example, rewards for a tier could include: +- Early access to new versions +- Logo or name in README +- Access to a private repository +- Weekly newsletter updates +- Other rewards your sponsors would enjoy ✨ + +Once you have published a tier, you cannot edit the price of that tier. Instead, you must retire the tier and create a new tier. Existing sponsors will remain on the retired tier until they change their sponsorship tier, cancel their sponsorship, or their one-time sponsorship period expires. diff --git a/data/reusables/webhooks/secret.md b/data/reusables/webhooks/secret.md index 95f3a341ca..a92e5fca87 100644 --- a/data/reusables/webhooks/secret.md +++ b/data/reusables/webhooks/secret.md @@ -1 +1 @@ -Setting a webhook secret allows you to ensure that `POST` requests sent to the payload URL are from {% data variables.product.product_name %}. When you set a secret, you'll receive the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}`X-Hub-Signature` and `X-Hub-Signature-256` headers{% elsif currentVersion ver_lt "enterprise-server@2.23" %}`X-Hub-Signature` header{% elsif currentVersion == "github-ae@latest" %}`X-Hub-Signature-256` header{% endif %} in the webhook `POST` request. For more information on how to use a secret with a signature header to secure your webhook payloads, see "[Securing your webhooks](/webhooks/securing/)." +Setting a webhook secret allows you to ensure that `POST` requests sent to the payload URL are from {% data variables.product.product_name %}. When you set a secret, you'll receive the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}`X-Hub-Signature` and `X-Hub-Signature-256` headers{% elsif currentVersion ver_lt "enterprise-server@2.23" %}`X-Hub-Signature` header{% elsif currentVersion == "github-ae@latest" %}`X-Hub-Signature-256` header{% endif %} in the webhook `POST` request. For more information on how to use a secret with a signature header to secure your webhook payloads, see "[Securing your webhooks](/webhooks/securing/)." diff --git a/data/ui.yml b/data/ui.yml index 261ade0760..f2bb008dea 100644 --- a/data/ui.yml +++ b/data/ui.yml @@ -18,10 +18,14 @@ header: please visit our English documentation. early_access: 📣 Please do not share this URL publicly. This page contains content about an early access feature. - ghes_release_notes_use_latest: Please use the latest release for the latest security, performance, and bug fixes. - ghes_release_notes_upgrade_patch_only: 📣 This is not the latest patch release of Enterprise Server. {% data ui.header.notices.ghes_release_notes_use_latest %} - ghes_release_notes_upgrade_release_only: 📣 This is not the latest release of Enterprise Server. {% data ui.header.notices.ghes_release_notes_use_latest %} - ghes_release_notes_upgrade_patch_and_release: 📣 This is not the latest patch release of this release series, and this is not the latest release of Enterprise Server. {% data ui.header.notices.ghes_release_notes_use_latest %} + release_notes_use_latest: Please use the latest release for the latest security, performance, and bug fixes. + # GHES release notes + ghes_release_notes_upgrade_patch_only: 📣 This is not the latest patch release of Enterprise Server. {% data ui.header.notices.release_notes_use_latest %} + ghes_release_notes_upgrade_release_only: 📣 This is not the latest release of Enterprise Server. {% data ui.header.notices.release_notes_use_latest %} + ghes_release_notes_upgrade_patch_and_release: 📣 This is not the latest patch release of this release series, and this is not the latest release of Enterprise Server. {% data ui.header.notices.release_notes_use_latest %} +release_notes: + banner_text_current: These changes will roll out over the next one week. + banner_text_past: These changes rolled out to enterprises during the week of search: need_help: Need help? placeholder: Search topics, products... diff --git a/includes/enterprise-server-release-notes.html b/includes/enterprise-server-release-notes.html new file mode 100644 index 0000000000..88806054b0 --- /dev/null +++ b/includes/enterprise-server-release-notes.html @@ -0,0 +1,156 @@ +{% assign product = siteTree[currentLanguage][currentVersion].products[currentProduct] %} +{% assign currentVersionObject = allVersions[currentVersion] %} + +
        +
        +
        + {% if prevRelease %} + + {% octicon "chevron-left" %} {{ prevRelease }} + + {% else %} +
        + {% endif %} + +

        {{ currentVersionObject.planTitle }} {{ currentVersionObject.currentRelease }} release notes

        + + {% if nextRelease %} + + {{ nextRelease }} {% octicon "chevron-right" %} + + {% else %} +
        + {% endif %} +
        + +
        + {% for patch in releaseNotes %} +
        +
        +
        +

        + {{ currentVersionObject.versionTitle }}.{{ patch.patchVersion }} +

        + + {% if patch.release_candidate %} + Release Candidate + {% endif %} + + {% if currentVersionObject.plan == "enterprise-server" %} + + Download + + {% endif %} + + +
        + +

        {{ patch.date | date: "%B %d, %Y" }}

        + + {% if patch.version != latestPatch and currentVersionObject.currentRelease == latestRelease %} +

        {% data ui.header.notices.ghes_release_notes_upgrade_patch_only %}

        + {% endif %} + + {% if patch.version == latestPatch and currentVersionObject.currentRelease != latestRelease %} +

        {% data ui.header.notices.ghes_release_notes_upgrade_release_only %}

        + {% endif %} + + {% if patch.version != latestPatch and currentVersionObject.currentRelease != latestRelease %} +

        {% data ui.header.notices.ghes_release_notes_upgrade_patch_and_release %}

        + {% endif %} +
        + +
        +
        {{ patch.intro }}
        + + {% for section in patch.sections %} +
        +
        + {% include release-notes-category-label %} +
        + +
          + {% for note in section[1] %} +
        • + {% if note.heading %} + {% assign slug = note.heading | slugify %} + +

          + {{ note.heading }} +

          + +
            + {% for subNote in note.notes %} +
          • {{ subNote }}
            • + {% endfor %} +
          + {% else %} + {{ note }} + {% endif %} +
          • + {% endfor %} +
        +
        + {% endfor %} +
        +
        + {% endfor %} +
        +
        + + +
        diff --git a/includes/github-ae-release-notes.html b/includes/github-ae-release-notes.html new file mode 100644 index 0000000000..7446f4babc --- /dev/null +++ b/includes/github-ae-release-notes.html @@ -0,0 +1,104 @@ +{% assign product = siteTree[currentLanguage][currentVersion].products[currentProduct] %} +{% assign currentVersionObject = allVersions[currentVersion] %} + +
        +
        +
        +
        +

        {{ currentVersionObject.planTitle }} release notes

        +
        +
        + +
        + {% for patch in releaseNotes %} +
        +
        +
        +

        + {{ patch.title }} +

        + + {% if patch.release_candidate %} + Release Candidate + {% endif %} + + +
        + {% if patch.currentWeek %} + {% assign bannerText = site.data.ui.release_notes.banner_text_current %} + {% else %} + {% assign bannerText = site.data.ui.release_notes.banner_text_past | append: " " | append: patch.friendlyDate | append: "." %} + {% endif %} +

        {{ patch.friendlyDate }} - {{ bannerText }}

        +
        + +
        +
        {{ patch.intro }}
        + + {% for section in patch.sections %} +
        +
          + {% for note in section[1] %} +
        • + {% if note.heading %} + {% assign slug = note.heading | slugify %} + +

          + {{ note.heading }} +

          + +
            + {% for subNote in note.notes %} +
          • {{ subNote }}
            • + {% endfor %} +
          + {% else %} + {{ note }} + {% endif %} +
          • + {% endfor %} +
        +
        + {% endfor %} +
        +
        + {% endfor %} +
        +
        + + +
        diff --git a/includes/header-version-switcher.html b/includes/header-version-switcher.html index af5aebb0e1..b0b6b847a7 100644 --- a/includes/header-version-switcher.html +++ b/includes/header-version-switcher.html @@ -1,5 +1,5 @@ -{% if page.relativePath == 'index.md' or page.layout == 'product-landing' or page.layout == 'product-sublanding' %} +{% if page.relativePath == 'index.md' or page.layout == 'product-landing' or page.layout == 'product-sublanding' or page.layout == 'release-notes' %} {% if page.permalinks and page.permalinks.length > 1 %}
        diff --git a/javascripts/display-tool-specific-content.js b/javascripts/display-tool-specific-content.js index 60945c105c..bee88ec41d 100644 --- a/javascripts/display-tool-specific-content.js +++ b/javascripts/display-tool-specific-content.js @@ -1,3 +1,7 @@ +import Cookies from 'js-cookie' + +import { sendEvent } from './events' + const supportedTools = ['cli', 'desktop', 'webui'] const detectedTools = new Set() @@ -18,6 +22,16 @@ export default function displayToolSpecificContent () { event.preventDefault() showContentForTool(event.target.dataset.tool) findToolSpecificContent(event.target.dataset.tool) + + // Save this preference as a cookie. + Cookies.set('toolPreferred', event.target.dataset.tool, { sameSite: 'strict', secure: true }) + + // Send event data + sendEvent({ + type: 'preference', + preference_name: 'application', + preference_value: event.target.dataset.tool + }) }) }) } @@ -73,6 +87,8 @@ function detectTools (el) { } function getDefaultTool () { + const cookieValue = Cookies.get('toolPreferred') + if (cookieValue) return cookieValue const el = document.querySelector('[data-default-tool]') if (el) return el.dataset.defaultTool } diff --git a/javascripts/events.js b/javascripts/events.js index 55bec3f143..3311fd74fe 100644 --- a/javascripts/events.js +++ b/javascripts/events.js @@ -46,12 +46,14 @@ export function sendEvent ({ experiment_name, experiment_variation, experiment_success, - clipboard_operation + clipboard_operation, + preference_name, + preference_value }) { const body = { _csrf: getCsrf(), - type, // One of page, exit, link, search, navigate, survey, experiment + type, // One of page, exit, link, search, navigate, survey, experiment, preference context: { // Primitives @@ -77,7 +79,10 @@ export function sendEvent ({ // Location information timezone: new Date().getTimezoneOffset() / -60, - user_language: navigator.language + user_language: navigator.language, + + // Preference information + application_preference: Cookies.get('toolPreferred') }, // Page event @@ -112,7 +117,11 @@ export function sendEvent ({ experiment_success, // Clipboard event - clipboard_operation + clipboard_operation, + + // Preference event + preference_name, + preference_value } const blob = new Blob([JSON.stringify(body)], { type: 'application/json' }) navigator.sendBeacon('/events', blob) @@ -230,4 +239,5 @@ export default function initializeEvents () { // experiment event in ./experiment.js // search event in ./search.js // redirect event in middleware/record-redirect.js + // preference event in ./display-tool-specific-content.js } diff --git a/layouts/release-notes.html b/layouts/release-notes.html index def37ceb64..3678133561 100644 --- a/layouts/release-notes.html +++ b/layouts/release-notes.html @@ -1,5 +1,3 @@ -{% assign product = siteTree[currentLanguage][currentVersion].products[currentProduct] %} - {% include head %} @@ -11,156 +9,13 @@ {% include header %} {% include deprecation-banner %} -
        -
        -
        - {% if prevRelease %} - - {% octicon "chevron-left" %} {{ prevRelease }} - - {% else %} -
        - {% endif %} + {% if allVersions[currentVersion].plan == 'enterprise-server' %} + {% include enterprise-server-release-notes %} + {% endif %} -

        {{ currentVersion | version_num }} Release notes

        - - {% if nextRelease %} - - {{ nextRelease }} {% octicon "chevron-right" %} - - {% else %} -
        - {% endif %} -
        - -
        - {% for patch in releaseNotes %} -
        -
        -
        -

        - {{ allVersions[currentVersion].versionTitle }}.{{ patch.patchVersion }} -

        - - {% if patch.release_candidate %} - Release Candidate - {% endif %} - - - Download - - - -
        - -

        {{ patch.date | date: "%B %d, %Y" }}

        - - {% if patch.version != latestPatch and allVersions[currentVersion].currentRelease == latestRelease %} -

        {% data ui.header.notices.ghes_release_notes_upgrade_patch_only %}

        - {% endif %} - - {% if patch.version == latestPatch and allVersions[currentVersion].currentRelease != latestRelease %} -

        {% data ui.header.notices.ghes_release_notes_upgrade_release_only %}

        - {% endif %} - - {% if patch.version != latestPatch and allVersions[currentVersion].currentRelease != latestRelease %} -

        {% data ui.header.notices.ghes_release_notes_upgrade_patch_and_release %}

        - {% endif %} -
        - -
        -
        {{ patch.intro }}
        - - {% for section in patch.sections %} -
        -
        - {% include release-notes-category-label %} -
        - -
          - {% for note in section[1] %} -
        • - {% if note.heading %} - {% assign slug = note.heading | slugify %} - -

          - {{ note.heading }} -

          - -
            - {% for subNote in note.notes %} -
          • {{ subNote }}
            • - {% endfor %} -
          - {% else %} - {{ note }} - {% endif %} -
          • - {% endfor %} -
        -
        - {% endfor %} -
        -
        - {% endfor %} -
        -
        - - -
        + {% if allVersions[currentVersion].plan == 'github-ae' %} + {% include github-ae-release-notes %} + {% endif %} {% include support-section %} {% include small-footer %} diff --git a/lib/hydro.js b/lib/hydro.js index 0c74378f6f..38af0b1a1d 100644 --- a/lib/hydro.js +++ b/lib/hydro.js @@ -13,7 +13,8 @@ const SCHEMAS = { experiment: 'docs.v0.ExperimentEvent', redirect: 'docs.v0.RedirectEvent', clipboard: 'docs.v0.ClipboardEvent', - print: 'docs.v0.PrintEvent' + print: 'docs.v0.PrintEvent', + preference: 'docs.v0.PreferenceEvent' } module.exports = class Hydro { diff --git a/lib/release-notes-utils.js b/lib/release-notes-utils.js new file mode 100644 index 0000000000..e5883b51ec --- /dev/null +++ b/lib/release-notes-utils.js @@ -0,0 +1,104 @@ +const semver = require('semver') +const renderContent = require('./render-content') + +/** + * Turn { [key]: { notes, intro, date } } + * into [{ version, notes, intro, date }] + */ +function sortPatchKeys (release, version, options = {}) { + const keys = Object.keys(release) + .map(key => { + const keyWithDots = key.replace(/-/g, '.') + return { + version: `${version}.${keyWithDots}`, + patchVersion: keyWithDots, + downloadVersion: `${version}.${keyWithDots.replace(/\.rc\d*$/, '')}`, + release: version, // TODO this naming :/ we are not currently using this value, but we may want to. + ...release[key] + } + }) + // Filter out any deprecated patches + .filter(key => !key.deprecated) + + // Versions with numbered releases like GHES 2.22, 3.0, etc. need additional semver sorting; + // Versions with date releases need to be sorted by date. + return options.semverSort + ? semverSort(keys) + : keys.sort((a, b) => new Date(b.date) - new Date(a.date)) +} + +function semverSort (keys) { + return keys + .sort((a, b) => { + let aTemp = a.version + let bTemp = b.version + + // There's an RC version here, so doing regular semver + // comparisons won't work. So, we'll convert the incompatible version + // strings to real semver strings, then compare. + const [aBase, aRc] = a.version.split('.rc') + if (aRc) aTemp = `${aBase}-rc.${aRc}` + + const [bBase, bRc] = b.version.split('.rc') + if (bRc) bTemp = `${bBase}-rc.${bRc}` + + if (semver.gt(aTemp, bTemp)) return -1 + if (semver.lt(aTemp, bTemp)) return 1 + return 0 + }) +} + +/** + * Render each note in the given patch, by looping through the + * sections and rendering either `note` or `note.notes` in the + * case of a sub-section + */ +async function renderPatchNotes (patch, ctx) { + // Run the notes through the markdown rendering pipeline + for (const key in patch.sections) { + await Promise.all(patch.sections[key].map(async (noteOrHeading, index) => { + patch.sections[key][index] = typeof noteOrHeading === 'string' + ? await renderContent(noteOrHeading, ctx) + : { + ...noteOrHeading, + notes: await Promise.all(noteOrHeading.notes.map(note => renderContent(note, ctx))) + } + })) + } + + // Also render the patch's intro + if (patch.intro) { + patch.intro = await renderContent(patch.intro, ctx) + } + + return patch +} + +function sortReleasesByDate (releaseNotes) { + return Object.keys(releaseNotes) + .map(release => { + const [year, month] = release.split('-') + return { + name: release, + date: new Date(`20${year}`, month - 1, '1') + } + }) + .sort((releaseEntry1, releaseEntry2) => releaseEntry2.date - releaseEntry1.date) + .map(releaseEntry => releaseEntry.name) +} + +function getAllReleases (releases, releaseNotesPerPlan, hasNumberedReleases) { + return releases.map(version => { + const release = releaseNotesPerPlan[version.replace(/\./g, '-')] + if (!release) return { version } + const patches = sortPatchKeys(release, version, { semverSort: hasNumberedReleases }) + return { version, patches } + }) +} + +module.exports = { + sortReleasesByDate, + sortPatchKeys, + renderPatchNotes, + getAllReleases +} diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 900e2bc08f..446644941c 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -50198,6 +50198,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

        The id of the content_reference event.

        " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
        await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", + "bodyParameters": [ + { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -94693,184 +94872,5 @@ ], "bodyParameters": [], "descriptionHTML": "

        Get a random sentence from the Zen of GitHub

        " - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "https://api.github.com", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

        The id of the content_reference event.

        " - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n https://api.github.com/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  https://api.github.com/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
        await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", - "bodyParameters": [ - { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/ghes-2.18.json b/lib/rest/static/decorated/ghes-2.18.json index fbd01943d0..891ad862e6 100644 --- a/lib/rest/static/decorated/ghes-2.18.json +++ b/lib/rest/static/decorated/ghes-2.18.json @@ -31642,6 +31642,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

        The id of the content_reference event.

        " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
        await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.18/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", + "bodyParameters": [ + { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -65625,184 +65804,5 @@ ], "bodyParameters": [], "descriptionHTML": "

        Get a random sentence from the Zen of GitHub

        " - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

        The id of the content_reference event.

        " - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
        await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.18/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", - "bodyParameters": [ - { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/ghes-2.19.json b/lib/rest/static/decorated/ghes-2.19.json index a0cfea7cc5..a796837325 100644 --- a/lib/rest/static/decorated/ghes-2.19.json +++ b/lib/rest/static/decorated/ghes-2.19.json @@ -32239,6 +32239,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

        The id of the content_reference event.

        " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
        await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.19/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", + "bodyParameters": [ + { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -66245,184 +66424,5 @@ ], "bodyParameters": [], "descriptionHTML": "

        Get a random sentence from the Zen of GitHub

        " - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

        The id of the content_reference event.

        " - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
        await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.19/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", - "bodyParameters": [ - { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/ghes-2.20.json b/lib/rest/static/decorated/ghes-2.20.json index a66c832c50..3006535474 100644 --- a/lib/rest/static/decorated/ghes-2.20.json +++ b/lib/rest/static/decorated/ghes-2.20.json @@ -32713,6 +32713,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

        The id of the content_reference event.

        " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
        await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.20/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.20/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.20/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", + "bodyParameters": [ + { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -66807,184 +66986,5 @@ ], "bodyParameters": [], "descriptionHTML": "

        Get a random sentence from the Zen of GitHub

        " - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

        The id of the content_reference event.

        " - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
        await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.20/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.20/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.20/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", - "bodyParameters": [ - { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/ghes-2.21.json b/lib/rest/static/decorated/ghes-2.21.json index 3563b97abf..ac8fb1d627 100644 --- a/lib/rest/static/decorated/ghes-2.21.json +++ b/lib/rest/static/decorated/ghes-2.21.json @@ -36277,6 +36277,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

        The id of the content_reference event.

        " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
        await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.21/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.21/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.21/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", + "bodyParameters": [ + { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -71042,184 +71221,5 @@ ], "bodyParameters": [], "descriptionHTML": "

        Get a random sentence from the Zen of GitHub

        " - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

        The id of the content_reference event.

        " - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
        await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.21/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.21/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.21/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", - "bodyParameters": [ - { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json index 0ec65296dd..6df593b651 100644 --- a/lib/rest/static/decorated/ghes-2.22.json +++ b/lib/rest/static/decorated/ghes-2.22.json @@ -44064,6 +44064,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

        The id of the content_reference event.

        " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
        await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.22/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", + "bodyParameters": [ + { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -78682,184 +78861,5 @@ ], "bodyParameters": [], "descriptionHTML": "

        Get a random sentence from the Zen of GitHub

        " - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

        The id of the content_reference event.

        " - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
        await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.22/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", - "bodyParameters": [ - { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index 861902e0c5..c2cabe1af9 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -48521,6 +48521,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

        The id of the content_reference event.

        " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
        await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.0/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", + "bodyParameters": [ + { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -83412,184 +83591,5 @@ ], "bodyParameters": [], "descriptionHTML": "

        Get a random sentence from the Zen of GitHub

        " - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

        The id of the content_reference event.

        " - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
        await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.0/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", - "bodyParameters": [ - { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 5d0b6ef924..e2514f8310 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -49210,6 +49210,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://{hostname}", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

        The id of the content_reference event.

        " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
        await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.1/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.1/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.1/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", + "bodyParameters": [ + { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -84304,184 +84483,5 @@ ], "bodyParameters": [], "descriptionHTML": "

        Get a random sentence from the Zen of GitHub

        " - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://{hostname}", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

        The id of the content_reference event.

        " - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
        await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.1/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.1/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.1/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", - "bodyParameters": [ - { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 5d09a18675..64e2d491de 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -41707,6 +41707,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

        The id of the content_reference event.

        " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
        await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/github-ae@latest/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", + "bodyParameters": [ + { + "description": "

        Required. The title of the attachment

        ", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

        Required. The body of the attachment

        ", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -75534,184 +75713,5 @@ ], "bodyParameters": [], "descriptionHTML": "

        Get a random sentence from the Zen of GitHub

        " - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://api.{hostname}", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The owner of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

        The name of the repository. Determined from the repository full_name of the content_reference event.

        " - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

        The id of the content_reference event.

        " - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://api.{hostname}/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
        curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://api.{hostname}/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
        " - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
        await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
        " - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/github-ae@latest/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

        To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

        \n
        application/vnd.github.corsair-preview+json
        " - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

        \n

        The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

        \n

        You must use an installation access token to access this endpoint.

        ", - "bodyParameters": [ - { - "description": "

        Required. The title of the attachment

        ", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

        Required. The body of the attachment

        ", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
        {\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
        " - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index a1b897f243..053a4b7493 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -185332,6 +185332,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -392433,313 +392740,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/ghes-2.18.deref.json b/lib/rest/static/dereferenced/ghes-2.18.deref.json index 619469fe3d..8296bfb812 100644 --- a/lib/rest/static/dereferenced/ghes-2.18.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.18.deref.json @@ -117293,6 +117293,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.18/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -296922,313 +297229,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.18/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/ghes-2.19.deref.json b/lib/rest/static/dereferenced/ghes-2.19.deref.json index 3810620046..3ccc1e8aad 100644 --- a/lib/rest/static/dereferenced/ghes-2.19.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.19.deref.json @@ -120335,6 +120335,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.19/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -300288,313 +300595,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.19/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/ghes-2.20.deref.json b/lib/rest/static/dereferenced/ghes-2.20.deref.json index 770b9f402c..8cd03d7601 100644 --- a/lib/rest/static/dereferenced/ghes-2.20.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.20.deref.json @@ -122556,6 +122556,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.20/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.20/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.20/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -303594,313 +303901,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.20/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.20/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.20/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/ghes-2.21.deref.json b/lib/rest/static/dereferenced/ghes-2.21.deref.json index 84527ae4e6..025848fbc9 100644 --- a/lib/rest/static/dereferenced/ghes-2.21.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.21.deref.json @@ -134168,6 +134168,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.21/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.21/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.21/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -313642,313 +313949,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.21/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.21/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.21/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/ghes-2.22.deref.json b/lib/rest/static/dereferenced/ghes-2.22.deref.json index cec548f694..aa6b8e7c8f 100644 --- a/lib/rest/static/dereferenced/ghes-2.22.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.22.deref.json @@ -165071,6 +165071,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.22/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -345131,313 +345438,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.22/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index 214b73f6ce..e9706e24f4 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -170466,6 +170466,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.0/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -350852,313 +351159,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.0/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index 1a98e1cf46..5ac9f83b12 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -173350,6 +173350,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.1/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.1/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.1/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -355243,313 +355550,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.1/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.1/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.1/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 648467a8bf..3d6bdd4ae4 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -141894,6 +141894,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/github-ae@latest/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -311664,313 +311971,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/github-ae@latest/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/schema-event.js b/lib/schema-event.js index e832eecc97..f32ad34ec7 100644 --- a/lib/schema-event.js +++ b/lib/schema-event.js @@ -109,7 +109,22 @@ const context = { user_language: { type: 'string', description: 'The browser value of `navigator.language`.' + }, + + // Preference information + /* os_preference: { + type: 'string', + description: 'The os for examples selected by the user.' + }, */ + application_preference: { + type: 'string', + enum: ['webui', 'cli', 'desktop'], + description: 'The application selected by the user.' } + /* color_mode_preference: { + type: 'string', + description: 'The color mode selected by the user.' + } */ } } @@ -376,6 +391,34 @@ const printSchema = { } } +const preferenceSchema = { + type: 'object', + additionalProperties: false, + required: [ + 'type', + 'context', + 'preference_name', + 'preference_value' + ], + properties: { + context, + type: { + type: 'string', + pattern: '^preference$' + }, + preference_name: { + type: 'string', + enum: ['application'], // os, color_mode + description: 'The preference name, such as os, application, or color_mode' + }, + preference_value: { + type: 'string', + enum: ['webui', 'cli', 'desktop'], + description: 'The application selected by the user.' + } + } +} + module.exports = { oneOf: [ pageSchema, @@ -387,6 +430,7 @@ module.exports = { experimentSchema, redirectSchema, clipboardSchema, - printSchema + printSchema, + preferenceSchema ] } diff --git a/middleware/connect-datadog.js b/middleware/connect-datadog.js index f17821d4c1..38c7eacd1c 100644 --- a/middleware/connect-datadog.js +++ b/middleware/connect-datadog.js @@ -1,8 +1,17 @@ const connectDatadog = require('connect-datadog') const statsd = require('../lib/statsd') -module.exports = connectDatadog({ - dogstatsd: statsd, - method: true, // Track HTTP methods (GET, POST, etc) - response_code: true // Track response codes -}) +module.exports = (req, res, next) => { + const tags = [] + + if ('nextjs' in req.query) { + tags.push('nextjs') + } + + return connectDatadog({ + dogstatsd: statsd, + method: true, // Track HTTP methods (GET, POST, etc) + response_code: true, // Track response codes + tags + })(req, res, next) +} diff --git a/middleware/contextualizers/enterprise-release-notes.js b/middleware/contextualizers/enterprise-release-notes.js deleted file mode 100644 index 94e00e4cbf..0000000000 --- a/middleware/contextualizers/enterprise-release-notes.js +++ /dev/null @@ -1,124 +0,0 @@ -const semver = require('semver') -const renderContent = require('../../lib/render-content') -const patterns = require('../../lib/patterns') -const { all, firstReleaseNote, latest } = require('../../lib/enterprise-server-releases') - -// Display all GHES release notes, regardless of deprecation status, -// starting with the first release notes in 2.20 -const supported = all.filter(release => { - return semver.gte( - semver.coerce(release), semver.coerce(firstReleaseNote) - ) && release !== '11.10.340' -}) - -/** - * Turn { [key]: { notes, intro, date } } - * into [{ version, notes, intro, date }] - */ -function sortPatchKeys (release, version) { - const keys = Object.keys(release) - .map(key => { - const keyWithDots = key.replace(/-/g, '.') - return { - version: `${version}.${keyWithDots}`, - patchVersion: keyWithDots, - downloadVersion: `${version}.${keyWithDots.replace(/\.rc\d*$/, '')}`, - ...release[key] - } - }) - // Filter out any deprecated patches - .filter(key => !key.deprecated) - return keys - .sort((a, b) => { - let aTemp = a.version - let bTemp = b.version - - // There's an RC version here, so doing regular semver - // comparisons won't work. So, we'll convert the incompatible version - // strings to real semver strings, then compare. - const [aBase, aRc] = a.version.split('.rc') - if (aRc) aTemp = `${aBase}-rc.${aRc}` - - const [bBase, bRc] = b.version.split('.rc') - if (bRc) bTemp = `${bBase}-rc.${bRc}` - - if (semver.gt(aTemp, bTemp)) return -1 - if (semver.lt(aTemp, bTemp)) return 1 - return 0 - }) -} - -/** - * Render each note in the given patch, by looping through the - * sections and rendering either `note` or `note.notes` in the - * case of a sub-section - */ -async function renderPatchNotes (patch, ctx) { - // Run the notes through the markdown rendering pipeline - for (const key in patch.sections) { - await Promise.all(patch.sections[key].map(async (noteOrHeading, index) => { - patch.sections[key][index] = typeof noteOrHeading === 'string' - ? await renderContent(noteOrHeading, ctx) - : { - ...noteOrHeading, - notes: await Promise.all(noteOrHeading.notes.map(note => renderContent(note, ctx))) - } - })) - } - - // Also render the patch's intro - if (patch.intro) { - patch.intro = await renderContent(patch.intro, ctx) - } - - return patch -} - -module.exports = async function enterpriseReleaseNotesContext (req, res, next) { - // The `/release-notes` sub-path - if (!(req.path.endsWith('/release-notes') || req.path.endsWith('/admin'))) return next() - - // ignore paths that don't have an enterprise version number - if (!patterns.getEnterpriseServerNumber.test(req.path)) return next() - - // extract enterprise version from path, e.g. 2.16 - const requestedVersion = req.path.match(patterns.getEnterpriseServerNumber)[1] - - const versionString = `${requestedVersion.replace(/\./g, '-')}` - - const allReleaseNotes = req.context.site.data['release-notes'] - - // This version doesn't have any release notes - let's be helpful and redirect - // to the notes on `enterprise.github.com` - if (!allReleaseNotes || !allReleaseNotes[versionString]) { - return res.redirect(`https://enterprise.github.com/releases/${requestedVersion}.0/notes`) - } - - const releaseNotes = allReleaseNotes[versionString] - const patches = sortPatchKeys(releaseNotes, requestedVersion) - - req.context.releaseNotes = await Promise.all(patches.map(async patch => renderPatchNotes(patch, req.context))) - - // Put together information about other releases - req.context.releases = supported.map(version => { - const ret = { version } - if (!req.context.site.data['release-notes']) return ret - const release = req.context.site.data['release-notes'][version.replace(/\./g, '-')] - if (!release) return ret - const patches = sortPatchKeys(release, version) - - const firstPreviousRelease = all[all.findIndex(v => v === version) + 1] - const secondPreviousRelease = all[all.findIndex(v => v === firstPreviousRelease) + 1] - - return { ...ret, patches, firstPreviousRelease, secondPreviousRelease } - }) - - const releaseIndex = supported.findIndex(release => release === requestedVersion) - req.context.nextRelease = supported[releaseIndex - 1] - req.context.prevRelease = supported[releaseIndex + 1] - - req.context.latestPatch = patches[0].version - req.context.latestRelease = latest - - return next() -} diff --git a/middleware/contextualizers/release-notes.js b/middleware/contextualizers/release-notes.js new file mode 100644 index 0000000000..2a54833aab --- /dev/null +++ b/middleware/contextualizers/release-notes.js @@ -0,0 +1,74 @@ +const semver = require('semver') +const { all, latest, firstReleaseNote } = require('../../lib/enterprise-server-releases') +const { sortReleasesByDate, sortPatchKeys, renderPatchNotes, getAllReleases } = require('../../lib/release-notes-utils') + +// Display all GHES release notes, regardless of deprecation status, +// starting with the first release notes in 2.20 +const supported = all.filter(release => { + return semver.gte( + semver.coerce(release), semver.coerce(firstReleaseNote) + ) && release !== '11.10.340' +}) + +module.exports = async function releaseNotesContext (req, res, next) { + // The `/release-notes` sub-path + if (!(req.path.endsWith('/release-notes') || req.path.endsWith('/admin'))) return next() + + const [requestedPlan, requestedRelease] = req.context.currentVersion.split('@') + const releaseNotesPerPlan = req.context.site.data['release-notes'][requestedPlan] + + // 404 if no release notes can be found + if (!releaseNotesPerPlan) return next() + + // Release notes handling differs if version has numbered releases (like GHES) or not (like GHAE) + const hasNumberedReleases = !(requestedRelease === 'latest') + + // GHES gets handled here... + if (hasNumberedReleases) { + const currentReleaseNotes = releaseNotesPerPlan[`${requestedRelease.replace(/\./g, '-')}`] + + if (!currentReleaseNotes && req.path.endsWith('/release-notes')) { + // If the GHES version doesn't have any release notes, let's be helpful and redirect to `enterprise.github.com` + return requestedPlan === 'enterprise-server' + ? res.redirect(`https://enterprise.github.com/releases/${requestedRelease}.0/notes`) + : next() + } + + const patches = sortPatchKeys(currentReleaseNotes, requestedRelease, { semverSort: hasNumberedReleases }) + req.context.releaseNotes = await Promise.all(patches.map(async patch => renderPatchNotes(patch, req.context))) + req.context.releases = getAllReleases(supported, releaseNotesPerPlan, hasNumberedReleases) + + // Add firstPreviousRelease and secondPreviousRelease convenience props for use in includes/product-releases.html + req.context.releases.forEach(release => { + release.firstPreviousRelease = all[all.findIndex(v => v === release.version) + 1] + release.secondPreviousRelease = all[all.findIndex(v => v === release.firstPreviousRelease) + 1] + }) + + const releaseIndex = supported.findIndex(release => release === requestedRelease) + req.context.nextRelease = supported[releaseIndex - 1] + req.context.prevRelease = supported[releaseIndex + 1] + + req.context.latestPatch = patches[0].version + req.context.latestRelease = latest + } + + // GHAE gets handled here... + if (!hasNumberedReleases) { + const sortedReleases = sortReleasesByDate(releaseNotesPerPlan) + const sortedNotes = sortedReleases.map(release => sortPatchKeys(releaseNotesPerPlan[release], release, { semverSort: false })).flat() + + req.context.releaseNotes = await Promise.all(sortedNotes.map(async patch => renderPatchNotes(patch, req.context))) + req.context.releases = getAllReleases(sortedReleases, releaseNotesPerPlan, hasNumberedReleases) + // do some date format massaging, since we want the friendly date to render as the "version" + .map(r => { + const d = r.patches[0].friendlyDate.split(' ') + d.splice(1, 1) + r.version = d.join(' ') + return r + }) + + req.context.latestPatch = sortedNotes[0].date + } + + return next() +} diff --git a/middleware/index.js b/middleware/index.js index ab5beb09d0..7cffb68e5d 100644 --- a/middleware/index.js +++ b/middleware/index.js @@ -36,7 +36,13 @@ module.exports = function (app) { // *** Security *** app.use(require('./cors')) - app.use(require('helmet')()) + app.use(require('helmet')({ + // Override referrerPolicy to match the browser's default: "strict-origin-when-cross-origin". + // Helmet now defaults to "no-referrer", which is a problem for our archived assets proxying. + referrerPolicy: { + policy: 'strict-origin-when-cross-origin' + } + })) app.use(require('./csp')) // Must come after helmet app.use(require('./cookie-parser')) // Must come before csrf app.use(express.json()) // Must come before csrf @@ -105,7 +111,7 @@ module.exports = function (app) { app.use(haltOnDroppedConnection) // *** Preparation for render-page: contextualizers *** - app.use(asyncMiddleware(instrument('./contextualizers/enterprise-release-notes'))) + app.use(asyncMiddleware(instrument('./contextualizers/release-notes'))) app.use(instrument('./contextualizers/graphql')) app.use(instrument('./contextualizers/rest')) app.use(instrument('./contextualizers/webhooks')) diff --git a/middleware/render-page.js b/middleware/render-page.js index 2db7731155..30e177a16f 100644 --- a/middleware/render-page.js +++ b/middleware/render-page.js @@ -84,16 +84,37 @@ module.exports = async function renderPage (req, res, next) { } const originalUrl = pathname + ([...searchParams].length > 0 ? `?${searchParams}` : '') - // Serve from the cache if possible (skip during tests) - const isCacheable = !process.env.CI && process.env.NODE_ENV !== 'test' && req.method === 'GET' - // Is the request for JSON debugging info? const isRequestingJsonForDebugging = 'json' in req.query && process.env.NODE_ENV !== 'production' // Should the current path be rendered by NextJS? const renderWithNextjs = 'nextjs' in req.query && FEATURE_NEXTJS - if (isCacheable && !isRequestingJsonForDebugging && !renderWithNextjs) { + // Is in an airgapped session? + const isAirgapped = Boolean(req.cookies.AIRGAP) + + // Is the request for the GraphQL Explorer page? + const isGraphQLExplorer = req.context.currentPathWithoutLanguage === '/graphql/overview/explorer' + + // Serve from the cache if possible + const isCacheable = ( + // Skip for CI + !process.env.CI && + // Skip for tests + process.env.NODE_ENV !== 'test' && + // Skip for HTTP methods other than GET + req.method === 'GET' && + // Skip for JSON debugging info requests + !isRequestingJsonForDebugging && + // Skip for NextJS rendering + !renderWithNextjs && + // Skip for airgapped sessions + !isAirgapped && + // Skip for the GraphQL Explorer page + !isGraphQLExplorer + ) + + if (isCacheable) { // Stop processing if the connection was already dropped if (isConnectionDropped(req, res)) return @@ -164,19 +185,20 @@ module.exports = async function renderPage (req, res, next) { } } + // Hand rendering over to NextJS when appropriate if (renderWithNextjs) { - nextHandleRequest(req, res) - } else { - // currentLayout is added to the context object in middleware/contextualizers/layouts - const output = await liquid.parseAndRender(req.context.currentLayout, context) + return nextHandleRequest(req, res) + } - // First, send the response so the user isn't waiting - // NOTE: Do NOT `return` here as we still need to cache the response afterward! - res.send(modifyOutput(req, output)) + // currentLayout is added to the context object in middleware/contextualizers/layouts + const output = await liquid.parseAndRender(req.context.currentLayout, context) - // Finally, save output to cache for the next time around - if (isCacheable) { - await pageCache.set(originalUrl, output, { expireIn: pageCacheExpiration }) - } + // First, send the response so the user isn't waiting + // NOTE: Do NOT `return` here as we still need to cache the response afterward! + res.send(modifyOutput(req, output)) + + // Finally, save output to cache for the next time around + if (isCacheable) { + await pageCache.set(originalUrl, output, { expireIn: pageCacheExpiration }) } } diff --git a/package-lock.json b/package-lock.json index c367a260ca..53adcbb73a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -51,13 +51,14 @@ "lunr": "^2.3.9", "lunr-languages": "^1.4.0", "morgan": "^1.10.0", - "next": "^10.2.0", + "next": "^10.2.3", "node-fetch": "^2.6.1", "parse5": "^6.0.1", "port-used": "^2.0.8", "rate-limit-redis": "^2.1.0", "react": "^17.0.2", "react-dom": "^17.0.2", + "react-is": "^17.0.2", "redis": "^3.1.2", "redis-mock": "^0.56.3", "rehype-autolink-headings": "^2.0.5", @@ -2110,9 +2111,9 @@ "dev": true }, "node_modules/@hapi/accept": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/@hapi/accept/-/accept-5.0.1.tgz", - "integrity": "sha512-fMr4d7zLzsAXo28PRRQPXR1o2Wmu+6z+VY1UzDp0iFo13Twj8WePakwXBiqn3E1aAlTpSNzCXdnnQXFhst8h8Q==", + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/@hapi/accept/-/accept-5.0.2.tgz", + "integrity": "sha512-CmzBx/bXUR8451fnZRuZAJRlzgm0Jgu5dltTX/bszmR2lheb9BpyN47Q1RbaGTsvFzn0PXAEs+lXDKfshccYZw==", "dependencies": { "@hapi/boom": "9.x.x", "@hapi/hoek": "9.x.x" @@ -3320,19 +3321,19 @@ } }, "node_modules/@next/env": { - "version": "10.2.0", - "resolved": "https://registry.npmjs.org/@next/env/-/env-10.2.0.tgz", - "integrity": "sha512-tsWBsn1Rb6hXRaHc/pWMCpZ4Ipkf3OCbZ54ef5ukgIyEvzzGdGFXQshPP2AF7yb+8yMpunWs7vOMZW3e8oPF6A==" + "version": "10.2.3", + "resolved": "https://registry.npmjs.org/@next/env/-/env-10.2.3.tgz", + "integrity": "sha512-uBOjRBjsWC4C8X3DfmWWP6ekwLnf2JCCwQX9KVnJtJkqfDsv1yQPakdOEwvJzXQc3JC/v5KKffYPVmV2wHXCgQ==" }, "node_modules/@next/polyfill-module": { - "version": "10.2.0", - "resolved": "https://registry.npmjs.org/@next/polyfill-module/-/polyfill-module-10.2.0.tgz", - "integrity": "sha512-Nl3GexIUXsmuggkUqrRFyE/2k7UI44JaVzSywtXEyHzxpZm2a5bdMaWuC89pgLiFDDOqmbqyLAbtwm5lNxa7Eg==" + "version": "10.2.3", + "resolved": "https://registry.npmjs.org/@next/polyfill-module/-/polyfill-module-10.2.3.tgz", + "integrity": "sha512-OkeY4cLhzfYbXxM4fd+6V4s5pTPuyfKSlavItfNRA6PpS7t1/R6YjO7S7rB8tu1pbTGuDHGIdE1ioDv15bAbDQ==" }, "node_modules/@next/react-dev-overlay": { - "version": "10.2.0", - "resolved": "https://registry.npmjs.org/@next/react-dev-overlay/-/react-dev-overlay-10.2.0.tgz", - "integrity": "sha512-PRIAoWog41hLN4iJ8dChKp4ysOX0Q8yiNQ/cwzyqEd3EjugkDV5OiKl3mumGKaApJaIra1MX6j1wgQRuLhuWMA==", + "version": "10.2.3", + "resolved": "https://registry.npmjs.org/@next/react-dev-overlay/-/react-dev-overlay-10.2.3.tgz", + "integrity": "sha512-E6g2jws4YW94l0lMMopBVKIZK2mEHfSBvM0d9dmzKG9L/A/kEq6LZCB4SiwGJbNsAdlk2y3USDa0oNbpA+m5Kw==", "dependencies": { "@babel/code-frame": "7.12.11", "anser": "1.4.9", @@ -3345,6 +3346,10 @@ "source-map": "0.8.0-beta.0", "stacktrace-parser": "0.1.10", "strip-ansi": "6.0.0" + }, + "peerDependencies": { + "react": "^16.9.0 || ^17", + "react-dom": "^16.9.0 || ^17" } }, "node_modules/@next/react-dev-overlay/node_modules/ansi-regex": { @@ -3355,6 +3360,20 @@ "node": ">=8" } }, + "node_modules/@next/react-dev-overlay/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, "node_modules/@next/react-dev-overlay/node_modules/chalk": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.0.0.tgz", @@ -3365,20 +3384,17 @@ }, "engines": { "node": ">=10" - } - }, - "node_modules/@next/react-dev-overlay/node_modules/chalk/node_modules/ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dependencies": { - "color-convert": "^2.0.1" }, - "engines": { - "node": ">=8" + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" } }, - "node_modules/@next/react-dev-overlay/node_modules/chalk/node_modules/color-convert": { + "node_modules/@next/react-dev-overlay/node_modules/classnames": { + "version": "2.2.6", + "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.2.6.tgz", + "integrity": "sha512-JR/iSQOSt+LQIWwrwEzJ9uk0xfN3mTVYMwt1Ir5mUcSN6pU+V4zQFFaJsclJbPuAUQH+yfWef6tm7l1quW3C8Q==" + }, + "node_modules/@next/react-dev-overlay/node_modules/color-convert": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", @@ -3389,7 +3405,12 @@ "node": ">=7.0.0" } }, - "node_modules/@next/react-dev-overlay/node_modules/chalk/node_modules/has-flag": { + "node_modules/@next/react-dev-overlay/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" + }, + "node_modules/@next/react-dev-overlay/node_modules/has-flag": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", @@ -3397,27 +3418,6 @@ "node": ">=8" } }, - "node_modules/@next/react-dev-overlay/node_modules/chalk/node_modules/supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dependencies": { - "has-flag": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/@next/react-dev-overlay/node_modules/classnames": { - "version": "2.2.6", - "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.2.6.tgz", - "integrity": "sha512-JR/iSQOSt+LQIWwrwEzJ9uk0xfN3mTVYMwt1Ir5mUcSN6pU+V4zQFFaJsclJbPuAUQH+yfWef6tm7l1quW3C8Q==" - }, - "node_modules/@next/react-dev-overlay/node_modules/color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" - }, "node_modules/@next/react-dev-overlay/node_modules/source-map": { "version": "0.8.0-beta.0", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.8.0-beta.0.tgz", @@ -3440,6 +3440,17 @@ "node": ">=8" } }, + "node_modules/@next/react-dev-overlay/node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/@next/react-dev-overlay/node_modules/tr46": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/tr46/-/tr46-1.0.1.tgz", @@ -3464,9 +3475,18 @@ } }, "node_modules/@next/react-refresh-utils": { - "version": "10.2.0", - "resolved": "https://registry.npmjs.org/@next/react-refresh-utils/-/react-refresh-utils-10.2.0.tgz", - "integrity": "sha512-3I31K9B4hEQRl7yQ44Umyz+szHtuMJrNdwsgJGhoEnUCXSBRHp5wv5Zv8eDa2NewSbe53b2C0oOpivrzmdBakw==" + "version": "10.2.3", + "resolved": "https://registry.npmjs.org/@next/react-refresh-utils/-/react-refresh-utils-10.2.3.tgz", + "integrity": "sha512-qtBF56vPC6d6a8p7LYd0iRjW89fhY80kAIzmj+VonvIGjK/nymBjcFUhbKiMFqlhsarCksnhwX+Zmn95Dw9qvA==", + "peerDependencies": { + "react-refresh": "0.8.3", + "webpack": "^4 || ^5" + }, + "peerDependenciesMeta": { + "webpack": { + "optional": true + } + } }, "node_modules/@nodelib/fs.scandir": { "version": "2.1.4", @@ -4003,7 +4023,7 @@ "version": "7.2.8", "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-7.2.8.tgz", "integrity": "sha512-RTKvBsfz0T8CKOGZMfuluDNyMFHnu5lvNr4hWEsQeHXH6FcmIDIozOyWMh36nLGMwVd5UFNXC2xztA8lln22MQ==", - "dev": true, + "devOptional": true, "dependencies": { "@types/estree": "*", "@types/json-schema": "*" @@ -4013,7 +4033,7 @@ "version": "3.7.0", "resolved": "https://registry.npmjs.org/@types/eslint-scope/-/eslint-scope-3.7.0.tgz", "integrity": "sha512-O/ql2+rrCUe2W2rs7wMR+GqPRcgB6UiqN5RhrR5xruFlY7l9YLMn0ZkDzjoHLeiFkR8MCQZVudUuuvQ2BLC9Qw==", - "dev": true, + "devOptional": true, "dependencies": { "@types/eslint": "*", "@types/estree": "*" @@ -4023,7 +4043,7 @@ "version": "0.0.47", "resolved": "https://registry.npmjs.org/@types/estree/-/estree-0.0.47.tgz", "integrity": "sha512-c5ciR06jK8u9BstrmJyO97m+klJrrhCf9u3rLu3DEAJBirxRqSCvDQoYKmxuYwQI5SZChAWu+tq9oVlGRuzPAg==", - "dev": true + "devOptional": true }, "node_modules/@types/graceful-fs": { "version": "4.1.5", @@ -4089,7 +4109,7 @@ "version": "7.0.7", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.7.tgz", "integrity": "sha512-cxWFQVseBm6O9Gbw1IWb8r6OS4OhSt3hPZLkFApLjM8TEXROBuQGLAH2i2gZpcXdLBIrpXuTDhH7Vbm1iXmNGA==", - "dev": true + "devOptional": true }, "node_modules/@types/json5": { "version": "0.0.29", @@ -4254,7 +4274,7 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.11.0.tgz", "integrity": "sha512-kX2W49LWsbthrmIRMbQZuQDhGtjyqXfEmmHyEi4XWnSZtPmxY0+3anPIzsnRb45VH/J55zlOfWvZuY47aJZTJg==", - "dev": true, + "devOptional": true, "dependencies": { "@webassemblyjs/helper-numbers": "1.11.0", "@webassemblyjs/helper-wasm-bytecode": "1.11.0" @@ -4264,25 +4284,25 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.11.0.tgz", "integrity": "sha512-Q/aVYs/VnPDVYvsCBL/gSgwmfjeCb4LW8+TMrO3cSzJImgv8lxxEPM2JA5jMrivE7LSz3V+PFqtMbls3m1exDA==", - "dev": true + "devOptional": true }, "node_modules/@webassemblyjs/helper-api-error": { "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-api-error/-/helper-api-error-1.11.0.tgz", "integrity": "sha512-baT/va95eXiXb2QflSx95QGT5ClzWpGaa8L7JnJbgzoYeaA27FCvuBXU758l+KXWRndEmUXjP0Q5fibhavIn8w==", - "dev": true + "devOptional": true }, "node_modules/@webassemblyjs/helper-buffer": { "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-buffer/-/helper-buffer-1.11.0.tgz", "integrity": "sha512-u9HPBEl4DS+vA8qLQdEQ6N/eJQ7gT7aNvMIo8AAWvAl/xMrcOSiI2M0MAnMCy3jIFke7bEee/JwdX1nUpCtdyA==", - "dev": true + "devOptional": true }, "node_modules/@webassemblyjs/helper-numbers": { "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-numbers/-/helper-numbers-1.11.0.tgz", "integrity": "sha512-DhRQKelIj01s5IgdsOJMKLppI+4zpmcMQ3XboFPLwCpSNH6Hqo1ritgHgD0nqHeSYqofA6aBN/NmXuGjM1jEfQ==", - "dev": true, + "devOptional": true, "dependencies": { "@webassemblyjs/floating-point-hex-parser": "1.11.0", "@webassemblyjs/helper-api-error": "1.11.0", @@ -4293,13 +4313,13 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.11.0.tgz", "integrity": "sha512-MbmhvxXExm542tWREgSFnOVo07fDpsBJg3sIl6fSp9xuu75eGz5lz31q7wTLffwL3Za7XNRCMZy210+tnsUSEA==", - "dev": true + "devOptional": true }, "node_modules/@webassemblyjs/helper-wasm-section": { "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.11.0.tgz", "integrity": "sha512-3Eb88hcbfY/FCukrg6i3EH8H2UsD7x8Vy47iVJrP967A9JGqgBVL9aH71SETPx1JrGsOUVLo0c7vMCN22ytJew==", - "dev": true, + "devOptional": true, "dependencies": { "@webassemblyjs/ast": "1.11.0", "@webassemblyjs/helper-buffer": "1.11.0", @@ -4311,7 +4331,7 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/ieee754/-/ieee754-1.11.0.tgz", "integrity": "sha512-KXzOqpcYQwAfeQ6WbF6HXo+0udBNmw0iXDmEK5sFlmQdmND+tr773Ti8/5T/M6Tl/413ArSJErATd8In3B+WBA==", - "dev": true, + "devOptional": true, "dependencies": { "@xtuc/ieee754": "^1.2.0" } @@ -4320,7 +4340,7 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/leb128/-/leb128-1.11.0.tgz", "integrity": "sha512-aqbsHa1mSQAbeeNcl38un6qVY++hh8OpCOzxhixSYgbRfNWcxJNJQwe2rezK9XEcssJbbWIkblaJRwGMS9zp+g==", - "dev": true, + "devOptional": true, "dependencies": { "@xtuc/long": "4.2.2" } @@ -4329,13 +4349,13 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/utf8/-/utf8-1.11.0.tgz", "integrity": "sha512-A/lclGxH6SpSLSyFowMzO/+aDEPU4hvEiooCMXQPcQFPPJaYcPQNKGOCLUySJsYJ4trbpr+Fs08n4jelkVTGVw==", - "dev": true + "devOptional": true }, "node_modules/@webassemblyjs/wasm-edit": { "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-edit/-/wasm-edit-1.11.0.tgz", "integrity": "sha512-JHQ0damXy0G6J9ucyKVXO2j08JVJ2ntkdJlq1UTiUrIgfGMmA7Ik5VdC/L8hBK46kVJgujkBIoMtT8yVr+yVOQ==", - "dev": true, + "devOptional": true, "dependencies": { "@webassemblyjs/ast": "1.11.0", "@webassemblyjs/helper-buffer": "1.11.0", @@ -4351,7 +4371,7 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-gen/-/wasm-gen-1.11.0.tgz", "integrity": "sha512-BEUv1aj0WptCZ9kIS30th5ILASUnAPEvE3tVMTrItnZRT9tXCLW2LEXT8ezLw59rqPP9klh9LPmpU+WmRQmCPQ==", - "dev": true, + "devOptional": true, "dependencies": { "@webassemblyjs/ast": "1.11.0", "@webassemblyjs/helper-wasm-bytecode": "1.11.0", @@ -4364,7 +4384,7 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-opt/-/wasm-opt-1.11.0.tgz", "integrity": "sha512-tHUSP5F4ywyh3hZ0+fDQuWxKx3mJiPeFufg+9gwTpYp324mPCQgnuVKwzLTZVqj0duRDovnPaZqDwoyhIO8kYg==", - "dev": true, + "devOptional": true, "dependencies": { "@webassemblyjs/ast": "1.11.0", "@webassemblyjs/helper-buffer": "1.11.0", @@ -4376,7 +4396,7 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-parser/-/wasm-parser-1.11.0.tgz", "integrity": "sha512-6L285Sgu9gphrcpDXINvm0M9BskznnzJTE7gYkjDbxET28shDqp27wpruyx3C2S/dvEwiigBwLA1cz7lNUi0kw==", - "dev": true, + "devOptional": true, "dependencies": { "@webassemblyjs/ast": "1.11.0", "@webassemblyjs/helper-api-error": "1.11.0", @@ -4390,7 +4410,7 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/wast-printer/-/wast-printer-1.11.0.tgz", "integrity": "sha512-Fg5OX46pRdTgB7rKIUojkh9vXaVN6sGYCnEiJN1GYkb0RPwShZXp6KTDqmoMdQPKhcroOXh3fEzmkWmCYaKYhQ==", - "dev": true, + "devOptional": true, "dependencies": { "@webassemblyjs/ast": "1.11.0", "@xtuc/long": "4.2.2" @@ -4421,13 +4441,13 @@ "version": "1.2.0", "resolved": "https://registry.npmjs.org/@xtuc/ieee754/-/ieee754-1.2.0.tgz", "integrity": "sha512-DX8nKgqcGwsc0eJSqYt5lwP4DH5FlHnmuWWBRy7X0NcaGR0ZtuyeESgMwTYVEtxmsNGY+qit4QYT/MIYTOTPeA==", - "dev": true + "devOptional": true }, "node_modules/@xtuc/long": { "version": "4.2.2", "resolved": "https://registry.npmjs.org/@xtuc/long/-/long-4.2.2.tgz", "integrity": "sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ==", - "dev": true + "devOptional": true }, "node_modules/abab": { "version": "2.0.5", @@ -4603,7 +4623,7 @@ "version": "3.5.2", "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", - "dev": true + "devOptional": true }, "node_modules/ajv/node_modules/json-schema-traverse": { "version": "1.0.0", @@ -6352,7 +6372,6 @@ "version": "4.16.6", "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.16.6.tgz", "integrity": "sha512-Wspk/PqO+4W9qp5iUTJsa1B/QrYn1keNCcEP5OvP7WBwT4KaDly0uONYmC6Xa3Z5IqnUgS0KcgLYu1l74x0ZXQ==", - "dev": true, "dependencies": { "caniuse-lite": "^1.0.30001219", "colorette": "^1.2.2", @@ -6851,7 +6870,7 @@ "version": "3.4.1", "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.4.1.tgz", "integrity": "sha512-TQTJyr2stihpC4Sya9hs2Xh+O2wf+igjL36Y75xx2WdHuiICcn/XJza46Jwt0eT5hVpQOzo3FpY3cj3RVYLX0g==", - "dev": true, + "devOptional": true, "dependencies": { "anymatch": "~3.1.1", "braces": "~3.0.2", @@ -6868,20 +6887,11 @@ "fsevents": "~2.1.2" } }, - "node_modules/chokidar/node_modules/binary-extensions": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.1.0.tgz", - "integrity": "sha512-1Yj8h9Q+QDF5FzhMs/c9+6UntbD5MkRfRwac8DoEm9ZfUBZ7tZ55YcGVAzEe4bXsdQHEk+s9S5wsOKVdZrw0tQ==", - "dev": true, - "engines": { - "node": ">=8" - } - }, "node_modules/chokidar/node_modules/braces": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", - "dev": true, + "devOptional": true, "dependencies": { "fill-range": "^7.0.1" }, @@ -6893,7 +6903,7 @@ "version": "7.0.1", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", - "dev": true, + "devOptional": true, "dependencies": { "to-regex-range": "^5.0.1" }, @@ -6908,47 +6918,11 @@ "dev": true, "optional": true }, - "node_modules/chokidar/node_modules/glob-parent": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.1.tgz", - "integrity": "sha512-FnI+VGOpnlGHWZxthPGR+QhR78fuiK0sNLkHQv+bL9fQi57lNNdquIbna/WrfROrolq8GK5Ek6BiMwqL/voRYQ==", - "dev": true, - "dependencies": { - "is-glob": "^4.0.1" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/chokidar/node_modules/is-binary-path": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", - "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", - "dev": true, - "dependencies": { - "binary-extensions": "^2.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/chokidar/node_modules/is-glob": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.1.tgz", - "integrity": "sha512-5G0tKtBTFImOqDnLB2hG6Bp2qcKEFduo4tZu9MT/H6NQv/ghhy30o55ufafxJ/LdH79LLs2Kfrn85TLKyA7BUg==", - "dev": true, - "dependencies": { - "is-extglob": "^2.1.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/chokidar/node_modules/normalize-path": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", - "dev": true, + "devOptional": true, "engines": { "node": ">=0.10.0" } @@ -6957,7 +6931,7 @@ "version": "3.4.0", "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.4.0.tgz", "integrity": "sha512-0xe001vZBnJEK+uKcj8qOhyAKPzIT+gStxWr3LCB0DwcXR5NZJ3IaC+yGnHCYzB/S7ov3m3EEbZI2zeNvX+hGQ==", - "dev": true, + "devOptional": true, "dependencies": { "picomatch": "^2.2.1" }, @@ -6969,7 +6943,7 @@ "version": "5.0.1", "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", - "dev": true, + "devOptional": true, "dependencies": { "is-number": "^7.0.0" }, @@ -6987,7 +6961,7 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/chrome-trace-event/-/chrome-trace-event-1.0.2.tgz", "integrity": "sha512-9e/zx1jw7B4CO+c/RXoCsfg/x1AfUBioy4owYH0bJprEYAx5hRFLRhWBqHAG57D0ZM4H7vxbP7bPe0VwhQRYDQ==", - "dev": true, + "devOptional": true, "dependencies": { "tslib": "^1.9.0" }, @@ -7263,33 +7237,6 @@ "typedarray": "^0.0.6" } }, - "node_modules/concat-stream/node_modules/isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=" - }, - "node_modules/concat-stream/node_modules/readable-stream": { - "version": "2.3.6", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.6.tgz", - "integrity": "sha512-tQtKA9WIAhBF3+VLAseyMqZeBjW0AHJoxOtYqSUZNJxauErmLbVm2FW1y+J/YA9dUrAC39ITejlZWhVIwawkKw==", - "dependencies": { - "core-util-is": "~1.0.0", - "inherits": "~2.0.3", - "isarray": "~1.0.0", - "process-nextick-args": "~2.0.0", - "safe-buffer": "~5.1.1", - "string_decoder": "~1.1.1", - "util-deprecate": "~1.0.1" - } - }, - "node_modules/concat-stream/node_modules/string_decoder": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", - "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", - "dependencies": { - "safe-buffer": "~5.1.0" - } - }, "node_modules/configstore": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/configstore/-/configstore-5.0.1.tgz", @@ -8106,15 +8053,6 @@ "node": ">=0.10" } }, - "node_modules/dashdash/node_modules/assert-plus": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", - "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", - "dev": true, - "engines": { - "node": ">=0.8" - } - }, "node_modules/data-uri-to-buffer": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-3.0.1.tgz", @@ -8791,7 +8729,7 @@ "version": "5.8.2", "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.8.2.tgz", "integrity": "sha512-F27oB3WuHDzvR2DOGNTaYy0D5o0cnrv8TeI482VM4kYgQd/FT9lUQwuNsJ0oOHtBUq7eiW5ytqzp7nBFknL+GA==", - "dev": true, + "devOptional": true, "dependencies": { "graceful-fs": "^4.2.4", "tapable": "^2.2.0" @@ -8887,7 +8825,7 @@ "version": "0.4.1", "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-0.4.1.tgz", "integrity": "sha512-ooYciCUtfw6/d2w56UVeqHPcoCFAiJdz5XOkYpv/Txl1HMUozpXjz/2RIQgqwKdXNDPSF1W7mJCFse3G+HDyAA==", - "dev": true + "devOptional": true }, "node_modules/es-to-primitive": { "version": "1.2.1", @@ -9270,7 +9208,7 @@ "version": "5.1.1", "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", - "dev": true, + "devOptional": true, "dependencies": { "esrecurse": "^4.3.0", "estraverse": "^4.1.1" @@ -9283,7 +9221,7 @@ "version": "4.3.0", "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", - "dev": true, + "devOptional": true, "dependencies": { "estraverse": "^5.2.0" }, @@ -9295,7 +9233,7 @@ "version": "5.2.0", "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", - "dev": true, + "devOptional": true, "engines": { "node": ">=4.0" } @@ -9321,40 +9259,6 @@ "node": ">=4" } }, - "node_modules/eslint/node_modules/@babel/code-frame": { - "version": "7.12.11", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.12.11.tgz", - "integrity": "sha512-Zt1yodBx1UcyiePMSkWnU4hPqhwq7hGi2nFL1LeA3EUl+q2LQx16MISgJ0+z7dnmgvP9QtIleuETGOiOH1RcIw==", - "dev": true, - "dependencies": { - "@babel/highlight": "^7.10.4" - } - }, - "node_modules/eslint/node_modules/@babel/highlight": { - "version": "7.14.0", - "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.14.0.tgz", - "integrity": "sha512-YSCOwxvTYEIMSGaBQb5kDDsCopDdiUGsqpatp3fOlI4+2HQSkTmEVWnVuySdAC5EWCqSWWTv0ib63RjR7dTBdg==", - "dev": true, - "dependencies": { - "@babel/helper-validator-identifier": "^7.14.0", - "chalk": "^2.0.0", - "js-tokens": "^4.0.0" - } - }, - "node_modules/eslint/node_modules/@babel/highlight/node_modules/chalk": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", - "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", - "dev": true, - "dependencies": { - "ansi-styles": "^3.2.1", - "escape-string-regexp": "^1.0.5", - "supports-color": "^5.3.0" - }, - "engines": { - "node": ">=4" - } - }, "node_modules/eslint/node_modules/ajv": { "version": "6.12.6", "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", @@ -9376,18 +9280,6 @@ "node": ">=8" } }, - "node_modules/eslint/node_modules/ansi-styles": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", - "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", - "dev": true, - "dependencies": { - "color-convert": "^1.9.0" - }, - "engines": { - "node": ">=4" - } - }, "node_modules/eslint/node_modules/argparse": { "version": "1.0.10", "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", @@ -9418,18 +9310,6 @@ "node": ">=10" } }, - "node_modules/eslint/node_modules/glob-parent": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.1.tgz", - "integrity": "sha512-FnI+VGOpnlGHWZxthPGR+QhR78fuiK0sNLkHQv+bL9fQi57lNNdquIbna/WrfROrolq8GK5Ek6BiMwqL/voRYQ==", - "dev": true, - "dependencies": { - "is-glob": "^4.0.1" - }, - "engines": { - "node": ">= 6" - } - }, "node_modules/eslint/node_modules/globals": { "version": "13.8.0", "resolved": "https://registry.npmjs.org/globals/-/globals-13.8.0.tgz", @@ -9442,18 +9322,6 @@ "node": ">=8" } }, - "node_modules/eslint/node_modules/is-glob": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.1.tgz", - "integrity": "sha512-5G0tKtBTFImOqDnLB2hG6Bp2qcKEFduo4tZu9MT/H6NQv/ghhy30o55ufafxJ/LdH79LLs2Kfrn85TLKyA7BUg==", - "dev": true, - "dependencies": { - "is-extglob": "^2.1.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/eslint/node_modules/js-yaml": { "version": "3.14.1", "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", @@ -9533,18 +9401,6 @@ "node": ">=8" } }, - "node_modules/eslint/node_modules/supports-color": { - "version": "5.5.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", - "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", - "dev": true, - "dependencies": { - "has-flag": "^3.0.0" - }, - "engines": { - "node": ">=4" - } - }, "node_modules/eslint/node_modules/type-check": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", @@ -10315,7 +10171,7 @@ "version": "2.1.0", "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", - "dev": true + "devOptional": true }, "node_modules/fast-levenshtein": { "version": "2.0.6", @@ -10349,6 +10205,10 @@ "integrity": "sha512-CJ0HCB5tL5fYTEA7ToAq5+kTwd++Borf1/bifxd9iT70QcXr4MRrO3Llf8Ifs70q+SJcGHFtnIE/Nw6giCtECA==", "dependencies": { "format": "^0.2.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" } }, "node_modules/fb-watchman": { @@ -10860,15 +10720,6 @@ "assert-plus": "^1.0.0" } }, - "node_modules/getpass/node_modules/assert-plus": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", - "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", - "dev": true, - "engines": { - "node": ">=0.8" - } - }, "node_modules/gifwrap": { "version": "0.9.2", "resolved": "https://registry.npmjs.org/gifwrap/-/gifwrap-0.9.2.tgz", @@ -11457,6 +11308,10 @@ "hast-util-is-element": "^1.0.0", "repeat-string": "^1.0.0", "unist-util-find-after": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" } }, "node_modules/hast-util-whitespace": { @@ -11520,9 +11375,9 @@ } }, "node_modules/highlight.js": { - "version": "10.3.1", - "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-10.3.1.tgz", - "integrity": "sha512-jeW8rdPdhshYKObedYg5XGbpVgb1/DT4AHvDFXhkU7UnGSIjy9kkJ7zHG7qplhFHMitTSzh5/iClKQk3Kb2RFQ==", + "version": "10.7.2", + "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-10.7.2.tgz", + "integrity": "sha512-oFLl873u4usRM9K63j4ME9u3etNF0PLiJhSQ8rdfuL51Wn3zkD6drf9ZW0dOzjnZI22YYG24z30JcmfCZjMgYg==", "engines": { "node": "*" } @@ -14548,7 +14403,7 @@ "version": "26.6.2", "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-26.6.2.tgz", "integrity": "sha512-KWYVV1c4i+jbMpaBC+U++4Va0cp8OisU185o73T1vo99hqi7w8tSJfUXYswwqqrjzwxa6KpRK54WhPvwf5w6PQ==", - "dev": true, + "devOptional": true, "dependencies": { "@types/node": "*", "merge-stream": "^2.0.0", @@ -14562,7 +14417,7 @@ "version": "4.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true, + "devOptional": true, "engines": { "node": ">=8" } @@ -14571,7 +14426,7 @@ "version": "7.2.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dev": true, + "devOptional": true, "dependencies": { "has-flag": "^4.0.0" }, @@ -14746,7 +14601,7 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==", - "dev": true + "devOptional": true }, "node_modules/json-schema": { "version": "0.2.3", @@ -14758,7 +14613,7 @@ "version": "0.4.1", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "dev": true + "devOptional": true }, "node_modules/json-stable-stringify-without-jsonify": { "version": "1.0.1", @@ -14820,15 +14675,6 @@ "verror": "1.10.0" } }, - "node_modules/jsprim/node_modules/assert-plus": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", - "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", - "dev": true, - "engines": { - "node": ">=0.8" - } - }, "node_modules/jszip": { "version": "3.6.0", "resolved": "https://registry.npmjs.org/jszip/-/jszip-3.6.0.tgz", @@ -15297,7 +15143,7 @@ "version": "4.2.0", "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.2.0.tgz", "integrity": "sha512-92+huvxMvYlMzMt0iIOukcwYBFpkYJdpl2xsZ7LrlayO7E8SOv+JJUEK17B/dJIHAOLMfh2dZZ/Y18WgmGtYNw==", - "dev": true, + "devOptional": true, "engines": { "node": ">=6.11.5" } @@ -15489,12 +15335,16 @@ } }, "node_modules/lowlight": { - "version": "1.16.0", - "resolved": "https://registry.npmjs.org/lowlight/-/lowlight-1.16.0.tgz", - "integrity": "sha512-ECLdzIJvBEjK4ef51sWiGZyz21yx4IEPaF/62DRxLehoOHkWqN3OsLB1GUMfc6Mcf87rR5eW7z6lI9cNEXZDsQ==", + "version": "1.20.0", + "resolved": "https://registry.npmjs.org/lowlight/-/lowlight-1.20.0.tgz", + "integrity": "sha512-8Ktj+prEb1RoCPkEOrPMYUN/nCggB7qAWe3a7OpMjWQkh3l2RD5wKRQ+o8Q8YuI9RG/xs95waaI/E6ym/7NsTw==", "dependencies": { "fault": "^1.0.0", - "highlight.js": "~10.3.0" + "highlight.js": "~10.7.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" } }, "node_modules/lru-cache": { @@ -16428,26 +16278,26 @@ "version": "2.6.2", "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", - "dev": true + "devOptional": true }, "node_modules/next": { - "version": "10.2.0", - "resolved": "https://registry.npmjs.org/next/-/next-10.2.0.tgz", - "integrity": "sha512-PKDKCSF7s82xudu3kQhOEaokxggpbLEWouEUtzP6OqV0YqKYHF+Ff+BFLycEem8ixtTM2M6ElN0VRJcskJfxPQ==", + "version": "10.2.3", + "resolved": "https://registry.npmjs.org/next/-/next-10.2.3.tgz", + "integrity": "sha512-dkM1mIfnORtGyzw/Yme8RdqNxlCMZyi4Lqj56F01/yHbe1ZtOaJ0cyqqRB4RGiPhjGGh0319f8ddjDyO1605Ow==", "dependencies": { "@babel/runtime": "7.12.5", - "@hapi/accept": "5.0.1", - "@next/env": "10.2.0", - "@next/polyfill-module": "10.2.0", - "@next/react-dev-overlay": "10.2.0", - "@next/react-refresh-utils": "10.2.0", + "@hapi/accept": "5.0.2", + "@next/env": "10.2.3", + "@next/polyfill-module": "10.2.3", + "@next/react-dev-overlay": "10.2.3", + "@next/react-refresh-utils": "10.2.3", "@opentelemetry/api": "0.14.0", "assert": "2.0.0", "ast-types": "0.13.2", "browserify-zlib": "0.2.0", - "browserslist": "4.16.1", + "browserslist": "4.16.6", "buffer": "5.6.0", - "caniuse-lite": "^1.0.30001179", + "caniuse-lite": "^1.0.30001228", "chalk": "2.4.2", "chokidar": "3.5.1", "constants-browserify": "1.0.0", @@ -16491,6 +16341,24 @@ }, "engines": { "node": ">=10.13.0" + }, + "peerDependencies": { + "fibers": ">= 3.1.0", + "node-sass": "^4.0.0 || ^5.0.0", + "react": "^16.6.0 || ^17", + "react-dom": "^16.6.0 || ^17", + "sass": "^1.3.0" + }, + "peerDependenciesMeta": { + "fibers": { + "optional": true + }, + "node-sass": { + "optional": true + }, + "sass": { + "optional": true + } } }, "node_modules/next/node_modules/@babel/runtime": { @@ -16523,24 +16391,6 @@ "node": ">=8" } }, - "node_modules/next/node_modules/browserslist": { - "version": "4.16.1", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.16.1.tgz", - "integrity": "sha512-UXhDrwqsNcpTYJBTZsbGATDxZbiVDsx6UjpmRUmtnP10pr8wAYr5LgFoEFw9ixriQH2mv/NX2SfGzE/o8GndLA==", - "dependencies": { - "caniuse-lite": "^1.0.30001173", - "colorette": "^1.2.1", - "electron-to-chromium": "^1.3.634", - "escalade": "^3.1.1", - "node-releases": "^1.1.69" - }, - "bin": { - "browserslist": "cli.js" - }, - "engines": { - "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" - } - }, "node_modules/next/node_modules/bytes": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.0.tgz", @@ -19317,8 +19167,7 @@ "node_modules/react-is": { "version": "17.0.2", "resolved": "https://registry.npmjs.org/react-is/-/react-is-17.0.2.tgz", - "integrity": "sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==", - "devOptional": true + "integrity": "sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==" }, "node_modules/react-refresh": { "version": "0.8.3", @@ -19645,6 +19494,10 @@ "hast-util-to-text": "^2.0.0", "lowlight": "^1.10.0", "unist-util-visit": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" } }, "node_modules/rehype-raw": { @@ -19933,12 +19786,6 @@ "node": ">=0.8" } }, - "node_modules/request/node_modules/extend": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", - "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", - "dev": true - }, "node_modules/request/node_modules/qs": { "version": "6.5.2", "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.2.tgz", @@ -20332,7 +20179,7 @@ "version": "1.32.13", "resolved": "https://registry.npmjs.org/sass/-/sass-1.32.13.tgz", "integrity": "sha512-dEgI9nShraqP7cXQH+lEXVf73WOPCse0QlFzSD8k+1TcOxCMwVXfQlr0jtoluZysQOyJGnfr21dLvYKDJq8HkA==", - "dev": true, + "devOptional": true, "dependencies": { "chokidar": ">=3.0.0 <4.0.0" }, @@ -20532,7 +20379,7 @@ "version": "5.0.1", "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-5.0.1.tgz", "integrity": "sha512-SaaNal9imEO737H2c05Og0/8LUXG7EnsZyMa8MzkmuHoELfT6txuj0cMqRj6zfPKnmQ1yasR4PCJc8x+M4JSPA==", - "dev": true, + "devOptional": true, "dependencies": { "randombytes": "^2.1.0" } @@ -20921,7 +20768,7 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/source-list-map/-/source-list-map-2.0.1.tgz", "integrity": "sha512-qnQ7gVMxGNxsiL4lEuJwe/To8UnK7fAnmbGEEH8RpLouuKbeEm0lhbQVFIrNSuB+G7tVrAlVsZgETT5nljf+Iw==", - "dev": true + "devOptional": true }, "node_modules/source-map": { "version": "0.5.7", @@ -20948,7 +20795,7 @@ "version": "0.5.19", "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.19.tgz", "integrity": "sha512-Wonm7zOCIJzBGQdB+thsPar0kYuCIzYvxZwlBa87yi/Mdjv7Tip2cyVbLj5o0cFPN4EVkuTwb3GDDyUx2DGnGw==", - "dev": true, + "devOptional": true, "dependencies": { "buffer-from": "^1.0.0", "source-map": "^0.6.0" @@ -20958,7 +20805,7 @@ "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true, + "devOptional": true, "engines": { "node": ">=0.10.0" } @@ -21078,15 +20925,6 @@ "tweetnacl": "~0.14.0" } }, - "node_modules/sshpk/node_modules/assert-plus": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", - "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", - "dev": true, - "engines": { - "node": ">=0.8" - } - }, "node_modules/stacktrace-parser": { "version": "0.1.10", "resolved": "https://registry.npmjs.org/stacktrace-parser/-/stacktrace-parser-0.1.10.tgz", @@ -21632,21 +21470,6 @@ "uri-js": "^4.2.2" } }, - "node_modules/style-loader/node_modules/json5": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/json5/-/json5-2.1.3.tgz", - "integrity": "sha512-KXPvOm8K9IJKFM0bmdn8QXh7udDh1g/giieX0NLCaMnb4hEiVFqnop2ImTXCc5e0/oHz3LTqmHGtExn5hfMkOA==", - "dev": true, - "dependencies": { - "minimist": "^1.2.5" - }, - "bin": { - "json5": "lib/cli.js" - }, - "engines": { - "node": ">=6" - } - }, "node_modules/style-loader/node_modules/loader-utils": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/loader-utils/-/loader-utils-2.0.0.tgz", @@ -21661,12 +21484,6 @@ "node": ">=8.9.0" } }, - "node_modules/style-loader/node_modules/minimist": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", - "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", - "dev": true - }, "node_modules/style-loader/node_modules/schema-utils": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.0.0.tgz", @@ -21952,18 +21769,6 @@ "node": ">=10.0.0" } }, - "node_modules/table/node_modules/ajv": { - "version": "8.4.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.4.0.tgz", - "integrity": "sha512-7QD2l6+KBSLwf+7MuYocbWvRPdOu63/trReTLu2KFwkgctnub1auoF+Y1WYcm09CTM7quuscrzqmASaLHC/K4Q==", - "dev": true, - "dependencies": { - "fast-deep-equal": "^3.1.1", - "json-schema-traverse": "^1.0.0", - "require-from-string": "^2.0.2", - "uri-js": "^4.2.2" - } - }, "node_modules/table/node_modules/ansi-regex": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", @@ -21973,12 +21778,6 @@ "node": ">=8" } }, - "node_modules/table/node_modules/json-schema-traverse": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", - "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", - "dev": true - }, "node_modules/table/node_modules/strip-ansi": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", @@ -21995,7 +21794,7 @@ "version": "2.2.0", "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.2.0.tgz", "integrity": "sha512-FBk4IesMV1rBxX2tfiK8RAmogtWn53puLOQlvO8XuwlgxcYbP4mVPS9Ph4aeamSyyVjOl24aYWAuc8U5kCVwMw==", - "dev": true, + "devOptional": true, "engines": { "node": ">=6" } @@ -22062,7 +21861,7 @@ "version": "5.6.1", "resolved": "https://registry.npmjs.org/terser/-/terser-5.6.1.tgz", "integrity": "sha512-yv9YLFQQ+3ZqgWCUk+pvNJwgUTdlIxUk1WTN+RnaFJe2L7ipG2csPT0ra2XRm7Cs8cxN7QXmK1rFzEwYEQkzXw==", - "dev": true, + "devOptional": true, "dependencies": { "commander": "^2.20.0", "source-map": "~0.7.2", @@ -22079,7 +21878,7 @@ "version": "5.1.1", "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.1.1.tgz", "integrity": "sha512-5XNNXZiR8YO6X6KhSGXfY0QrGrCRlSwAEjIIrlRQR4W8nP69TaJUlh3bkuac6zzgspiGPfKEHcY295MMVExl5Q==", - "dev": true, + "devOptional": true, "dependencies": { "jest-worker": "^26.6.2", "p-limit": "^3.1.0", @@ -22096,7 +21895,7 @@ "version": "6.12.6", "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", - "dev": true, + "devOptional": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -22108,7 +21907,7 @@ "version": "3.1.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", - "dev": true, + "devOptional": true, "dependencies": { "yocto-queue": "^0.1.0" }, @@ -22120,7 +21919,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.0.0.tgz", "integrity": "sha512-6D82/xSzO094ajanoOSbe4YvXWMfn2A//8Y1+MUqFAJul5Bs+yn36xbK9OtNDcRVSBJ9jjeoXftM6CfztsjOAA==", - "dev": true, + "devOptional": true, "dependencies": { "@types/json-schema": "^7.0.6", "ajv": "^6.12.5", @@ -22134,7 +21933,7 @@ "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true, + "devOptional": true, "engines": { "node": ">=0.10.0" } @@ -22143,13 +21942,13 @@ "version": "2.20.3", "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", - "dev": true + "devOptional": true }, "node_modules/terser/node_modules/source-map": { "version": "0.7.3", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.3.tgz", "integrity": "sha512-CkCj6giN3S+n9qrYiBTX5gystlENnRW5jZeNLHpe6aue+SrHcG5VYwujhW9s4dY31mEGsxBDrHR6oI69fTXsaQ==", - "dev": true, + "devOptional": true, "engines": { "node": ">= 8" } @@ -22206,33 +22005,6 @@ "xtend": "~4.0.1" } }, - "node_modules/through2/node_modules/isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=" - }, - "node_modules/through2/node_modules/readable-stream": { - "version": "2.3.6", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.6.tgz", - "integrity": "sha1-sRwn2IuP8fvgcGQ8+UsMea4bCq8=", - "dependencies": { - "core-util-is": "~1.0.0", - "inherits": "~2.0.3", - "isarray": "~1.0.0", - "process-nextick-args": "~2.0.0", - "safe-buffer": "~5.1.1", - "string_decoder": "~1.1.1", - "util-deprecate": "~1.0.1" - } - }, - "node_modules/through2/node_modules/string_decoder": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", - "integrity": "sha1-nPFhG6YmhdcDCunkujQUnDrwP8g=", - "dependencies": { - "safe-buffer": "~5.1.0" - } - }, "node_modules/timers-browserify": { "version": "2.0.12", "resolved": "https://registry.npmjs.org/timers-browserify/-/timers-browserify-2.0.12.tgz", @@ -22792,12 +22564,20 @@ "integrity": "sha512-ojlBqfsBftYXExNu3+hHLfJQ/X1jYY/9vdm4yZWjIbf0VuWF6CRufci1ZyoD/wV2TYMKxXUoNuoqwy+CkgzAiQ==", "dependencies": { "unist-util-is": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" } }, "node_modules/unist-util-find-after/node_modules/unist-util-is": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-4.1.0.tgz", - "integrity": "sha512-ZOQSsnce92GrxSqlnEEseX0gi7GH9zTJZ0p9dtu87WRb/37mMPO2Ilx1s/t9vBHrFhbgweUwb+t7cIn5dxPhZg==" + "integrity": "sha512-ZOQSsnce92GrxSqlnEEseX0gi7GH9zTJZ0p9dtu87WRb/37mMPO2Ilx1s/t9vBHrFhbgweUwb+t7cIn5dxPhZg==", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } }, "node_modules/unist-util-generated": { "version": "1.1.5", @@ -22894,6 +22674,7 @@ "version": "2.0.4", "resolved": "https://registry.npmjs.org/unix-dgram/-/unix-dgram-2.0.4.tgz", "integrity": "sha512-7tpK6x7ls7J7pDrrAU63h93R0dVhRbPwiRRCawR10cl+2e1VOvF3bHlVJc6WI1dl/8qk5He673QU+Ogv7bPNaw==", + "hasInstallScript": true, "optional": true, "dependencies": { "bindings": "^1.3.0", @@ -23280,15 +23061,6 @@ "extsprintf": "^1.2.0" } }, - "node_modules/verror/node_modules/assert-plus": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", - "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", - "dev": true, - "engines": { - "node": ">=0.8" - } - }, "node_modules/vfile": { "version": "4.2.0", "resolved": "https://registry.npmjs.org/vfile/-/vfile-4.2.0.tgz", @@ -23487,7 +23259,7 @@ "version": "5.37.1", "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.37.1.tgz", "integrity": "sha512-btZjGy/hSjCAAVHw+cKG+L0M+rstlyxbO2C+BOTaQ5/XAnxkDrP5sVbqWhXgo4pL3X2dcOib6rqCP20Zr9PLow==", - "dev": true, + "devOptional": true, "dependencies": { "@types/eslint-scope": "^3.7.0", "@types/estree": "^0.0.47", @@ -23741,7 +23513,7 @@ "version": "8.2.4", "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.2.4.tgz", "integrity": "sha512-Ibt84YwBDDA890eDiDCEqcbwvHlBvzzDkU2cGBBDDI1QWT12jTiXIOn2CIw5KK4i6N5Z2HUxwYjzriDyqaqqZg==", - "dev": true, + "devOptional": true, "bin": { "acorn": "bin/acorn" }, @@ -23753,7 +23525,7 @@ "version": "6.12.6", "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", - "dev": true, + "devOptional": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -23765,7 +23537,7 @@ "version": "3.3.0", "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz", "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==", - "dev": true, + "devOptional": true, "engines": { "node": ">=0.8.x" } @@ -23774,7 +23546,7 @@ "version": "1.47.0", "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.47.0.tgz", "integrity": "sha512-QBmA/G2y+IfeS4oktet3qRZ+P5kPhCKRXxXnQEudYqUaEioAU1/Lq2us3D/t1Jfo4hE9REQPrbB7K5sOczJVIw==", - "dev": true, + "devOptional": true, "engines": { "node": ">= 0.6" } @@ -23783,7 +23555,7 @@ "version": "2.1.30", "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.30.tgz", "integrity": "sha512-crmjA4bLtR8m9qLpHvgxSChT+XoSlZi8J4n/aIdn3z92e/U47Z0V/yl+Wh9W046GgFVAmoNR/fmdbZYcSSIUeg==", - "dev": true, + "devOptional": true, "dependencies": { "mime-db": "1.47.0" }, @@ -23795,7 +23567,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.0.0.tgz", "integrity": "sha512-6D82/xSzO094ajanoOSbe4YvXWMfn2A//8Y1+MUqFAJul5Bs+yn36xbK9OtNDcRVSBJ9jjeoXftM6CfztsjOAA==", - "dev": true, + "devOptional": true, "dependencies": { "@types/json-schema": "^7.0.6", "ajv": "^6.12.5", @@ -23809,7 +23581,7 @@ "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true, + "devOptional": true, "engines": { "node": ">=0.10.0" } @@ -23818,7 +23590,7 @@ "version": "2.2.0", "resolved": "https://registry.npmjs.org/webpack-sources/-/webpack-sources-2.2.0.tgz", "integrity": "sha512-bQsA24JLwcnWGArOKUxYKhX3Mz/nK1Xf6hxullKERyktjNMC4x8koOeaDNTA2fEJ09BdWLbM/iTW0ithREUP0w==", - "dev": true, + "devOptional": true, "dependencies": { "source-list-map": "^2.0.1", "source-map": "^0.6.1" @@ -26156,9 +25928,9 @@ } }, "@hapi/accept": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/@hapi/accept/-/accept-5.0.1.tgz", - "integrity": "sha512-fMr4d7zLzsAXo28PRRQPXR1o2Wmu+6z+VY1UzDp0iFo13Twj8WePakwXBiqn3E1aAlTpSNzCXdnnQXFhst8h8Q==", + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/@hapi/accept/-/accept-5.0.2.tgz", + "integrity": "sha512-CmzBx/bXUR8451fnZRuZAJRlzgm0Jgu5dltTX/bszmR2lheb9BpyN47Q1RbaGTsvFzn0PXAEs+lXDKfshccYZw==", "requires": { "@hapi/boom": "9.x.x", "@hapi/hoek": "9.x.x" @@ -27213,19 +26985,19 @@ } }, "@next/env": { - "version": "10.2.0", - "resolved": "https://registry.npmjs.org/@next/env/-/env-10.2.0.tgz", - "integrity": "sha512-tsWBsn1Rb6hXRaHc/pWMCpZ4Ipkf3OCbZ54ef5ukgIyEvzzGdGFXQshPP2AF7yb+8yMpunWs7vOMZW3e8oPF6A==" + "version": "10.2.3", + "resolved": "https://registry.npmjs.org/@next/env/-/env-10.2.3.tgz", + "integrity": "sha512-uBOjRBjsWC4C8X3DfmWWP6ekwLnf2JCCwQX9KVnJtJkqfDsv1yQPakdOEwvJzXQc3JC/v5KKffYPVmV2wHXCgQ==" }, "@next/polyfill-module": { - "version": "10.2.0", - "resolved": "https://registry.npmjs.org/@next/polyfill-module/-/polyfill-module-10.2.0.tgz", - "integrity": "sha512-Nl3GexIUXsmuggkUqrRFyE/2k7UI44JaVzSywtXEyHzxpZm2a5bdMaWuC89pgLiFDDOqmbqyLAbtwm5lNxa7Eg==" + "version": "10.2.3", + "resolved": "https://registry.npmjs.org/@next/polyfill-module/-/polyfill-module-10.2.3.tgz", + "integrity": "sha512-OkeY4cLhzfYbXxM4fd+6V4s5pTPuyfKSlavItfNRA6PpS7t1/R6YjO7S7rB8tu1pbTGuDHGIdE1ioDv15bAbDQ==" }, "@next/react-dev-overlay": { - "version": "10.2.0", - "resolved": "https://registry.npmjs.org/@next/react-dev-overlay/-/react-dev-overlay-10.2.0.tgz", - "integrity": "sha512-PRIAoWog41hLN4iJ8dChKp4ysOX0Q8yiNQ/cwzyqEd3EjugkDV5OiKl3mumGKaApJaIra1MX6j1wgQRuLhuWMA==", + "version": "10.2.3", + "resolved": "https://registry.npmjs.org/@next/react-dev-overlay/-/react-dev-overlay-10.2.3.tgz", + "integrity": "sha512-E6g2jws4YW94l0lMMopBVKIZK2mEHfSBvM0d9dmzKG9L/A/kEq6LZCB4SiwGJbNsAdlk2y3USDa0oNbpA+m5Kw==", "requires": { "@babel/code-frame": "7.12.11", "anser": "1.4.9", @@ -27245,6 +27017,14 @@ "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==" }, + "ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "requires": { + "color-convert": "^2.0.1" + } + }, "chalk": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.0.0.tgz", @@ -27252,37 +27032,6 @@ "requires": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" - }, - "dependencies": { - "ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "requires": { - "color-convert": "^2.0.1" - } - }, - "color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "requires": { - "color-name": "~1.1.4" - } - }, - "has-flag": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==" - }, - "supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "requires": { - "has-flag": "^4.0.0" - } - } } }, "classnames": { @@ -27290,11 +27039,24 @@ "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.2.6.tgz", "integrity": "sha512-JR/iSQOSt+LQIWwrwEzJ9uk0xfN3mTVYMwt1Ir5mUcSN6pU+V4zQFFaJsclJbPuAUQH+yfWef6tm7l1quW3C8Q==" }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "requires": { + "color-name": "~1.1.4" + } + }, "color-name": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==" + }, "source-map": { "version": "0.8.0-beta.0", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.8.0-beta.0.tgz", @@ -27311,6 +27073,14 @@ "ansi-regex": "^5.0.0" } }, + "supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "requires": { + "has-flag": "^4.0.0" + } + }, "tr46": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/tr46/-/tr46-1.0.1.tgz", @@ -27337,9 +27107,10 @@ } }, "@next/react-refresh-utils": { - "version": "10.2.0", - "resolved": "https://registry.npmjs.org/@next/react-refresh-utils/-/react-refresh-utils-10.2.0.tgz", - "integrity": "sha512-3I31K9B4hEQRl7yQ44Umyz+szHtuMJrNdwsgJGhoEnUCXSBRHp5wv5Zv8eDa2NewSbe53b2C0oOpivrzmdBakw==" + "version": "10.2.3", + "resolved": "https://registry.npmjs.org/@next/react-refresh-utils/-/react-refresh-utils-10.2.3.tgz", + "integrity": "sha512-qtBF56vPC6d6a8p7LYd0iRjW89fhY80kAIzmj+VonvIGjK/nymBjcFUhbKiMFqlhsarCksnhwX+Zmn95Dw9qvA==", + "requires": {} }, "@nodelib/fs.scandir": { "version": "2.1.4", @@ -27855,7 +27626,7 @@ "version": "7.2.8", "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-7.2.8.tgz", "integrity": "sha512-RTKvBsfz0T8CKOGZMfuluDNyMFHnu5lvNr4hWEsQeHXH6FcmIDIozOyWMh36nLGMwVd5UFNXC2xztA8lln22MQ==", - "dev": true, + "devOptional": true, "requires": { "@types/estree": "*", "@types/json-schema": "*" @@ -27865,7 +27636,7 @@ "version": "3.7.0", "resolved": "https://registry.npmjs.org/@types/eslint-scope/-/eslint-scope-3.7.0.tgz", "integrity": "sha512-O/ql2+rrCUe2W2rs7wMR+GqPRcgB6UiqN5RhrR5xruFlY7l9YLMn0ZkDzjoHLeiFkR8MCQZVudUuuvQ2BLC9Qw==", - "dev": true, + "devOptional": true, "requires": { "@types/eslint": "*", "@types/estree": "*" @@ -27875,7 +27646,7 @@ "version": "0.0.47", "resolved": "https://registry.npmjs.org/@types/estree/-/estree-0.0.47.tgz", "integrity": "sha512-c5ciR06jK8u9BstrmJyO97m+klJrrhCf9u3rLu3DEAJBirxRqSCvDQoYKmxuYwQI5SZChAWu+tq9oVlGRuzPAg==", - "dev": true + "devOptional": true }, "@types/graceful-fs": { "version": "4.1.5", @@ -27941,7 +27712,7 @@ "version": "7.0.7", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.7.tgz", "integrity": "sha512-cxWFQVseBm6O9Gbw1IWb8r6OS4OhSt3hPZLkFApLjM8TEXROBuQGLAH2i2gZpcXdLBIrpXuTDhH7Vbm1iXmNGA==", - "dev": true + "devOptional": true }, "@types/json5": { "version": "0.0.29", @@ -28106,7 +27877,7 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.11.0.tgz", "integrity": "sha512-kX2W49LWsbthrmIRMbQZuQDhGtjyqXfEmmHyEi4XWnSZtPmxY0+3anPIzsnRb45VH/J55zlOfWvZuY47aJZTJg==", - "dev": true, + "devOptional": true, "requires": { "@webassemblyjs/helper-numbers": "1.11.0", "@webassemblyjs/helper-wasm-bytecode": "1.11.0" @@ -28116,25 +27887,25 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.11.0.tgz", "integrity": "sha512-Q/aVYs/VnPDVYvsCBL/gSgwmfjeCb4LW8+TMrO3cSzJImgv8lxxEPM2JA5jMrivE7LSz3V+PFqtMbls3m1exDA==", - "dev": true + "devOptional": true }, "@webassemblyjs/helper-api-error": { "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-api-error/-/helper-api-error-1.11.0.tgz", "integrity": "sha512-baT/va95eXiXb2QflSx95QGT5ClzWpGaa8L7JnJbgzoYeaA27FCvuBXU758l+KXWRndEmUXjP0Q5fibhavIn8w==", - "dev": true + "devOptional": true }, "@webassemblyjs/helper-buffer": { "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-buffer/-/helper-buffer-1.11.0.tgz", "integrity": "sha512-u9HPBEl4DS+vA8qLQdEQ6N/eJQ7gT7aNvMIo8AAWvAl/xMrcOSiI2M0MAnMCy3jIFke7bEee/JwdX1nUpCtdyA==", - "dev": true + "devOptional": true }, "@webassemblyjs/helper-numbers": { "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-numbers/-/helper-numbers-1.11.0.tgz", "integrity": "sha512-DhRQKelIj01s5IgdsOJMKLppI+4zpmcMQ3XboFPLwCpSNH6Hqo1ritgHgD0nqHeSYqofA6aBN/NmXuGjM1jEfQ==", - "dev": true, + "devOptional": true, "requires": { "@webassemblyjs/floating-point-hex-parser": "1.11.0", "@webassemblyjs/helper-api-error": "1.11.0", @@ -28145,13 +27916,13 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.11.0.tgz", "integrity": "sha512-MbmhvxXExm542tWREgSFnOVo07fDpsBJg3sIl6fSp9xuu75eGz5lz31q7wTLffwL3Za7XNRCMZy210+tnsUSEA==", - "dev": true + "devOptional": true }, "@webassemblyjs/helper-wasm-section": { "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.11.0.tgz", "integrity": "sha512-3Eb88hcbfY/FCukrg6i3EH8H2UsD7x8Vy47iVJrP967A9JGqgBVL9aH71SETPx1JrGsOUVLo0c7vMCN22ytJew==", - "dev": true, + "devOptional": true, "requires": { "@webassemblyjs/ast": "1.11.0", "@webassemblyjs/helper-buffer": "1.11.0", @@ -28163,7 +27934,7 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/ieee754/-/ieee754-1.11.0.tgz", "integrity": "sha512-KXzOqpcYQwAfeQ6WbF6HXo+0udBNmw0iXDmEK5sFlmQdmND+tr773Ti8/5T/M6Tl/413ArSJErATd8In3B+WBA==", - "dev": true, + "devOptional": true, "requires": { "@xtuc/ieee754": "^1.2.0" } @@ -28172,7 +27943,7 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/leb128/-/leb128-1.11.0.tgz", "integrity": "sha512-aqbsHa1mSQAbeeNcl38un6qVY++hh8OpCOzxhixSYgbRfNWcxJNJQwe2rezK9XEcssJbbWIkblaJRwGMS9zp+g==", - "dev": true, + "devOptional": true, "requires": { "@xtuc/long": "4.2.2" } @@ -28181,13 +27952,13 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/utf8/-/utf8-1.11.0.tgz", "integrity": "sha512-A/lclGxH6SpSLSyFowMzO/+aDEPU4hvEiooCMXQPcQFPPJaYcPQNKGOCLUySJsYJ4trbpr+Fs08n4jelkVTGVw==", - "dev": true + "devOptional": true }, "@webassemblyjs/wasm-edit": { "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-edit/-/wasm-edit-1.11.0.tgz", "integrity": "sha512-JHQ0damXy0G6J9ucyKVXO2j08JVJ2ntkdJlq1UTiUrIgfGMmA7Ik5VdC/L8hBK46kVJgujkBIoMtT8yVr+yVOQ==", - "dev": true, + "devOptional": true, "requires": { "@webassemblyjs/ast": "1.11.0", "@webassemblyjs/helper-buffer": "1.11.0", @@ -28203,7 +27974,7 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-gen/-/wasm-gen-1.11.0.tgz", "integrity": "sha512-BEUv1aj0WptCZ9kIS30th5ILASUnAPEvE3tVMTrItnZRT9tXCLW2LEXT8ezLw59rqPP9klh9LPmpU+WmRQmCPQ==", - "dev": true, + "devOptional": true, "requires": { "@webassemblyjs/ast": "1.11.0", "@webassemblyjs/helper-wasm-bytecode": "1.11.0", @@ -28216,7 +27987,7 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-opt/-/wasm-opt-1.11.0.tgz", "integrity": "sha512-tHUSP5F4ywyh3hZ0+fDQuWxKx3mJiPeFufg+9gwTpYp324mPCQgnuVKwzLTZVqj0duRDovnPaZqDwoyhIO8kYg==", - "dev": true, + "devOptional": true, "requires": { "@webassemblyjs/ast": "1.11.0", "@webassemblyjs/helper-buffer": "1.11.0", @@ -28228,7 +27999,7 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-parser/-/wasm-parser-1.11.0.tgz", "integrity": "sha512-6L285Sgu9gphrcpDXINvm0M9BskznnzJTE7gYkjDbxET28shDqp27wpruyx3C2S/dvEwiigBwLA1cz7lNUi0kw==", - "dev": true, + "devOptional": true, "requires": { "@webassemblyjs/ast": "1.11.0", "@webassemblyjs/helper-api-error": "1.11.0", @@ -28242,7 +28013,7 @@ "version": "1.11.0", "resolved": "https://registry.npmjs.org/@webassemblyjs/wast-printer/-/wast-printer-1.11.0.tgz", "integrity": "sha512-Fg5OX46pRdTgB7rKIUojkh9vXaVN6sGYCnEiJN1GYkb0RPwShZXp6KTDqmoMdQPKhcroOXh3fEzmkWmCYaKYhQ==", - "dev": true, + "devOptional": true, "requires": { "@webassemblyjs/ast": "1.11.0", "@xtuc/long": "4.2.2" @@ -28273,13 +28044,13 @@ "version": "1.2.0", "resolved": "https://registry.npmjs.org/@xtuc/ieee754/-/ieee754-1.2.0.tgz", "integrity": "sha512-DX8nKgqcGwsc0eJSqYt5lwP4DH5FlHnmuWWBRy7X0NcaGR0ZtuyeESgMwTYVEtxmsNGY+qit4QYT/MIYTOTPeA==", - "dev": true + "devOptional": true }, "@xtuc/long": { "version": "4.2.2", "resolved": "https://registry.npmjs.org/@xtuc/long/-/long-4.2.2.tgz", "integrity": "sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ==", - "dev": true + "devOptional": true }, "abab": { "version": "2.0.5", @@ -28429,7 +28200,7 @@ "version": "3.5.2", "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", - "dev": true + "devOptional": true }, "algoliasearch": { "version": "4.9.1", @@ -30026,7 +29797,6 @@ "version": "4.16.6", "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.16.6.tgz", "integrity": "sha512-Wspk/PqO+4W9qp5iUTJsa1B/QrYn1keNCcEP5OvP7WBwT4KaDly0uONYmC6Xa3Z5IqnUgS0KcgLYu1l74x0ZXQ==", - "dev": true, "requires": { "caniuse-lite": "^1.0.30001219", "colorette": "^1.2.2", @@ -30470,7 +30240,7 @@ "version": "3.4.1", "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.4.1.tgz", "integrity": "sha512-TQTJyr2stihpC4Sya9hs2Xh+O2wf+igjL36Y75xx2WdHuiICcn/XJza46Jwt0eT5hVpQOzo3FpY3cj3RVYLX0g==", - "dev": true, + "devOptional": true, "requires": { "anymatch": "~3.1.1", "braces": "~3.0.2", @@ -30482,17 +30252,11 @@ "readdirp": "~3.4.0" }, "dependencies": { - "binary-extensions": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.1.0.tgz", - "integrity": "sha512-1Yj8h9Q+QDF5FzhMs/c9+6UntbD5MkRfRwac8DoEm9ZfUBZ7tZ55YcGVAzEe4bXsdQHEk+s9S5wsOKVdZrw0tQ==", - "dev": true - }, "braces": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", - "dev": true, + "devOptional": true, "requires": { "fill-range": "^7.0.1" } @@ -30501,7 +30265,7 @@ "version": "7.0.1", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", - "dev": true, + "devOptional": true, "requires": { "to-regex-range": "^5.0.1" } @@ -30513,44 +30277,17 @@ "dev": true, "optional": true }, - "glob-parent": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.1.tgz", - "integrity": "sha512-FnI+VGOpnlGHWZxthPGR+QhR78fuiK0sNLkHQv+bL9fQi57lNNdquIbna/WrfROrolq8GK5Ek6BiMwqL/voRYQ==", - "dev": true, - "requires": { - "is-glob": "^4.0.1" - } - }, - "is-binary-path": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", - "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", - "dev": true, - "requires": { - "binary-extensions": "^2.0.0" - } - }, - "is-glob": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.1.tgz", - "integrity": "sha512-5G0tKtBTFImOqDnLB2hG6Bp2qcKEFduo4tZu9MT/H6NQv/ghhy30o55ufafxJ/LdH79LLs2Kfrn85TLKyA7BUg==", - "dev": true, - "requires": { - "is-extglob": "^2.1.1" - } - }, "normalize-path": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", - "dev": true + "devOptional": true }, "readdirp": { "version": "3.4.0", "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.4.0.tgz", "integrity": "sha512-0xe001vZBnJEK+uKcj8qOhyAKPzIT+gStxWr3LCB0DwcXR5NZJ3IaC+yGnHCYzB/S7ov3m3EEbZI2zeNvX+hGQ==", - "dev": true, + "devOptional": true, "requires": { "picomatch": "^2.2.1" } @@ -30559,7 +30296,7 @@ "version": "5.0.1", "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", - "dev": true, + "devOptional": true, "requires": { "is-number": "^7.0.0" } @@ -30576,7 +30313,7 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/chrome-trace-event/-/chrome-trace-event-1.0.2.tgz", "integrity": "sha512-9e/zx1jw7B4CO+c/RXoCsfg/x1AfUBioy4owYH0bJprEYAx5hRFLRhWBqHAG57D0ZM4H7vxbP7bPe0VwhQRYDQ==", - "dev": true, + "devOptional": true, "requires": { "tslib": "^1.9.0" } @@ -30813,35 +30550,6 @@ "inherits": "^2.0.3", "readable-stream": "^2.2.2", "typedarray": "^0.0.6" - }, - "dependencies": { - "isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=" - }, - "readable-stream": { - "version": "2.3.6", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.6.tgz", - "integrity": "sha512-tQtKA9WIAhBF3+VLAseyMqZeBjW0AHJoxOtYqSUZNJxauErmLbVm2FW1y+J/YA9dUrAC39ITejlZWhVIwawkKw==", - "requires": { - "core-util-is": "~1.0.0", - "inherits": "~2.0.3", - "isarray": "~1.0.0", - "process-nextick-args": "~2.0.0", - "safe-buffer": "~5.1.1", - "string_decoder": "~1.1.1", - "util-deprecate": "~1.0.1" - } - }, - "string_decoder": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", - "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", - "requires": { - "safe-buffer": "~5.1.0" - } - } } }, "configstore": { @@ -31516,14 +31224,6 @@ "dev": true, "requires": { "assert-plus": "^1.0.0" - }, - "dependencies": { - "assert-plus": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", - "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", - "dev": true - } } }, "data-uri-to-buffer": { @@ -32094,7 +31794,7 @@ "version": "5.8.2", "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.8.2.tgz", "integrity": "sha512-F27oB3WuHDzvR2DOGNTaYy0D5o0cnrv8TeI482VM4kYgQd/FT9lUQwuNsJ0oOHtBUq7eiW5ytqzp7nBFknL+GA==", - "dev": true, + "devOptional": true, "requires": { "graceful-fs": "^4.2.4", "tapable": "^2.2.0" @@ -32176,7 +31876,7 @@ "version": "0.4.1", "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-0.4.1.tgz", "integrity": "sha512-ooYciCUtfw6/d2w56UVeqHPcoCFAiJdz5XOkYpv/Txl1HMUozpXjz/2RIQgqwKdXNDPSF1W7mJCFse3G+HDyAA==", - "dev": true + "devOptional": true }, "es-to-primitive": { "version": "1.2.1", @@ -32299,39 +31999,6 @@ "v8-compile-cache": "^2.0.3" }, "dependencies": { - "@babel/code-frame": { - "version": "7.12.11", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.12.11.tgz", - "integrity": "sha512-Zt1yodBx1UcyiePMSkWnU4hPqhwq7hGi2nFL1LeA3EUl+q2LQx16MISgJ0+z7dnmgvP9QtIleuETGOiOH1RcIw==", - "dev": true, - "requires": { - "@babel/highlight": "^7.10.4" - } - }, - "@babel/highlight": { - "version": "7.14.0", - "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.14.0.tgz", - "integrity": "sha512-YSCOwxvTYEIMSGaBQb5kDDsCopDdiUGsqpatp3fOlI4+2HQSkTmEVWnVuySdAC5EWCqSWWTv0ib63RjR7dTBdg==", - "dev": true, - "requires": { - "@babel/helper-validator-identifier": "^7.14.0", - "chalk": "^2.0.0", - "js-tokens": "^4.0.0" - }, - "dependencies": { - "chalk": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", - "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", - "dev": true, - "requires": { - "ansi-styles": "^3.2.1", - "escape-string-regexp": "^1.0.5", - "supports-color": "^5.3.0" - } - } - } - }, "ajv": { "version": "6.12.6", "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", @@ -32350,15 +32017,6 @@ "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", "dev": true }, - "ansi-styles": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", - "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", - "dev": true, - "requires": { - "color-convert": "^1.9.0" - } - }, "argparse": { "version": "1.0.10", "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", @@ -32383,15 +32041,6 @@ "integrity": "sha512-QudtT6av5WXels9WjIM7qz1XD1cWGvX4gGXvp/zBn9nXG02D0utdU3Em2m/QjTnrsk6bBjmCygl3rmj118msQQ==", "dev": true }, - "glob-parent": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.1.tgz", - "integrity": "sha512-FnI+VGOpnlGHWZxthPGR+QhR78fuiK0sNLkHQv+bL9fQi57lNNdquIbna/WrfROrolq8GK5Ek6BiMwqL/voRYQ==", - "dev": true, - "requires": { - "is-glob": "^4.0.1" - } - }, "globals": { "version": "13.8.0", "resolved": "https://registry.npmjs.org/globals/-/globals-13.8.0.tgz", @@ -32401,15 +32050,6 @@ "type-fest": "^0.20.2" } }, - "is-glob": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.1.tgz", - "integrity": "sha512-5G0tKtBTFImOqDnLB2hG6Bp2qcKEFduo4tZu9MT/H6NQv/ghhy30o55ufafxJ/LdH79LLs2Kfrn85TLKyA7BUg==", - "dev": true, - "requires": { - "is-extglob": "^2.1.1" - } - }, "js-yaml": { "version": "3.14.1", "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", @@ -32471,15 +32111,6 @@ "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", "dev": true }, - "supports-color": { - "version": "5.5.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", - "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", - "dev": true, - "requires": { - "has-flag": "^3.0.0" - } - }, "type-check": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", @@ -32686,7 +32317,7 @@ "version": "5.1.1", "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", - "dev": true, + "devOptional": true, "requires": { "esrecurse": "^4.3.0", "estraverse": "^4.1.1" @@ -32696,7 +32327,7 @@ "version": "4.3.0", "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", - "dev": true, + "devOptional": true, "requires": { "estraverse": "^5.2.0" }, @@ -32705,7 +32336,7 @@ "version": "5.2.0", "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", - "dev": true + "devOptional": true } } } @@ -33344,7 +32975,7 @@ "version": "2.1.0", "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", - "dev": true + "devOptional": true }, "fast-levenshtein": { "version": "2.0.6", @@ -33811,14 +33442,6 @@ "dev": true, "requires": { "assert-plus": "^1.0.0" - }, - "dependencies": { - "assert-plus": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", - "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", - "dev": true - } } }, "gifwrap": { @@ -34417,9 +34040,9 @@ } }, "highlight.js": { - "version": "10.3.1", - "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-10.3.1.tgz", - "integrity": "sha512-jeW8rdPdhshYKObedYg5XGbpVgb1/DT4AHvDFXhkU7UnGSIjy9kkJ7zHG7qplhFHMitTSzh5/iClKQk3Kb2RFQ==" + "version": "10.7.2", + "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-10.7.2.tgz", + "integrity": "sha512-oFLl873u4usRM9K63j4ME9u3etNF0PLiJhSQ8rdfuL51Wn3zkD6drf9ZW0dOzjnZI22YYG24z30JcmfCZjMgYg==" }, "highlightjs-graphql": { "version": "1.0.2", @@ -36874,7 +36497,7 @@ "version": "26.6.2", "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-26.6.2.tgz", "integrity": "sha512-KWYVV1c4i+jbMpaBC+U++4Va0cp8OisU185o73T1vo99hqi7w8tSJfUXYswwqqrjzwxa6KpRK54WhPvwf5w6PQ==", - "dev": true, + "devOptional": true, "requires": { "@types/node": "*", "merge-stream": "^2.0.0", @@ -36885,13 +36508,13 @@ "version": "4.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true + "devOptional": true }, "supports-color": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dev": true, + "devOptional": true, "requires": { "has-flag": "^4.0.0" } @@ -37037,7 +36660,7 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==", - "dev": true + "devOptional": true }, "json-schema": { "version": "0.2.3", @@ -37049,7 +36672,7 @@ "version": "0.4.1", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "dev": true + "devOptional": true }, "json-stable-stringify-without-jsonify": { "version": "1.0.1", @@ -37097,14 +36720,6 @@ "extsprintf": "1.3.0", "json-schema": "0.2.3", "verror": "1.10.0" - }, - "dependencies": { - "assert-plus": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", - "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", - "dev": true - } } }, "jszip": { @@ -37490,7 +37105,7 @@ "version": "4.2.0", "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.2.0.tgz", "integrity": "sha512-92+huvxMvYlMzMt0iIOukcwYBFpkYJdpl2xsZ7LrlayO7E8SOv+JJUEK17B/dJIHAOLMfh2dZZ/Y18WgmGtYNw==", - "dev": true + "devOptional": true }, "loader-utils": { "version": "1.4.0", @@ -37667,12 +37282,12 @@ "integrity": "sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA==" }, "lowlight": { - "version": "1.16.0", - "resolved": "https://registry.npmjs.org/lowlight/-/lowlight-1.16.0.tgz", - "integrity": "sha512-ECLdzIJvBEjK4ef51sWiGZyz21yx4IEPaF/62DRxLehoOHkWqN3OsLB1GUMfc6Mcf87rR5eW7z6lI9cNEXZDsQ==", + "version": "1.20.0", + "resolved": "https://registry.npmjs.org/lowlight/-/lowlight-1.20.0.tgz", + "integrity": "sha512-8Ktj+prEb1RoCPkEOrPMYUN/nCggB7qAWe3a7OpMjWQkh3l2RD5wKRQ+o8Q8YuI9RG/xs95waaI/E6ym/7NsTw==", "requires": { "fault": "^1.0.0", - "highlight.js": "~10.3.0" + "highlight.js": "~10.7.0" } }, "lru-cache": { @@ -38483,26 +38098,26 @@ "version": "2.6.2", "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", - "dev": true + "devOptional": true }, "next": { - "version": "10.2.0", - "resolved": "https://registry.npmjs.org/next/-/next-10.2.0.tgz", - "integrity": "sha512-PKDKCSF7s82xudu3kQhOEaokxggpbLEWouEUtzP6OqV0YqKYHF+Ff+BFLycEem8ixtTM2M6ElN0VRJcskJfxPQ==", + "version": "10.2.3", + "resolved": "https://registry.npmjs.org/next/-/next-10.2.3.tgz", + "integrity": "sha512-dkM1mIfnORtGyzw/Yme8RdqNxlCMZyi4Lqj56F01/yHbe1ZtOaJ0cyqqRB4RGiPhjGGh0319f8ddjDyO1605Ow==", "requires": { "@babel/runtime": "7.12.5", - "@hapi/accept": "5.0.1", - "@next/env": "10.2.0", - "@next/polyfill-module": "10.2.0", - "@next/react-dev-overlay": "10.2.0", - "@next/react-refresh-utils": "10.2.0", + "@hapi/accept": "5.0.2", + "@next/env": "10.2.3", + "@next/polyfill-module": "10.2.3", + "@next/react-dev-overlay": "10.2.3", + "@next/react-refresh-utils": "10.2.3", "@opentelemetry/api": "0.14.0", "assert": "2.0.0", "ast-types": "0.13.2", "browserify-zlib": "0.2.0", - "browserslist": "4.16.1", + "browserslist": "4.16.6", "buffer": "5.6.0", - "caniuse-lite": "^1.0.30001179", + "caniuse-lite": "^1.0.30001228", "chalk": "2.4.2", "chokidar": "3.5.1", "constants-browserify": "1.0.0", @@ -38566,18 +38181,6 @@ "fill-range": "^7.0.1" } }, - "browserslist": { - "version": "4.16.1", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.16.1.tgz", - "integrity": "sha512-UXhDrwqsNcpTYJBTZsbGATDxZbiVDsx6UjpmRUmtnP10pr8wAYr5LgFoEFw9ixriQH2mv/NX2SfGzE/o8GndLA==", - "requires": { - "caniuse-lite": "^1.0.30001173", - "colorette": "^1.2.1", - "electron-to-chromium": "^1.3.634", - "escalade": "^3.1.1", - "node-releases": "^1.1.69" - } - }, "bytes": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.0.tgz", @@ -40991,8 +40594,7 @@ "react-is": { "version": "17.0.2", "resolved": "https://registry.npmjs.org/react-is/-/react-is-17.0.2.tgz", - "integrity": "sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==", - "devOptional": true + "integrity": "sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==" }, "react-refresh": { "version": "0.8.3", @@ -41496,12 +41098,6 @@ "uuid": "^3.3.2" }, "dependencies": { - "extend": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", - "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", - "dev": true - }, "qs": { "version": "6.5.2", "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.2.tgz", @@ -41866,7 +41462,7 @@ "version": "1.32.13", "resolved": "https://registry.npmjs.org/sass/-/sass-1.32.13.tgz", "integrity": "sha512-dEgI9nShraqP7cXQH+lEXVf73WOPCse0QlFzSD8k+1TcOxCMwVXfQlr0jtoluZysQOyJGnfr21dLvYKDJq8HkA==", - "dev": true, + "devOptional": true, "requires": { "chokidar": ">=3.0.0 <4.0.0" } @@ -42034,7 +41630,7 @@ "version": "5.0.1", "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-5.0.1.tgz", "integrity": "sha512-SaaNal9imEO737H2c05Og0/8LUXG7EnsZyMa8MzkmuHoELfT6txuj0cMqRj6zfPKnmQ1yasR4PCJc8x+M4JSPA==", - "dev": true, + "devOptional": true, "requires": { "randombytes": "^2.1.0" } @@ -42376,7 +41972,7 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/source-list-map/-/source-list-map-2.0.1.tgz", "integrity": "sha512-qnQ7gVMxGNxsiL4lEuJwe/To8UnK7fAnmbGEEH8RpLouuKbeEm0lhbQVFIrNSuB+G7tVrAlVsZgETT5nljf+Iw==", - "dev": true + "devOptional": true }, "source-map": { "version": "0.5.7", @@ -42400,7 +41996,7 @@ "version": "0.5.19", "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.19.tgz", "integrity": "sha512-Wonm7zOCIJzBGQdB+thsPar0kYuCIzYvxZwlBa87yi/Mdjv7Tip2cyVbLj5o0cFPN4EVkuTwb3GDDyUx2DGnGw==", - "dev": true, + "devOptional": true, "requires": { "buffer-from": "^1.0.0", "source-map": "^0.6.0" @@ -42410,7 +42006,7 @@ "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true + "devOptional": true } } }, @@ -42513,14 +42109,6 @@ "jsbn": "~0.1.0", "safer-buffer": "^2.0.2", "tweetnacl": "~0.14.0" - }, - "dependencies": { - "assert-plus": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", - "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", - "dev": true - } } }, "stacktrace-parser": { @@ -42973,15 +42561,6 @@ "uri-js": "^4.2.2" } }, - "json5": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/json5/-/json5-2.1.3.tgz", - "integrity": "sha512-KXPvOm8K9IJKFM0bmdn8QXh7udDh1g/giieX0NLCaMnb4hEiVFqnop2ImTXCc5e0/oHz3LTqmHGtExn5hfMkOA==", - "dev": true, - "requires": { - "minimist": "^1.2.5" - } - }, "loader-utils": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/loader-utils/-/loader-utils-2.0.0.tgz", @@ -42993,12 +42572,6 @@ "json5": "^2.1.2" } }, - "minimist": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", - "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", - "dev": true - }, "schema-utils": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.0.0.tgz", @@ -43243,30 +42816,12 @@ "strip-ansi": "^6.0.0" }, "dependencies": { - "ajv": { - "version": "8.4.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.4.0.tgz", - "integrity": "sha512-7QD2l6+KBSLwf+7MuYocbWvRPdOu63/trReTLu2KFwkgctnub1auoF+Y1WYcm09CTM7quuscrzqmASaLHC/K4Q==", - "dev": true, - "requires": { - "fast-deep-equal": "^3.1.1", - "json-schema-traverse": "^1.0.0", - "require-from-string": "^2.0.2", - "uri-js": "^4.2.2" - } - }, "ansi-regex": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", "dev": true }, - "json-schema-traverse": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", - "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", - "dev": true - }, "strip-ansi": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", @@ -43282,7 +42837,7 @@ "version": "2.2.0", "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.2.0.tgz", "integrity": "sha512-FBk4IesMV1rBxX2tfiK8RAmogtWn53puLOQlvO8XuwlgxcYbP4mVPS9Ph4aeamSyyVjOl24aYWAuc8U5kCVwMw==", - "dev": true + "devOptional": true }, "tar-fs": { "version": "2.1.1", @@ -43342,7 +42897,7 @@ "version": "5.6.1", "resolved": "https://registry.npmjs.org/terser/-/terser-5.6.1.tgz", "integrity": "sha512-yv9YLFQQ+3ZqgWCUk+pvNJwgUTdlIxUk1WTN+RnaFJe2L7ipG2csPT0ra2XRm7Cs8cxN7QXmK1rFzEwYEQkzXw==", - "dev": true, + "devOptional": true, "requires": { "commander": "^2.20.0", "source-map": "~0.7.2", @@ -43353,13 +42908,13 @@ "version": "2.20.3", "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", - "dev": true + "devOptional": true }, "source-map": { "version": "0.7.3", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.3.tgz", "integrity": "sha512-CkCj6giN3S+n9qrYiBTX5gystlENnRW5jZeNLHpe6aue+SrHcG5VYwujhW9s4dY31mEGsxBDrHR6oI69fTXsaQ==", - "dev": true + "devOptional": true } } }, @@ -43367,7 +42922,7 @@ "version": "5.1.1", "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.1.1.tgz", "integrity": "sha512-5XNNXZiR8YO6X6KhSGXfY0QrGrCRlSwAEjIIrlRQR4W8nP69TaJUlh3bkuac6zzgspiGPfKEHcY295MMVExl5Q==", - "dev": true, + "devOptional": true, "requires": { "jest-worker": "^26.6.2", "p-limit": "^3.1.0", @@ -43381,7 +42936,7 @@ "version": "6.12.6", "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", - "dev": true, + "devOptional": true, "requires": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -43393,7 +42948,7 @@ "version": "3.1.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", - "dev": true, + "devOptional": true, "requires": { "yocto-queue": "^0.1.0" } @@ -43402,7 +42957,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.0.0.tgz", "integrity": "sha512-6D82/xSzO094ajanoOSbe4YvXWMfn2A//8Y1+MUqFAJul5Bs+yn36xbK9OtNDcRVSBJ9jjeoXftM6CfztsjOAA==", - "dev": true, + "devOptional": true, "requires": { "@types/json-schema": "^7.0.6", "ajv": "^6.12.5", @@ -43413,7 +42968,7 @@ "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true + "devOptional": true } } }, @@ -43461,35 +43016,6 @@ "requires": { "readable-stream": "^2.1.5", "xtend": "~4.0.1" - }, - "dependencies": { - "isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=" - }, - "readable-stream": { - "version": "2.3.6", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.6.tgz", - "integrity": "sha1-sRwn2IuP8fvgcGQ8+UsMea4bCq8=", - "requires": { - "core-util-is": "~1.0.0", - "inherits": "~2.0.3", - "isarray": "~1.0.0", - "process-nextick-args": "~2.0.0", - "safe-buffer": "~5.1.1", - "string_decoder": "~1.1.1", - "util-deprecate": "~1.0.1" - } - }, - "string_decoder": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", - "integrity": "sha1-nPFhG6YmhdcDCunkujQUnDrwP8g=", - "requires": { - "safe-buffer": "~5.1.0" - } - } } }, "timers-browserify": { @@ -44394,14 +43920,6 @@ "assert-plus": "^1.0.0", "core-util-is": "1.0.2", "extsprintf": "^1.2.0" - }, - "dependencies": { - "assert-plus": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", - "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", - "dev": true - } } }, "vfile": { @@ -44585,7 +44103,7 @@ "version": "5.37.1", "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.37.1.tgz", "integrity": "sha512-btZjGy/hSjCAAVHw+cKG+L0M+rstlyxbO2C+BOTaQ5/XAnxkDrP5sVbqWhXgo4pL3X2dcOib6rqCP20Zr9PLow==", - "dev": true, + "devOptional": true, "requires": { "@types/eslint-scope": "^3.7.0", "@types/estree": "^0.0.47", @@ -44616,13 +44134,13 @@ "version": "8.2.4", "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.2.4.tgz", "integrity": "sha512-Ibt84YwBDDA890eDiDCEqcbwvHlBvzzDkU2cGBBDDI1QWT12jTiXIOn2CIw5KK4i6N5Z2HUxwYjzriDyqaqqZg==", - "dev": true + "devOptional": true }, "ajv": { "version": "6.12.6", "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", - "dev": true, + "devOptional": true, "requires": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -44634,19 +44152,19 @@ "version": "3.3.0", "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz", "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==", - "dev": true + "devOptional": true }, "mime-db": { "version": "1.47.0", "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.47.0.tgz", "integrity": "sha512-QBmA/G2y+IfeS4oktet3qRZ+P5kPhCKRXxXnQEudYqUaEioAU1/Lq2us3D/t1Jfo4hE9REQPrbB7K5sOczJVIw==", - "dev": true + "devOptional": true }, "mime-types": { "version": "2.1.30", "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.30.tgz", "integrity": "sha512-crmjA4bLtR8m9qLpHvgxSChT+XoSlZi8J4n/aIdn3z92e/U47Z0V/yl+Wh9W046GgFVAmoNR/fmdbZYcSSIUeg==", - "dev": true, + "devOptional": true, "requires": { "mime-db": "1.47.0" } @@ -44655,7 +44173,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.0.0.tgz", "integrity": "sha512-6D82/xSzO094ajanoOSbe4YvXWMfn2A//8Y1+MUqFAJul5Bs+yn36xbK9OtNDcRVSBJ9jjeoXftM6CfztsjOAA==", - "dev": true, + "devOptional": true, "requires": { "@types/json-schema": "^7.0.6", "ajv": "^6.12.5", @@ -44666,13 +44184,13 @@ "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true + "devOptional": true }, "webpack-sources": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/webpack-sources/-/webpack-sources-2.2.0.tgz", "integrity": "sha512-bQsA24JLwcnWGArOKUxYKhX3Mz/nK1Xf6hxullKERyktjNMC4x8koOeaDNTA2fEJ09BdWLbM/iTW0ithREUP0w==", - "dev": true, + "devOptional": true, "requires": { "source-list-map": "^2.0.1", "source-map": "^0.6.1" diff --git a/package.json b/package.json index d79bea9fd3..8530cf0c52 100644 --- a/package.json +++ b/package.json @@ -57,13 +57,14 @@ "lunr": "^2.3.9", "lunr-languages": "^1.4.0", "morgan": "^1.10.0", - "next": "^10.2.0", + "next": "^10.2.3", "node-fetch": "^2.6.1", "parse5": "^6.0.1", "port-used": "^2.0.8", "rate-limit-redis": "^2.1.0", "react": "^17.0.2", "react-dom": "^17.0.2", + "react-is": "^17.0.2", "redis": "^3.1.2", "redis-mock": "^0.56.3", "rehype-autolink-headings": "^2.0.5", diff --git a/pages/[versionId]/[productId]/index.tsx b/pages/[versionId]/[productId]/index.tsx index 0ede3f7750..26ca776b69 100644 --- a/pages/[versionId]/[productId]/index.tsx +++ b/pages/[versionId]/[productId]/index.tsx @@ -1,4 +1,5 @@ import { GetServerSideProps } from 'next' +import { Grid } from '@primer/components' import { MainContextT, @@ -22,6 +23,8 @@ import { CodeExamples } from 'components/landing/CodeExamples' import { LandingSection } from 'components/landing/LandingSection' import { useTranslation } from 'components/hooks/useTranslation' import { ProductArticlesList } from 'components/landing/ProductArticlesList' +import { TableOfContents } from 'components/landing/TableOfContents' +import { ArticleVersionPicker } from 'components/article/ArticleVersionPicker' type Props = { mainContext: MainContextT @@ -31,13 +34,17 @@ const ProductPage = ({ mainContext, productLandingContext }: Props) => { return ( - + {mainContext.currentLayoutName === 'product-landing' ? ( + + ) : ( + + )} ) } -const ProductPageInner = () => { +const ProductLanding = () => { const { title, guideCards, productUserExamples, productCommunityExamples, productCodeExamples } = useProductLandingContext() const { t } = useTranslation('product_landing') @@ -85,6 +92,34 @@ const ProductPageInner = () => { ) } +const TocProductLanding = () => { + const { title, introPlainText, tocItems } = useProductLandingContext() + return ( + + +
        +

        {title}

        +
        +

        {introPlainText}

        +
        + +
        + +
        +
        +
        + +
        +         +         + ) +} + export default ProductPage export const getServerSideProps: GetServerSideProps = async (context) => { diff --git a/tests/README.md b/tests/README.md index ab5553310a..e9418bce4e 100644 --- a/tests/README.md +++ b/tests/README.md @@ -20,6 +20,11 @@ need to make sure optional dependencies are installed by running: npm ci --include=optional ``` +If you run into the error "Could not find expected browser (chrome) locally" you may need to manually install the expected chromium version with: +``` +node node_modules/puppeteer/install.js +``` + ### Running all the tests Once you've followed the development instructions above, you can run the entire diff --git a/tests/browser/browser.js b/tests/browser/browser.js index ce89ed6c85..e6b3e60ebd 100644 --- a/tests/browser/browser.js +++ b/tests/browser/browser.js @@ -308,3 +308,20 @@ describe('GraphQL Explorer', () => { expect(searchResult).toBeNull() }) }) + +describe('nextjs query param', () => { + jest.setTimeout(60 * 1000) + + it('conditionally renders through nextjs pipeline depending on FEATURE_NEXTJS value', async () => { + const flagVal = require('../../feature-flags.json').FEATURE_NEXTJS + await page.goto('http://localhost:4001/en/sponsors?nextjs=') + const nextWrapper = await page.$('#__next') + flagVal === true ? expect(nextWrapper).toBeDefined() : expect(nextWrapper).toBeNull() + }) + + it('does not render through nextjs pipeline when nextjs query param is missing', async () => { + await page.goto('http://localhost:4001/en/sponsors') + const nextWrapper = await page.$('#__next') + expect(nextWrapper).toBeNull() + }) +}) diff --git a/tests/helpers/schemas/ghae-release-notes-schema.js b/tests/helpers/schemas/ghae-release-notes-schema.js new file mode 100644 index 0000000000..4fcbc5e939 --- /dev/null +++ b/tests/helpers/schemas/ghae-release-notes-schema.js @@ -0,0 +1,71 @@ +const section = { + anyOf: [ + { + type: 'array', + items: { type: 'string' }, + minItems: 1 + }, + { + type: 'object', + properties: { + heading: { + type: 'string', + required: true + }, + notes: { + type: 'array', + items: { type: 'string' }, + required: true, + minItems: 1 + } + } + } + ] +} + +module.exports = { + properties: { + intro: { + type: 'string' + }, + date: { + type: 'string', + format: 'date', + required: true + }, + friendlyDate: { + type: 'string', + required: true + }, + title: { + type: 'string', + required: true + }, + currentWeek: { + type: 'boolean', + required: true + }, + release_candidate: { + type: 'boolean', + default: false + }, + deprecated: { + type: 'boolean', + default: false + }, + sections: { + required: true, + type: 'object', + minProperties: 1, + properties: [ + 'bugs', + 'known_issues', + 'features', + 'changes', + 'deprecations', + 'security_fixes', + 'backups' + ].reduce((prev, curr) => ({ ...prev, [curr]: section }), {}) + } + } +} diff --git a/tests/helpers/schemas/release-notes-schema.js b/tests/helpers/schemas/ghes-release-notes-schema.js similarity index 100% rename from tests/helpers/schemas/release-notes-schema.js rename to tests/helpers/schemas/ghes-release-notes-schema.js diff --git a/tests/linting/lint-files.js b/tests/linting/lint-files.js index 8db8a1c03e..5fcc88f212 100644 --- a/tests/linting/lint-files.js +++ b/tests/linting/lint-files.js @@ -10,7 +10,8 @@ const readFileAsync = require('../../lib/readfile-async') const frontmatter = require('../../lib/frontmatter') const languages = require('../../lib/languages') const { tags } = require('../../lib/liquid-tags/extended-markdown') -const ghesReleaseNotesSchema = require('../helpers/schemas/release-notes-schema') +const ghesReleaseNotesSchema = require('../helpers/schemas/ghes-release-notes-schema') +const ghaeReleaseNotesSchema = require('../helpers/schemas/ghae-release-notes-schema') const learningTracksSchema = require('../helpers/schemas/learning-tracks-schema') const renderContent = require('../../lib/render-content') const { execSync } = require('child_process') @@ -22,7 +23,8 @@ const contentDir = path.join(rootDir, 'content') const reusablesDir = path.join(rootDir, 'data/reusables') const variablesDir = path.join(rootDir, 'data/variables') const glossariesDir = path.join(rootDir, 'data/glossaries') -const ghesReleaseNotesDir = path.join(rootDir, 'data/release-notes') +const ghesReleaseNotesDir = path.join(rootDir, 'data/release-notes/enterprise-server') +const ghaeReleaseNotesDir = path.join(rootDir, 'data/release-notes/github-ae') const learningTracks = path.join(rootDir, 'data/learning-tracks') const languageCodes = Object.keys(languages) @@ -171,7 +173,7 @@ const yamlWalkOptions = { } // different lint rules apply to different content types -let mdToLint, ymlToLint, releaseNotesToLint, learningTracksToLint +let mdToLint, ymlToLint, ghesReleaseNotesToLint, ghaeReleaseNotesToLint, learningTracksToLint if (!process.env.TEST_TRANSLATION) { // compile lists of all the files we want to lint @@ -201,7 +203,12 @@ if (!process.env.TEST_TRANSLATION) { // GHES release notes const ghesReleaseNotesYamlAbsPaths = walk(ghesReleaseNotesDir, yamlWalkOptions).sort() const ghesReleaseNotesYamlRelPaths = ghesReleaseNotesYamlAbsPaths.map(p => slash(path.relative(rootDir, p))) - releaseNotesToLint = zip(ghesReleaseNotesYamlRelPaths, ghesReleaseNotesYamlAbsPaths) + ghesReleaseNotesToLint = zip(ghesReleaseNotesYamlRelPaths, ghesReleaseNotesYamlAbsPaths) + + // GHAE release notes + const ghaeReleaseNotesYamlAbsPaths = walk(ghaeReleaseNotesDir, yamlWalkOptions).sort() + const ghaeReleaseNotesYamlRelPaths = ghaeReleaseNotesYamlAbsPaths.map(p => slash(path.relative(rootDir, p))) + ghaeReleaseNotesToLint = zip(ghaeReleaseNotesYamlRelPaths, ghaeReleaseNotesYamlAbsPaths) // Learning tracks const learningTracksYamlAbsPaths = walk(learningTracks, yamlWalkOptions).sort() @@ -216,7 +223,7 @@ if (!process.env.TEST_TRANSLATION) { console.log(`Found ${changedFilesRelPaths.length} translated files.`) - const { mdRelPaths = [], ymlRelPaths = [], releaseNotesRelPaths = [], learningTracksRelPaths = [] } = groupBy(changedFilesRelPaths, (path) => { + const { mdRelPaths = [], ymlRelPaths = [], ghesReleaseNotesRelPaths = [], ghaeReleaseNotesRelPaths = [], learningTracksRelPaths = [] } = groupBy(changedFilesRelPaths, (path) => { // separate the changed files to different groups if (path.endsWith('README.md')) { return 'throwAway' @@ -224,8 +231,10 @@ if (!process.env.TEST_TRANSLATION) { return 'mdRelPaths' } else if (path.match(/\/data\/(variables|glossaries)\//i)) { return 'ymlRelPaths' - } else if (path.match(/\/data\/release-notes\//i)) { - return 'releaseNotesRelPaths' + } else if (path.match(/\/data\/release-notes\/enterprise-server/i)) { + return 'ghesReleaseNotesRelPaths' + } else if (path.match(/\/data\/release-notes\/github-ae/i)) { + return 'ghaeReleaseNotesRelPaths' } else if (path.match(/\data\/learning-tracks/)) { return 'learningTracksRelPaths' } else { @@ -234,14 +243,15 @@ if (!process.env.TEST_TRANSLATION) { } }) - const [mdTuples, ymlTuples, releaseNotesTuples, learningTracksTuples] = [mdRelPaths, ymlRelPaths, releaseNotesRelPaths, learningTracksRelPaths].map(relPaths => { + const [mdTuples, ymlTuples, ghesReleaseNotesTuples, ghaeReleaseNotesTuples, learningTracksTuples] = [mdRelPaths, ymlRelPaths, ghesReleaseNotesRelPaths, ghaeReleaseNotesRelPaths, learningTracksRelPaths].map(relPaths => { const absPaths = relPaths.map(p => path.join(rootDir, p)) return zip(relPaths, absPaths) }) mdToLint = mdTuples ymlToLint = ymlTuples - releaseNotesToLint = releaseNotesTuples + ghesReleaseNotesToLint = ghesReleaseNotesTuples + ghaeReleaseNotesToLint = ghaeReleaseNotesTuples learningTracksToLint = learningTracksTuples } @@ -661,9 +671,9 @@ describe('lint yaml content', () => { ) }) -describe('lint release notes', () => { - if (releaseNotesToLint.length < 1) return - describe.each(releaseNotesToLint)( +describe('lint GHES release notes', () => { + if (ghesReleaseNotesToLint.length < 1) return + describe.each(ghesReleaseNotesToLint)( '%s', (yamlRelPath, yamlAbsPath) => { let dictionary @@ -707,6 +717,59 @@ describe('lint release notes', () => { ) }) +describe('lint GHAE release notes', () => { + if (ghaeReleaseNotesToLint.length < 1) return + const currentWeeksFound = [] + describe.each(ghaeReleaseNotesToLint)( + '%s', + (yamlRelPath, yamlAbsPath) => { + let dictionary + + beforeAll(async () => { + const fileContents = await readFileAsync(yamlAbsPath, 'utf8') + dictionary = yaml.load(fileContents, { filename: yamlRelPath }) + }) + + it('matches the schema', () => { + const { errors } = revalidator.validate(dictionary, ghaeReleaseNotesSchema) + const errorMessage = errors.map(error => `- [${error.property}]: ${error.actual}, ${error.message}`).join('\n') + expect(errors.length, errorMessage).toBe(0) + }) + + it('does not have more than one yaml file with currentWeek set to true', () => { + if (dictionary.currentWeek) currentWeeksFound.push(yamlRelPath) + const errorMessage = `Found more than one file with currentWeek set to true: ${currentWeeksFound.join('\n')}` + expect(currentWeeksFound.length, errorMessage).not.toBeGreaterThan(1) + }) + + it('contains valid liquid', () => { + const { intro, sections } = dictionary + let toLint = { intro } + for (const key in sections) { + const section = sections[key] + const label = `sections.${key}` + section.forEach((part) => { + if (Array.isArray(part)) { + toLint = { ...toLint, ...{ [label]: section.join('\n') } } + } else { + for (const prop in section) { + toLint = { ...toLint, ...{ [`${label}.${prop}`]: section[prop] } } + } + } + }) + } + + for (const key in toLint) { + if (!toLint[key]) continue + expect(() => renderContent.liquid.parse(toLint[key]), `${key} contains invalid liquid`) + .not + .toThrow() + } + }) + } + ) +}) + describe('lint learning tracks', () => { if (learningTracksToLint.length < 1) return describe.each(learningTracksToLint)( diff --git a/tests/rendering/events.js b/tests/rendering/events.js index df40ddfba3..2ec5d7eca3 100644 --- a/tests/rendering/events.js +++ b/tests/rendering/events.js @@ -474,4 +474,25 @@ describe('POST /events', () => { checkEvent(printExample, 200) ) }) + + describe('preference', () => { + const preferenceExample = { + ...baseExample, + type: 'preference', + preference_name: 'application', + preference_value: 'cli' + } + + it('should record an application event', () => + checkEvent(preferenceExample, 200) + ) + + it('preference_name is string', () => { + checkEvent({ ...preferenceExample, preference_name: null }, 400) + }) + + it('preference_value is string', () => { + checkEvent({ ...preferenceExample, preference_value: null }, 400) + }) + }) }) diff --git a/tests/rendering/footer.js b/tests/rendering/footer.js index 59a0ed4729..e08d8bdd93 100644 --- a/tests/rendering/footer.js +++ b/tests/rendering/footer.js @@ -21,4 +21,11 @@ describe('footer', () => { expect($('a#contact-us').attr('href')).toBe('https://support.github.com/contact') }) }) + + describe('"contact us" link with nextjs', () => { + test('leads to dotcom support on dotcom pages', async () => { + const $ = await getDOM(`/en/${nonEnterpriseDefaultVersion}/github?nextjs=`) + expect($('a#contact-us').attr('href')).toBe('https://support.github.com/contact') + }) + }) }) diff --git a/tests/routing/enterprise-release-notes.js b/tests/routing/release-notes.js similarity index 80% rename from tests/routing/enterprise-release-notes.js rename to tests/routing/release-notes.js index 6a8f6c26b3..bbf08d1e2a 100644 --- a/tests/routing/enterprise-release-notes.js +++ b/tests/routing/release-notes.js @@ -1,6 +1,6 @@ const { get } = require('../helpers/supertest') -describe('enterprise release notes', () => { +describe('release notes', () => { jest.setTimeout(60 * 1000) beforeAll(async () => { @@ -16,9 +16,13 @@ describe('enterprise release notes', () => { expect(res.headers.location).toBe('https://enterprise.github.com/releases/2.19.0/notes') }) - // We can't write this test until we have real release notes it('renders the release-notes layout if this version\'s release notes are in this repo', async () => { const res = await get('/en/enterprise-server@2.22/admin/release-notes') expect(res.statusCode).toBe(200) }) + + it('renders the release-notes layout for GitHub AE', async () => { + const res = await get('/en/github-ae@latest/admin/release-notes') + expect(res.statusCode).toBe(200) + }) }) diff --git a/translations/de-DE/content/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system.md b/translations/de-DE/content/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system.md index 3a04b180a9..c403a1da2c 100644 --- a/translations/de-DE/content/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system.md +++ b/translations/de-DE/content/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system.md @@ -7,8 +7,15 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: overview topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Repositories + - Pull requests + - Integration + - CI --- {% data reusables.code-scanning.beta %} diff --git a/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md b/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md index 3e7a411b73..31aa2d374c 100644 --- a/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md +++ b/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md @@ -7,8 +7,15 @@ redirect_from: - /code-security/supply-chain-security/customizing-dependency-updates versions: free-pro-team: '*' +type: how_to topics: + - Dependabot + - Version updates + - Security updates - Repositories + - Dependencies + - Pull requests + - Vulnerabilities --- ### About customizing dependency updates diff --git a/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md b/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md index b84c596853..e4de9c94be 100644 --- a/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md +++ b/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md @@ -6,8 +6,14 @@ redirect_from: - /code-security/supply-chain-security/managing-pull-requests-for-dependency-updates versions: free-pro-team: '*' +type: how_to topics: - Repositories + - Version updates + - Security updates + - Pull requests + - Dependencies + - Vulnerabilities --- ### About {% data variables.product.prodname_dependabot %} pull requests diff --git a/translations/ko-KR/content/code-security/secure-coding/running-codeql-runner-in-your-ci-system.md b/translations/ko-KR/content/code-security/secure-coding/running-codeql-runner-in-your-ci-system.md index 495d68c51c..9f1642dcfe 100644 --- a/translations/ko-KR/content/code-security/secure-coding/running-codeql-runner-in-your-ci-system.md +++ b/translations/ko-KR/content/code-security/secure-coding/running-codeql-runner-in-your-ci-system.md @@ -11,8 +11,15 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Repositories + - Pull requests + - Integration + - CI --- diff --git a/translations/ko-KR/content/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot.md b/translations/ko-KR/content/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot.md index 7c186aac17..8efa13d02b 100644 --- a/translations/ko-KR/content/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot.md +++ b/translations/ko-KR/content/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot.md @@ -3,8 +3,14 @@ title: Upgrading from Dependabot.com to GitHub-native Dependabot intro: You can upgrade to GitHub-native Dependabot by merging a pull request that will allow your dependencies to continue being updated. versions: free-pro-team: '*' +type: how_to topics: - Repositories + - Dependabot + - Upgrading + - Version updates + - Dependencies + - Migration --- {% warning %}