Merge branch 'main' into remove-systemctl-note
This commit is contained in:
@@ -3,11 +3,11 @@ import Head from 'next/head'
|
||||
import { SidebarNav } from 'components/sidebar/SidebarNav'
|
||||
import { Header } from 'components/page-header/Header'
|
||||
import { SmallFooter } from 'components/page-footer/SmallFooter'
|
||||
import { ScrollButton } from 'components/ScrollButton'
|
||||
import { ScrollButton } from 'components/ui/ScrollButton'
|
||||
import { SupportSection } from 'components/page-footer/SupportSection'
|
||||
import { DeprecationBanner } from 'components/page-header/DeprecationBanner'
|
||||
import { useMainContext } from 'components/context/MainContext'
|
||||
import { useTranslation } from './hooks/useTranslation'
|
||||
import { useTranslation } from 'components/hooks/useTranslation'
|
||||
|
||||
type Props = { children?: React.ReactNode }
|
||||
export const DefaultLayout = (props: Props) => {
|
||||
@@ -23,7 +23,7 @@ export const DefaultLayout = (props: Props) => {
|
||||
fullUrl,
|
||||
status,
|
||||
} = useMainContext()
|
||||
const { t } = useTranslation('errors')
|
||||
const { t } = useTranslation(['errors', 'scroll_button'])
|
||||
return (
|
||||
<div className="d-lg-flex">
|
||||
<Head>
|
||||
@@ -90,7 +90,10 @@ export const DefaultLayout = (props: Props) => {
|
||||
|
||||
<SupportSection />
|
||||
<SmallFooter />
|
||||
<ScrollButton />
|
||||
<ScrollButton
|
||||
className="position-fixed bottom-0 mb-3 right-0 mr-3"
|
||||
ariaLabel={t('scroll_to_top')}
|
||||
/>
|
||||
</main>
|
||||
</div>
|
||||
)
|
||||
|
||||
@@ -192,7 +192,7 @@ export function Search({
|
||||
dangerouslySetInnerHTML={{ __html: breadcrumbs }}
|
||||
/>
|
||||
<div
|
||||
className={cx(styles.searchResultTitle, 'd-block f4 font-weight-semibold')}
|
||||
className={cx(styles.searchResultTitle, 'd-block f4 text-semibold')}
|
||||
dangerouslySetInnerHTML={{
|
||||
__html: heading ? `${title}: ${heading}` : title,
|
||||
}}
|
||||
|
||||
@@ -4,36 +4,21 @@ import dayjs from 'dayjs'
|
||||
import { Link } from 'components/Link'
|
||||
import { ArrowRightIcon } from '@primer/octicons-react'
|
||||
import { FeaturedLink } from 'components/context/ProductLandingContext'
|
||||
import { TruncateLines } from 'components/TruncateLines'
|
||||
import { TruncateLines } from 'components/ui/TruncateLines'
|
||||
import { BumpLink } from 'components/ui/BumpLink'
|
||||
|
||||
type Props = {
|
||||
export type ArticleListPropsT = {
|
||||
title?: string
|
||||
viewAllHref?: string
|
||||
articles: Array<FeaturedLink>
|
||||
variant?: 'compact' | 'spaced'
|
||||
titleVariant?: 'large' | 'default'
|
||||
}
|
||||
export const ArticleList = ({
|
||||
title,
|
||||
viewAllHref,
|
||||
articles,
|
||||
variant = 'compact',
|
||||
titleVariant = 'default',
|
||||
}: Props) => {
|
||||
|
||||
export const ArticleList = ({ title, viewAllHref, articles }: ArticleListPropsT) => {
|
||||
return (
|
||||
<>
|
||||
{title && (
|
||||
<div className="mb-4 d-flex flex-items-baseline">
|
||||
<h3
|
||||
className={cx(
|
||||
titleVariant === 'large'
|
||||
? 'f4 font-weight-semibold'
|
||||
: 'f5 text-normal underline-dashed color-text-secondary'
|
||||
)}
|
||||
>
|
||||
{title}
|
||||
</h3>
|
||||
<h3 className={cx('f4 text-semibold')}>{title}</h3>
|
||||
{viewAllHref && (
|
||||
<Link href={viewAllHref} className="ml-4">
|
||||
View all <ArrowRightIcon size={14} className="v-align-middle" />
|
||||
@@ -45,7 +30,7 @@ export const ArticleList = ({
|
||||
<ul className="list-style-none" data-testid="article-list">
|
||||
{articles.map((link) => {
|
||||
return (
|
||||
<li key={link.href} className={cx(variant === 'compact' && 'border-top')}>
|
||||
<li key={link.href} className={cx('border-top')}>
|
||||
<BumpLink
|
||||
as={Link}
|
||||
href={link.href}
|
||||
@@ -61,11 +46,7 @@ export const ArticleList = ({
|
||||
}
|
||||
>
|
||||
{!link.hideIntro && link.intro && (
|
||||
<TruncateLines
|
||||
as="p"
|
||||
maxLines={variant === 'spaced' ? 6 : 2}
|
||||
className="color-text-secondary mb-0 mt-1"
|
||||
>
|
||||
<TruncateLines as="p" maxLines={2} className="color-text-secondary mb-0 mt-1">
|
||||
<span
|
||||
data-testid="link-with-intro-intro"
|
||||
dangerouslySetInnerHTML={{ __html: link.intro }}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { RepoIcon } from '@primer/octicons-react'
|
||||
import { CodeExample } from 'components/context/ProductLandingContext'
|
||||
import { TruncateLines } from 'components/TruncateLines'
|
||||
import { TruncateLines } from 'components/ui/TruncateLines'
|
||||
|
||||
type Props = {
|
||||
example: CodeExample
|
||||
|
||||
@@ -2,7 +2,7 @@ import cx from 'classnames'
|
||||
|
||||
import { useProductLandingContext } from 'components/context/ProductLandingContext'
|
||||
import { useTranslation } from 'components/hooks/useTranslation'
|
||||
import { ArticleList } from './ArticleList'
|
||||
import { ArticleList } from 'components/landing/ArticleList'
|
||||
|
||||
export const FeaturedArticles = () => {
|
||||
const { featuredArticles = [], whatsNewChangelog, changelogUrl } = useProductLandingContext()
|
||||
@@ -19,7 +19,6 @@ export const FeaturedArticles = () => {
|
||||
>
|
||||
<ArticleList
|
||||
title={section.label}
|
||||
titleVariant="large"
|
||||
viewAllHref={section.viewAllHref}
|
||||
articles={section.articles}
|
||||
/>
|
||||
@@ -31,7 +30,6 @@ export const FeaturedArticles = () => {
|
||||
<div className={cx('col-12 mb-4 mb-lg-0 col-lg-4')}>
|
||||
<ArticleList
|
||||
title={t('whats_new')}
|
||||
titleVariant="large"
|
||||
viewAllHref={changelogUrl}
|
||||
articles={(whatsNewChangelog || []).map((link) => {
|
||||
return {
|
||||
|
||||
@@ -38,17 +38,12 @@ export const TocLanding = () => {
|
||||
<div className="col-12 col-lg-6 mb-md-4 mb-lg-0 float-left">
|
||||
<ArticleList
|
||||
title={t('getting_started')}
|
||||
variant="spaced"
|
||||
articles={featuredLinks.gettingStarted}
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="col-12 col-lg-6 float-left">
|
||||
<ArticleList
|
||||
title={t('popular')}
|
||||
variant="spaced"
|
||||
articles={featuredLinks.popular}
|
||||
/>
|
||||
<ArticleList title={t('popular')} articles={featuredLinks.popular} />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -65,7 +65,7 @@ export const Header = () => {
|
||||
|
||||
<Link
|
||||
href={`/${router.locale}`}
|
||||
className="f4 font-weight-semibold color-text-primary no-underline no-wrap pl-2"
|
||||
className="f4 text-semibold color-text-primary no-underline no-wrap pl-2"
|
||||
>
|
||||
{t('github_docs')}
|
||||
</Link>
|
||||
|
||||
@@ -33,7 +33,7 @@ export const SidebarNav = () => {
|
||||
</Link>
|
||||
<Link
|
||||
href={`/${router.locale}`}
|
||||
className="f4 font-weight-semibold color-text-primary no-underline no-wrap pl-2 flex-auto"
|
||||
className="f4 text-semibold color-text-primary no-underline no-wrap pl-2 flex-auto"
|
||||
>
|
||||
{t('github_docs')}
|
||||
</Link>
|
||||
|
||||
3
components/sublanding/LearningTrack.module.scss
Normal file
3
components/sublanding/LearningTrack.module.scss
Normal file
@@ -0,0 +1,3 @@
|
||||
.fadeBottom {
|
||||
background: linear-gradient(to top, var(--color-bg-primary), transparent);
|
||||
}
|
||||
@@ -1,8 +1,10 @@
|
||||
import cx from 'classnames'
|
||||
import { useTranslation } from 'components/hooks/useTranslation'
|
||||
import { ArrowRightIcon } from '@primer/octicons-react'
|
||||
import { useState } from 'react'
|
||||
import { FeaturedTrack } from 'components/context/ProductSubLandingContext'
|
||||
import { TruncateLines } from 'components/TruncateLines'
|
||||
import { TruncateLines } from 'components/ui/TruncateLines'
|
||||
import styles from './LearningTrack.module.scss'
|
||||
|
||||
type Props = {
|
||||
track: FeaturedTrack
|
||||
@@ -22,7 +24,7 @@ export const LearningTrack = ({ track }: Props) => {
|
||||
<div className="Box-header color-bg-secondary p-4 d-flex flex-1 flex-items-start flex-wrap">
|
||||
<div className="d-flex flex-auto flex-items-start col-8 col-md-12 col-xl-8">
|
||||
<div className="my-xl-0 mr-xl-3">
|
||||
<h5 className="mb-3 color-text f3 font-weight-semibold">{track?.title}</h5>
|
||||
<h5 className="mb-3 color-text f3 text-semibold">{track?.title}</h5>
|
||||
<TruncateLines as="p" maxLines={3} className="color-text">
|
||||
{track?.description}
|
||||
</TruncateLines>
|
||||
@@ -68,7 +70,7 @@ export const LearningTrack = ({ track }: Props) => {
|
||||
onClick={showAll}
|
||||
>
|
||||
<div
|
||||
className="position-absolute left-0 right-0 py-5 fade-tertiary-bottom"
|
||||
className={cx('position-absolute left-0 right-0 py-5', styles.fadeBottom)}
|
||||
style={{ bottom: '50px' }}
|
||||
></div>
|
||||
<span>
|
||||
|
||||
7
components/sublanding/SubLandingHero.module.scss
Normal file
7
components/sublanding/SubLandingHero.module.scss
Normal file
@@ -0,0 +1,7 @@
|
||||
.fadeLeft {
|
||||
background: linear-gradient(to right, var(--color-bg-primary), transparent);
|
||||
}
|
||||
|
||||
.fadeRight {
|
||||
background: linear-gradient(to left, var(--color-bg-primary), transparent);
|
||||
}
|
||||
@@ -1,10 +1,12 @@
|
||||
import cx from 'classnames'
|
||||
import { Breadcrumbs } from '../Breadcrumbs'
|
||||
import { useProductSubLandingContext } from 'components/context/ProductSubLandingContext'
|
||||
import { ArrowRightIcon, StarFillIcon } from '@primer/octicons-react'
|
||||
import { useTranslation } from 'components/hooks/useTranslation'
|
||||
import { Link } from 'components/Link'
|
||||
import { TruncateLines } from 'components/TruncateLines'
|
||||
import { TruncateLines } from 'components/ui/TruncateLines'
|
||||
import { Lead } from 'components/ui/Lead'
|
||||
import styles from './SubLandingHero.module.scss'
|
||||
|
||||
export const SubLandingHero = () => {
|
||||
const { title, intro, featuredTrack } = useProductSubLandingContext()
|
||||
@@ -32,7 +34,7 @@ export const SubLandingHero = () => {
|
||||
{t('guide_types')[guide.page?.type || '']}
|
||||
</div>
|
||||
</div>
|
||||
<h3 className="font-weight-semibold my-4 color-text-primary">{guide.title}</h3>
|
||||
<h3 className="text-semibold my-4 color-text-primary">{guide.title}</h3>
|
||||
<TruncateLines maxLines={8} className="color-text-secondary f5 my-4">
|
||||
<span dangerouslySetInnerHTML={{ __html: guide.intro }} />
|
||||
</TruncateLines>
|
||||
@@ -63,7 +65,7 @@ export const SubLandingHero = () => {
|
||||
>
|
||||
<StarFillIcon size={24} />
|
||||
</div>
|
||||
<h3 className="font-weight-semibold my-4">{featuredTrack.title}</h3>
|
||||
<h3 className="text-semibold my-4">{featuredTrack.title}</h3>
|
||||
<div className="f5 my-4">{featuredTrack.description}</div>
|
||||
{featuredTrack.guides && (
|
||||
<Link
|
||||
@@ -79,8 +81,12 @@ export const SubLandingHero = () => {
|
||||
</li>
|
||||
{guideItems}
|
||||
</ul>
|
||||
<div className="position-absolute top-0 bottom-0 left-0 ml-3 pl-3 fade-tertiary-left"></div>
|
||||
<div className="position-absolute top-0 bottom-0 right-0 mr-3 pr-3 fade-tertiary-right"></div>
|
||||
<div
|
||||
className={cx('position-absolute top-0 bottom-0 left-0 ml-3 pl-3', styles.fadeLeft)}
|
||||
></div>
|
||||
<div
|
||||
className={cx('position-absolute top-0 bottom-0 right-0 mr-3 pr-3', styles.fadeRight)}
|
||||
></div>
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
|
||||
@@ -1,11 +1,14 @@
|
||||
import { useState, useEffect } from 'react'
|
||||
import cx from 'classnames'
|
||||
import { ChevronUpIcon } from '@primer/octicons-react'
|
||||
import { useTranslation } from './hooks/useTranslation'
|
||||
|
||||
export const ScrollButton = () => {
|
||||
export type ScrollButtonPropsT = {
|
||||
className?: string
|
||||
ariaLabel?: string
|
||||
}
|
||||
|
||||
export const ScrollButton = ({ className, ariaLabel }: ScrollButtonPropsT) => {
|
||||
const [show, setShow] = useState(false)
|
||||
const { t } = useTranslation('scroll_button')
|
||||
|
||||
useEffect(() => {
|
||||
// show scroll button only when view is scrolled down
|
||||
@@ -29,19 +32,14 @@ export const ScrollButton = () => {
|
||||
}
|
||||
|
||||
return (
|
||||
<div
|
||||
className={cx(
|
||||
'position-fixed bottom-0 mb-3 right-0 mr-3 transition-200',
|
||||
show ? 'opacity-100' : 'opacity-0'
|
||||
)}
|
||||
>
|
||||
<div className={cx(className, 'transition-200', show ? 'opacity-100' : 'opacity-0')}>
|
||||
<button
|
||||
onClick={onClick}
|
||||
className={cx(
|
||||
'tooltipped tooltipped-n tooltipped-no-delay color-bg-info-inverse color-text-inverse circle border-0'
|
||||
)}
|
||||
style={{ width: 40, height: 40 }}
|
||||
aria-label={t('scroll_to_top')}
|
||||
aria-label={ariaLabel}
|
||||
>
|
||||
<ChevronUpIcon />
|
||||
</button>
|
||||
1
components/ui/ScrollButton/index.ts
Normal file
1
components/ui/ScrollButton/index.ts
Normal file
@@ -0,0 +1 @@
|
||||
export { ScrollButton } from './ScrollButton'
|
||||
@@ -1,13 +1,14 @@
|
||||
import React, { ReactNode } from 'react'
|
||||
import cx from 'classnames'
|
||||
|
||||
type Props = {
|
||||
export type TruncateLinesPropsT = {
|
||||
as?: keyof JSX.IntrinsicElements
|
||||
maxLines: number
|
||||
children: ReactNode
|
||||
className?: string
|
||||
}
|
||||
export const TruncateLines = (props: Props) => {
|
||||
|
||||
export const TruncateLines = (props: TruncateLinesPropsT) => {
|
||||
const { maxLines, className, children, as: Component = 'div' } = props
|
||||
return (
|
||||
<Component className={cx('root', className)}>
|
||||
1
components/ui/TruncateLines/index.ts
Normal file
1
components/ui/TruncateLines/index.ts
Normal file
@@ -0,0 +1 @@
|
||||
export { TruncateLines } from './TruncateLines'
|
||||
@@ -57,6 +57,13 @@ You can use any machine as a self-hosted runner as long at it meets these requir
|
||||
* The machine has enough hardware resources for the type of workflows you plan to run. The self-hosted runner application itself only requires minimal resources.
|
||||
* If you want to run workflows that use Docker container actions or service containers, you must use a Linux machine and Docker must be installed.
|
||||
|
||||
{% ifversion fpt or ghes > 3.2 %}
|
||||
## Autoscaling your self-hosted runners
|
||||
|
||||
You can automatically increase or decrease the number of self-hosted runners in your environment in response to the webhook events you receive. For more information, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Usage limits
|
||||
|
||||
There are some limits on {% data variables.product.prodname_actions %} usage when using self-hosted runners. These limits are subject to change.
|
||||
|
||||
@@ -35,22 +35,43 @@ For more information, see "[About self-hosted runners](/github/automating-your-w
|
||||
|
||||
You can add self-hosted runners to a single repository. To add a self-hosted runner to a user repository, you must be the repository owner. For an organization repository, you must be an organization owner or have admin access to the repository.
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runners-updated %}
|
||||
1. Click **New self-hosted runner**.
|
||||
{% data reusables.github-actions.self-hosted-runner-configure %}
|
||||
{% endif %}
|
||||
{% ifversion ghae or ghes %}
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runners %}
|
||||
1. Under {% ifversion fpt %}"Runners"{% else %}"Self-hosted runners"{% endif %}, click **Add runner**.
|
||||
{% data reusables.github-actions.self-hosted-runner-configure %}
|
||||
{% endif %}
|
||||
{% data reusables.github-actions.self-hosted-runner-check-installation-success %}
|
||||
|
||||
## Adding a self-hosted runner to an organization
|
||||
|
||||
You can add self-hosted runners at the organization level, where they can be used to process jobs for multiple repositories in an organization. To add a self-hosted runner to an organization, you must be an organization owner.
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% data reusables.organizations.navigate-to-org %}
|
||||
{% data reusables.organizations.org_settings %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runners-updated %}
|
||||
1. Click **New runner**.
|
||||
{% data reusables.github-actions.self-hosted-runner-configure %}
|
||||
{% endif %}
|
||||
{% ifversion ghae or ghes %}
|
||||
{% data reusables.organizations.navigate-to-org %}
|
||||
{% data reusables.organizations.org_settings %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runners %}
|
||||
1. Under {% ifversion fpt %}"Runners"{% else %}"Self-hosted runners"{% endif %}, click **Add runner**.
|
||||
{% data reusables.github-actions.self-hosted-runner-configure %}
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.github-actions.self-hosted-runner-check-installation-success %}
|
||||
|
||||
{% data reusables.github-actions.self-hosted-runner-public-repo-access %}
|
||||
@@ -59,18 +80,27 @@ You can add self-hosted runners at the organization level, where they can be use
|
||||
|
||||
You can add self-hosted runners to an enterprise, where they can be assigned to multiple organizations. The organization admins are then able to control which repositories can use it.
|
||||
|
||||
New runners are assigned to the default group. You can modify the runner's group after you've registered the runner. For more information, see "[Managing access to self-hosted runners](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)."
|
||||
|
||||
{% ifversion fpt %}
|
||||
To add a self-hosted runner to an enterprise account, you must be an enterprise owner.
|
||||
{% elsif ghes or ghae %}
|
||||
To add a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be a site administrator.
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-runners-tab %}
|
||||
1. Click **Add new**, then click **New runner**. New runners are assigned to the default group. You can modify the runner's group after you've registered the runner. For more information, see "[Managing access to self-hosted runners](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)."
|
||||
1. Click **New runner**.
|
||||
{% data reusables.github-actions.self-hosted-runner-configure %}
|
||||
{% endif %}
|
||||
{% ifversion ghae or ghes %}
|
||||
To add a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be a site administrator.
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-runners-tab %}
|
||||
1. Click **Add new**, then click **New runner**.
|
||||
{% data reusables.github-actions.self-hosted-runner-configure %}
|
||||
{% endif %}
|
||||
{% data reusables.github-actions.self-hosted-runner-check-installation-success %}
|
||||
|
||||
{% data reusables.github-actions.self-hosted-runner-public-repo-access %}
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
title: Autoscaling with self-hosted runners
|
||||
intro: 'You can automatically scale your self-hosted runners in response to webhook events.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>3.2'
|
||||
type: 'overview'
|
||||
---
|
||||
|
||||
{% data reusables.actions.ae-self-hosted-runners-notice %}
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
{% data reusables.actions.ae-beta %}
|
||||
|
||||
## About autoscaling
|
||||
|
||||
You can automatically increase or decrease the number of self-hosted runners in your environment in response to the webhook events you receive with a particular label. For example, you can create automation that adds a new self-hosted runner each time you receive a [`workflow_job`](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow_job) webhook event with the [`queued`](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow_job) activity, which notifies you that a new job is ready for processing. The webhook payload includes label data, so you can identify the type of runner the job is requesting. Once the job has finished, you can then create automation that removes the runner in response to the `workflow_job` [`completed`](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow_job) activity.
|
||||
|
||||
## Using ephemeral runners for autoscaling
|
||||
|
||||
{% data variables.product.prodname_dotcom %} recommends implementing autoscaling with ephemeral self-hosted runners; autoscaling with persistent self-hosted runners is not recommended. In certain cases, {% data variables.product.prodname_dotcom %} cannot guarantee that jobs are not assigned to persistent runners while they are shut down. With ephemeral runners, this can be guaranteed because {% data variables.product.prodname_dotcom %} only assigns one job to a runner.
|
||||
|
||||
This approach allows you to manage your runners as ephemeral systems, since you can use automation to provide a clean environment for each job. This helps limit the exposure of any sensitive resources from previous jobs, and also helps mitigate the risk of a compromised runner receiving new jobs.
|
||||
|
||||
To add an ephemeral runner to your environment, include the `--ephemeral` parameter when registering your runner using `config.sh`. For example:
|
||||
|
||||
```
|
||||
$ ./config.sh --url https://github.com/octo-org --token example-token --ephemeral
|
||||
```
|
||||
|
||||
The {% data variables.product.prodname_actions %} service will then automatically de-register the runner after it has processed one job. You can then create your own automation that wipes the runner after it has been de-registered.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** If a job is labeled for a certain type of runner, but none matching that type are available, the job does not immediately fail at the time of queueing. Instead, the job will remain queued until the 24 hour timeout period expires.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## Using webhooks for autoscaling
|
||||
|
||||
You can create your own autoscaling environment by using payloads received from the [`workflow_job`](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow_job) webhook. This webhook is available at the repository, organization, and enterprise levels, and the payload for this event contains an `action` key that corresponds to the stages of a workflow job's life-cycle; for example when jobs are `queued`, `in_progress`, and `completed`. You must then create your own scaling automation in response to these webhook payloads.
|
||||
|
||||
- For more information about the `workflow_job` webhook, see "[Webhook events and payloads](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow_job)."
|
||||
- To learn how to work with webhooks, see "[Creating webhooks](/developers/webhooks-and-events/webhooks/creating-webhooks)."
|
||||
|
||||
## Authentication requirements
|
||||
|
||||
You can register and delete self-hosted runners using [the API](/rest/reference/actions#self-hosted-runners). To authenticate to the API, your autoscaling implementation can use an access token or a {% data variables.product.prodname_dotcom %} app.
|
||||
|
||||
Your access token will require the following scope:
|
||||
|
||||
- For private repositories, use an access token with the [`repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes).
|
||||
- For public repositories, use an access token with the [`public_repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes).
|
||||
|
||||
To authenticate using a {% data variables.product.prodname_dotcom %} App, it must be assigned the following permissions:
|
||||
- For repositories, assign the `administration` permission.
|
||||
- for organizations, assign the `organization_self_hosted_runners` permission.
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
children:
|
||||
- /about-self-hosted-runners
|
||||
- /adding-self-hosted-runners
|
||||
- /autoscaling-with-self-hosted-runners
|
||||
- /configuring-the-self-hosted-runner-application-as-a-service
|
||||
- /using-a-proxy-server-with-self-hosted-runners
|
||||
- /using-labels-with-self-hosted-runners
|
||||
|
||||
@@ -8,7 +8,7 @@ versions:
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
type: tutorial
|
||||
shortTitle: Manage access groups
|
||||
shortTitle: Manage runner groups
|
||||
---
|
||||
|
||||
{% data reusables.actions.ae-self-hosted-runners-notice %}
|
||||
@@ -40,15 +40,32 @@ Self-hosted runners are automatically assigned to the default group when created
|
||||
|
||||
When creating a group, you must choose a policy that defines which repositories have access to the runner group.
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% data reusables.organizations.navigate-to-org %}
|
||||
{% data reusables.organizations.org_settings %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runner-groups %}
|
||||
1. In the "Runner groups" section, click **New runner group**.
|
||||
{% data reusables.github-actions.runner-group-assign-policy-repo %}
|
||||
|
||||
{% warning %}
|
||||
|
||||
**Warning**: {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %}
|
||||
|
||||
For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)."
|
||||
|
||||
{% endwarning %}
|
||||
{% data reusables.github-actions.self-hosted-runner-create-group %}
|
||||
{% endif %}
|
||||
{% ifversion ghae or ghes %}
|
||||
{% data reusables.organizations.navigate-to-org %}
|
||||
{% data reusables.organizations.org_settings %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runners %}
|
||||
1. In the {% ifversion fpt %}"Runners"{% else %}"Self-hosted runners"{% endif %} section, click **Add new**, and then **New group**.
|
||||
1. In the "Self-hosted runners" section, click **Add new**, and then **New group**.
|
||||
|
||||

|
||||
1. Enter a name for your runner group, and assign a policy for repository access.
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghae %} You can configure a runner group to be accessible to a specific list of repositories, or to all repositories in the organization. By default, only private repositories can access runners in a runner group, but you can override this.{% elsif ghes = 2.22 %}You can configure a runner group to be accessible to a specific list of repositories, all private repositories, or all repositories in the organization.{% endif %}
|
||||
{% ifversion ghes > 2.22 or ghae %} You can configure a runner group to be accessible to a specific list of repositories, or to all repositories in the organization. By default, only private repositories can access runners in a runner group, but you can override this. This setting can't be overridden if configuring an organization's runner group that was shared by an enterprise.{% endif %}{% ifversion ghes = 2.22 %}You can configure a runner group to be accessible to a specific list of repositories, all private repositories, or all repositories in the organization.{% endif %}
|
||||
|
||||
{% warning %}
|
||||
|
||||
@@ -62,6 +79,8 @@ When creating a group, you must choose a policy that defines which repositories
|
||||
|
||||

|
||||
1. Click **Save group** to create the group and apply the policy.
|
||||
{% endif %}
|
||||
|
||||
|
||||
## Creating a self-hosted runner group for an enterprise
|
||||
|
||||
@@ -71,6 +90,26 @@ Self-hosted runners are automatically assigned to the default group when created
|
||||
|
||||
When creating a group, you must choose a policy that defines which organizations have access to the runner group.
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-runner-groups-tab %}
|
||||
1. Click **New runner group**.
|
||||
{% data reusables.github-actions.runner-group-assign-policy-org %}
|
||||
|
||||
{% warning %}
|
||||
|
||||
**Warning**
|
||||
|
||||
{% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %}
|
||||
|
||||
For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)."
|
||||
|
||||
{% endwarning %}
|
||||
{% data reusables.github-actions.self-hosted-runner-create-group %}
|
||||
{% endif %}
|
||||
{% ifversion ghae or ghes %}
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-tab %}
|
||||
@@ -80,7 +119,7 @@ When creating a group, you must choose a policy that defines which organizations
|
||||

|
||||
1. Enter a name for your runner group, and assign a policy for organization access.
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghae %} You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise. By default, only private repositories can access runners in a runner group, but you can override this.{% elsif ghes = 2.22 %}You can configure a runner group to be accessible to all organizations in the enterprise or choose specific organizations.{% endif %}
|
||||
{% ifversion fpt or ghes > 2.22 or ghae %} You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise. By default, only private repositories can access runners in a runner group, but you can override this. This setting can't be overridden if configuring an organization's runner group that was shared by an enterprise.{% elsif ghes = 2.22 %}You can configure a runner group to be accessible to all organizations in the enterprise or choose specific organizations.{% endif %}
|
||||
|
||||
{% warning %}
|
||||
|
||||
@@ -94,13 +133,29 @@ When creating a group, you must choose a policy that defines which organizations
|
||||
|
||||

|
||||
1. Click **Save group** to create the group and apply the policy.
|
||||
{% endif %}
|
||||
|
||||
## Changing the access policy of a self-hosted runner group
|
||||
|
||||
You can update the access policy of a runner group, or rename a runner group.
|
||||
{% ifversion fpt %}
|
||||
{% data reusables.github-actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runner-groups-selection %}
|
||||
1. Modify the access options, or change the runner group name.
|
||||
|
||||
{% warning %}
|
||||
|
||||
**Warning**
|
||||
|
||||
{% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %}
|
||||
|
||||
For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)."
|
||||
|
||||
{% endwarning %}
|
||||
{% endif %}
|
||||
{% ifversion ghae or ghes %}
|
||||
{% data reusables.github-actions.self-hosted-runner-configure-runner-group-access %}
|
||||
|
||||
{% endif %}
|
||||
## Automatically adding a self-hosted runner to a group
|
||||
|
||||
You can use the configuration script to automatically add a new self-hosted runner to a group. For example, this command registers a new self-hosted runner and uses the `--runnergroup` parameter to add it to a group named `rg-runnergroup`.
|
||||
@@ -118,18 +173,31 @@ Could not find any self-hosted runner group named "rg-runnergroup".
|
||||
## Moving a self-hosted runner to a group
|
||||
|
||||
If you don't specify a runner group during the registration process, your new self-hosted runners are automatically assigned to the default group, and can then be moved to another group.
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% data reusables.github-actions.self-hosted-runner-navigate-to-repo-org-enterprise %}
|
||||
1. In the "Runners" list, click the runner that you want to configure.
|
||||
1. Select the Runner group dropdown menu.
|
||||
1. In "Move runner to group", choose a destination group for the runner.
|
||||
{% endif %}
|
||||
{% ifversion ghae or ghes %}
|
||||
1. In the {% ifversion fpt %}"Runners"{% else %}"Self-hosted runners"{% endif %} section of the settings page, locate the current group of the runner you want to move and expand the list of group members.
|
||||

|
||||
1. Select the checkbox next to the self-hosted runner, and then click **Move to group** to see the available destinations.
|
||||

|
||||
1. To move the runner, click on the destination group.
|
||||

|
||||
|
||||
{% endif %}
|
||||
## Removing a self-hosted runner group
|
||||
|
||||
Self-hosted runners are automatically returned to the default group when their group is removed.
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% data reusables.github-actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %}
|
||||
1. In the list of groups, to the right of the group you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.
|
||||
1. To remove the group, click **Remove group**.
|
||||
1. Review the confirmation prompts, and click **Remove this runner group**.
|
||||
{% endif %}
|
||||
{% ifversion ghae or ghes %}
|
||||
1. In the {% ifversion fpt %}"Runners"{% else %}"Self-hosted runners"{% endif %} section of the settings page, locate the group you want to delete, and click the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} button.
|
||||

|
||||
|
||||
@@ -137,3 +205,4 @@ Self-hosted runners are automatically returned to the default group when their g
|
||||

|
||||
|
||||
1. Review the confirmation prompts, and click **Remove this runner group**.
|
||||
{% endif %}
|
||||
|
||||
@@ -27,8 +27,6 @@ shortTitle: Monitor & troubleshoot
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runners %}
|
||||
1. Under {% ifversion fpt %}"Runners"{% else %}"Self-hosted runners"{% endif %}, you can view a list of registered runners, including the runner's name, labels, and status.
|
||||
|
||||

|
||||
|
||||
The status can be one of the following:
|
||||
|
||||
* **Idle**: The runner is connected to {% data variables.product.product_name %} and is ready to execute jobs.
|
||||
|
||||
@@ -30,12 +30,20 @@ shortTitle: Remove self-hosted runners
|
||||
To remove a self-hosted runner from a user repository you must be the repository owner. For an organization repository, you must be an organization owner or have admin access to the repository. We recommend that you also have access to the self-hosted runner machine.
|
||||
|
||||
{% data reusables.github-actions.self-hosted-runner-reusing %}
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runners-updated %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runner-selection %}
|
||||
{% data reusables.github-actions.self-hosted-runner-removing-a-runner-updated %}
|
||||
{% endif %}
|
||||
{% ifversion ghae or ghes %}
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runners %}
|
||||
{% data reusables.github-actions.self-hosted-runner-removing-a-runner %}
|
||||
|
||||
{% endif %}
|
||||
## Removing a runner from an organization
|
||||
|
||||
{% note %}
|
||||
@@ -49,12 +57,20 @@ To remove a self-hosted runner from a user repository you must be the repository
|
||||
To remove a self-hosted runner from an organization, you must be an organization owner. We recommend that you also have access to the self-hosted runner machine.
|
||||
|
||||
{% data reusables.github-actions.self-hosted-runner-reusing %}
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% data reusables.organizations.navigate-to-org %}
|
||||
{% data reusables.organizations.org_settings %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runners-updated %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runner-selection %}
|
||||
{% data reusables.github-actions.self-hosted-runner-removing-a-runner-updated %}
|
||||
{% endif %}
|
||||
{% ifversion ghae or ghes %}
|
||||
{% data reusables.organizations.navigate-to-org %}
|
||||
{% data reusables.organizations.org_settings %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runners %}
|
||||
{% data reusables.github-actions.self-hosted-runner-removing-a-runner %}
|
||||
|
||||
{% endif %}
|
||||
## Removing a runner from an enterprise
|
||||
|
||||
{% note %}
|
||||
@@ -64,17 +80,22 @@ To remove a self-hosted runner from an organization, you must be an organization
|
||||
{% data reusables.github-actions.self-hosted-runner-auto-removal %}
|
||||
|
||||
{% endnote %}
|
||||
{% data reusables.github-actions.self-hosted-runner-reusing %}
|
||||
|
||||
{% ifversion fpt %}
|
||||
To remove a self-hosted runner from an enterprise account, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine.
|
||||
{% elsif ghes or ghae %}
|
||||
To remove a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be a site administrator. We recommend that you also have access to the self-hosted runner machine.
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-runners-tab %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runner-selection %}
|
||||
{% data reusables.github-actions.self-hosted-runner-removing-a-runner-updated %}
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.github-actions.self-hosted-runner-reusing %}
|
||||
|
||||
{% ifversion ghae or ghes %}
|
||||
To remove a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be a site administrator. We recommend that you also have access to the self-hosted runner machine.
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-runners-tab %}
|
||||
{% data reusables.github-actions.self-hosted-runner-removing-a-runner %}
|
||||
{% endif %}
|
||||
|
||||
@@ -19,7 +19,14 @@ For information on how to use labels to route jobs to specific types of self-hos
|
||||
{% data reusables.github-actions.self-hosted-runner-management-permissions-required %}
|
||||
|
||||
## Creating a custom label
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% data reusables.github-actions.self-hosted-runner-navigate-to-repo-org-enterprise %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runner-selection %}
|
||||
1. In the "Labels" section, click {% octicon "gear" aria-label="The Gear icon" %}.
|
||||
1. In the "Find or create a label" field, type the name of your new label and click **Create new label**.
|
||||
The custom label is created and assigned to the self-hosted runner. Custom labels can be removed from self-hosted runners, but they currently can't be manually deleted. {% data reusables.github-actions.actions-unused-labels %}
|
||||
{% endif %}
|
||||
{% ifversion ghae or ghes %}
|
||||
{% data reusables.github-actions.self-hosted-runner-navigate-to-repo-org-enterprise %}
|
||||
{% data reusables.github-actions.self-hosted-runner-list %}
|
||||
{% data reusables.github-actions.self-hosted-runner-list-group %}
|
||||
@@ -28,23 +35,35 @@ For information on how to use labels to route jobs to specific types of self-hos
|
||||

|
||||
|
||||
The custom label is created and assigned to the self-hosted runner. Custom labels can be removed from self-hosted runners, but they currently can't be manually deleted. {% data reusables.github-actions.actions-unused-labels %}
|
||||
|
||||
{% endif %}
|
||||
## Assigning a label to a self-hosted runner
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% data reusables.github-actions.self-hosted-runner-navigate-to-repo-org-enterprise %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runner-selection %}
|
||||
{% data reusables.github-actions.runner-label-settings %}
|
||||
1. To assign a label to your self-hosted runner, in the "Find or create a label" field, click the label.
|
||||
{% endif %}
|
||||
{% ifversion ghae or ghes %}
|
||||
{% data reusables.github-actions.self-hosted-runner-navigate-to-repo-org-enterprise %}
|
||||
{% data reusables.github-actions.self-hosted-runner-list %}
|
||||
{% data reusables.github-actions.self-hosted-runner-list-group %}
|
||||
{% data reusables.github-actions.self-hosted-runner-labels-view-assigned-labels %}
|
||||
1. Click on a label to assign it to your self-hosted runner.
|
||||
|
||||
{% endif %}
|
||||
## Removing a custom label from a self-hosted runner
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% data reusables.github-actions.self-hosted-runner-navigate-to-repo-org-enterprise %}
|
||||
{% data reusables.github-actions.settings-sidebar-actions-runner-selection %}
|
||||
{% data reusables.github-actions.runner-label-settings %}
|
||||
1. In the "Find or create a label" field, assigned labels are marked with the {% octicon "check" aria-label="The Check icon" %} icon. Click on a marked label to unassign it from your self-hosted runner.
|
||||
{% endif %}
|
||||
{% ifversion ghae or ghes %}
|
||||
{% data reusables.github-actions.self-hosted-runner-navigate-to-repo-org-enterprise %}
|
||||
{% data reusables.github-actions.self-hosted-runner-list %}
|
||||
{% data reusables.github-actions.self-hosted-runner-list-group %}
|
||||
{% data reusables.github-actions.self-hosted-runner-labels-view-assigned-labels %}
|
||||
1. Click on the assigned label to remove it from your self-hosted runner. {% data reusables.github-actions.actions-unused-labels %}
|
||||
|
||||
{% endif %}
|
||||
## Using the configuration script to create and assign labels
|
||||
|
||||
You can use the configuration script on the self-hosted runner to create and assign custom labels. For example, this command assigns a label named `gpu` to the self-hosted runner.
|
||||
|
||||
@@ -31,11 +31,7 @@ When creating a group, you must choose a policy that defines which repositories
|
||||
|
||||

|
||||
|
||||
1. Enter a name for your runner group, and assign a policy for repository access.
|
||||
|
||||
You can configure a runner group to be accessible to a specific list of repositories, or to all repositories in the organization. By default, only private repositories can access runners in a runner group, but you can override this.
|
||||

|
||||
|
||||
{% data reusables.github-actions.runner-group-assign-policy-repo %}
|
||||
1. Click **Save group** to create the group and apply the policy.
|
||||
|
||||
## Creating an {% data variables.actions.hosted_runner %} group for an enterprise
|
||||
@@ -54,11 +50,8 @@ When creating a group, you must choose a policy that defines which organizations
|
||||
|
||||

|
||||
|
||||
1. Enter a name for your runner group, and assign a policy for organization access.
|
||||
{% data reusables.github-actions.runner-group-assign-policy-org %}
|
||||
|
||||
You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise. By default, only private repositories can access runners in a runner group, but you can override this.
|
||||

|
||||
|
||||
1. Click **Save group** to create the group and apply the policy.
|
||||
|
||||
## Changing the access policy of an {% data variables.actions.hosted_runner %} group
|
||||
|
||||
@@ -1390,6 +1390,30 @@ This event occurs when someone triggers a workflow run on GitHub or sends a `POS
|
||||
{{ webhookPayloadsForCurrentVersion.workflow_dispatch }}
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.2 %}
|
||||
|
||||
## workflow_job
|
||||
|
||||
{% data reusables.webhooks.workflow_job_short_desc %}
|
||||
|
||||
### Availability
|
||||
|
||||
- Repository webhooks
|
||||
- Organization webhooks
|
||||
- Enterprise webhooks
|
||||
|
||||
### Webhook payload object
|
||||
|
||||
{% data reusables.webhooks.workflow_job_properties %}
|
||||
{% data reusables.webhooks.repo_desc %}
|
||||
{% data reusables.webhooks.org_desc %}
|
||||
{% data reusables.webhooks.sender_desc %}
|
||||
|
||||
### Webhook payload example
|
||||
|
||||
{{ webhookPayloadsForCurrentVersion.workflow_job }}
|
||||
|
||||
{% endif %}
|
||||
{% ifversion fpt or ghes > 2.22 %}
|
||||
## workflow_run
|
||||
|
||||
|
||||
@@ -18,6 +18,8 @@ After you enable SAML SSO, depending on the IdP you use, you may be able to enab
|
||||
|
||||
If you use Azure AD as your IDP, you can use team synchronization to manage team membership within each organization. {% data reusables.identity-and-permissions.about-team-sync %} For more information, see "[Managing team synchronization for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account)."
|
||||
|
||||
{% data reusables.saml.switching-from-org-to-enterprise %} For more information, see "[Switching your SAML configuration from an organization to an enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account)."
|
||||
|
||||
## Supported IdPs
|
||||
|
||||
We test and officially support the following IdPs. For SAML SSO, we offer limited support for all identity providers that implement the SAML 2.0 standard. For more information, see the [SAML Wiki](https://wiki.oasis-open.org/security) on the OASIS website.
|
||||
|
||||
@@ -21,6 +21,8 @@ You can control access to your enterprise account in {% data variables.product.p
|
||||
|
||||
SAML SSO controls and secures access to enterprise account resources like organizations, repositories, issues, and pull requests. For more information, see "[Enforcing SAML single sign-on for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/enforcing-saml-single-sign-on-for-organizations-in-your-enterprise-account)."
|
||||
|
||||
{% data reusables.saml.switching-from-org-to-enterprise %} For more information, see "[Switching your SAML configuration from an organization to an enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account)."
|
||||
|
||||
## Prerequisites
|
||||
|
||||
{% data reusables.saml.use-classic-ui %}
|
||||
|
||||
@@ -30,7 +30,7 @@ shortTitle: Enforce SAML
|
||||
|
||||
**Notes:**
|
||||
|
||||
- When you enable SAML SSO for your enterprise, the enterprise configuration will override any existing organization-level SAML configurations.
|
||||
- When you enable SAML SSO for your enterprise, the enterprise configuration will override any existing organization-level SAML configurations. {% data reusables.saml.switching-from-org-to-enterprise %} For more information, see "[Switching your SAML configuration from an organization to an enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account)."
|
||||
- When you enforce SAML SSO for an organization, {% data variables.product.company_short %} removes any members of the organization that have not authenticated successfully with your SAML IdP. When you require SAML SSO for your enterprise, {% data variables.product.company_short %} does not remove members of the enterprise that have not authenticated successfully with your SAML IdP. The next time a member accesses the enterprise's resources, the member must authenticate with your SAML IdP.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
@@ -11,6 +11,7 @@ children:
|
||||
- /enforcing-saml-single-sign-on-for-organizations-in-your-enterprise-account
|
||||
- /configuring-saml-single-sign-on-for-your-enterprise-account-using-okta
|
||||
- /managing-team-synchronization-for-organizations-in-your-enterprise-account
|
||||
- /switching-your-saml-configuration-from-an-organization-to-an-enterprise-account
|
||||
shortTitle: Configure IAM
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: Switching your SAML configuration from an organization to an enterprise account
|
||||
intro: 'Learn special considerations and best practices for replacing an organization-level SAML configuration with an enterprise-level SAML configuration.'
|
||||
product: '{% data reusables.gated-features.enterprise-accounts %}'
|
||||
permissions: Enterprise owners can configure SAML single sign-on for an enterprise account.
|
||||
versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- Enterprise
|
||||
shortTitle: Switching from organization
|
||||
---
|
||||
|
||||
## About SAML single sign-on for enterprise accounts
|
||||
|
||||
{% data reusables.saml.dotcom-saml-explanation %} {% data reusables.saml.about-saml-enterprise-accounts %}
|
||||
|
||||
{% data reusables.saml.switching-from-org-to-enterprise %}
|
||||
|
||||
When you configure SAML SSO at the organization level, each organization must be configured with a unique SSO tenant in your IdP, which means that your members will be associated with a unique SAML identity record for each organization they have succesfully authenticated with. If you configure SAML SSO for your enterprise account instead, each enterprise member will have one SAML identity that is used for all organizations owned by the enterprise account.
|
||||
|
||||
After you configure SAML SSO for your enterprise account, the new configuration will override any existing SAML SSO configurations for organizations owned by the enterprise account.
|
||||
|
||||
Enterprise members will not be notified when an enterprise owner enables SAML for the enterprise account. If SAML SSO was previously enforced at the organization level, members should not see a major difference when navigating directly to organization resources. The members will continue to be prompted to authenticate via SAML. If members navigate to organization resources via their IdP dashboard, they will need to click the new tile for the enterprise-level app, instead of the old tile for the organization-level app. The members will then be able to choose the organization to navigate to.
|
||||
|
||||
Any personal access tokens (PATs), SSH keys, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_github_apps %} that were previously authorized for the organization will continue to be authorized for the organization. However, members will need to authorize any PATs, SSH keys, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_github_apps %} that were never authorized for use with SAML SSO for the organization.
|
||||
|
||||
SCIM provisioning is not currently supported when SAML SSO is configured for an enterprise account. If you are currently using SCIM for an organization owned by your enterprise account, you will lose this functionality when switching to an enterprise-level configuration.
|
||||
|
||||
You are not required to remove any organization-level SAML configurations before configuring SAML SSO for your enterprise account, but you may want to consider doing so. If SAML is ever disabled for the enterprise account in the future, any remaining organization-level SAML configurations will take effect. Removing the organization-level configurations can prevent unexpected issues in the future.
|
||||
|
||||
## Switching your SAML configuration from an organization to an enterprise account
|
||||
|
||||
1. Enforce SAML SSO for your enterprise account, making sure all organization members are assigned or given access to the IdP app being used for the enterprise account. For more information, see "[Enforcing SAML single sign-on for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/enforcing-saml-single-sign-on-for-organizations-in-your-enterprise-account)."
|
||||
1. Optionally, remove any existing SAML configuration for organizations owned by the enterprise account. To help you decide whether to remove the configurations, see "[About SAML single sign-on for enterprise accounts](#about-saml-single-sign-on-for-enterprise-accounts)."
|
||||
1. If you kept any organization-level SAML configurations in place, to prevent confusion, consider hiding the tile for the organization-level apps in your IdP.
|
||||
1. Advise your enterprise members about the change.
|
||||
- Members will no longer be able to access their organizations by clicking the SAML app for the organization in the IdP dashboard. They will need to use the new app configured for the enterprise account.
|
||||
- Members will need to authorize any PATs or SSH keys that were not previously authorized for use with SAML SSO for their organization. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" and "[Authorizing an SSH key for use with SAML single sign-on](/github/authenticating-to-github/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)."
|
||||
- Members may need to reauthorize {% data variables.product.prodname_oauth_apps %} that were previously authorized for the organization. For more information, see "[About authentication with SAML single sign-on](/github/authenticating-to-github/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on#about-oauth-apps-and-saml-sso)."
|
||||
@@ -16,7 +16,7 @@ topics:
|
||||
---
|
||||
People with admin or owner permissions can set up a CODEOWNERS file in a repository.
|
||||
|
||||
The people you choose as code owners must have write permissions for the repository. When the code owner is a team, that team must have write permissions, even if all the individual members of the team already have write permissions directly, through organization membership, or through another team membership.
|
||||
The people you choose as code owners must have write permissions for the repository. When the code owner is a team, that team must be visible and it must have write permissions, even if all the individual members of the team already have write permissions directly, through organization membership, or through another team membership.
|
||||
|
||||
## About code owners
|
||||
|
||||
|
||||
@@ -191,16 +191,6 @@ $ curl -L 'https://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghes > 3.2 %}
|
||||
|
||||
## Git LFS
|
||||
|
||||
{% for operation in currentRestOperations %}
|
||||
{% if operation.subcategory == 'lfs' %}{% include rest_operation %}{% endif %}
|
||||
{% endfor %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghae or ghes %}
|
||||
## Organizations
|
||||
|
||||
|
||||
@@ -207,6 +207,16 @@ Use the API endpoint for adding a collaborator. For more information, see "[Add
|
||||
{% if operation.subcategory == 'invitations' %}{% include rest_operation %}{% endif %}
|
||||
{% endfor %}
|
||||
|
||||
{% ifversion fpt or ghae or ghes > 3.2 %}
|
||||
|
||||
## Git LFS
|
||||
|
||||
{% for operation in currentRestOperations %}
|
||||
{% if operation.subcategory == 'lfs' %}{% include rest_operation %}{% endif %}
|
||||
{% endfor %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Merging
|
||||
|
||||
The Repo Merging API supports merging branches in a repository. This accomplishes
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
1. Click the **Runner groups** tab.
|
||||
@@ -0,0 +1,3 @@
|
||||
1. Enter a name for your runner group, and assign a policy for organization access.
|
||||
|
||||
You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise. By default, only private repositories can access runners in a runner group, but you can override this. This setting can't be overridden if configuring an organization's runner group that was shared by an enterprise.
|
||||
@@ -0,0 +1,3 @@
|
||||
1. Enter a name for your runner group, and assign a policy for repository access.
|
||||
|
||||
You can configure a runner group to be accessible to a specific list of repositories, or to all repositories in the organization. By default, only private repositories can access runners in a runner group, but you can override this. This setting can't be overridden if configuring an organization's runner group that was shared by an enterprise.
|
||||
1
data/reusables/github-actions/runner-label-settings.md
Normal file
1
data/reusables/github-actions/runner-label-settings.md
Normal file
@@ -0,0 +1 @@
|
||||
1. In the "Labels" section, click {% octicon "gear" aria-label="The Gear icon" %}.
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
### Checking that your self-hosted runner was successfully added
|
||||
|
||||
After completing the steps to add a self-hosted runner, the runner and its status are now listed under "Self-hosted runners".
|
||||
After completing the steps to add a self-hosted runner, the runner and its status are now listed under {% ifversion fpt %}"Runners"{% elsif ghae or ghes %}"Self-hosted runners"{% endif %}.
|
||||
|
||||
The self-hosted runner application must be active for the runner to accept jobs. When the runner application is connected to {% data variables.product.product_name %} and ready to receive jobs, you will see the following message on machine's terminal.
|
||||
|
||||
|
||||
@@ -1,7 +1,4 @@
|
||||
1. Select the operating system and architecture of your self-hosted runner machine.
|
||||

|
||||
|
||||
|
||||
1. Select the operating system image and architecture of your self-hosted runner machine.
|
||||
1. You will see instructions showing you how to download the runner application and install it on your self-hosted runner machine.
|
||||
|
||||
Open a shell on your self-hosted runner machine and run each shell command in the order shown.
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
1. Click **Create group** to create the group and apply the policy.
|
||||
@@ -0,0 +1,10 @@
|
||||
1. Navigate to where your self-hosted runner groups are located:
|
||||
* **In an organization or repository**: navigate to the main page and click {% octicon "gear" aria-label="The Settings gear" %} **Settings**.
|
||||
* {% ifversion fpt %}**If using an enterprise account**: navigate to your enterprise account by visiting `https://github.com/enterprises/ENTERPRISE-NAME`, replacing `ENTERPRISE-NAME` with your enterprise account's name.{% elsif ghes or ghae %}**If using an enterprise-level runner**:
|
||||
|
||||
1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}.
|
||||
1. In the left sidebar, click **Enterprise overview**.
|
||||
1. {% endif %} In the enterprise sidebar, {% octicon "law" aria-label="The law icon" %} **Policies**.
|
||||
1. Navigate to the "Runner groups" settings:
|
||||
* **In an organization or repository**: Click **Actions** in the left sidebar{% ifversion fpt %}, then click **Runner groups** below it{% endif %}.
|
||||
* {% ifversion fpt %}**If using an enterprise account**:{% elsif ghes or ghae %}**If using an enterprise-level runner**:{% endif %} Click **Actions** under "{% octicon "law" aria-label="The law icon" %} Policies"{% ifversion fpt %}, then click the **Runners groups** tab{% endif %}.
|
||||
@@ -0,0 +1,12 @@
|
||||
1. Click **Remove**.
|
||||
1. You will see instructions for removing the self-hosted runner. Complete either of the following steps to remove the runner, depending on whether it is still accessible:
|
||||
|
||||
* **If you have access to the runner machine:** Follow the on-screen instructions for your machine's operating system to run the removal command. The instructions include the required URL and an automatically-generated, time-limited token.
|
||||
|
||||
The removal command does the following tasks:
|
||||
|
||||
* Removes the runner from {% data variables.product.product_name %}.
|
||||
* Removes any self-hosted runner application configuration files on the machine.
|
||||
* Removes any services configured if not running in interactive mode.
|
||||
|
||||
* **If you don't have access to the machine:** Click **Force remove this runner** to force {% data variables.product.product_name %} to remove the runner.
|
||||
@@ -0,0 +1 @@
|
||||
1. In the list of groups, click the runner group you'd like to configure.
|
||||
@@ -0,0 +1,2 @@
|
||||
1. In the left sidebar, click **Actions**.
|
||||
1. In the left sidebar, under "Actions", click **Runner groups**.
|
||||
@@ -0,0 +1 @@
|
||||
1. In the list of runners, click the runner you'd like to configure.
|
||||
@@ -0,0 +1 @@
|
||||
1. In the left sidebar, under "Actions", click **Runners**.
|
||||
@@ -0,0 +1 @@
|
||||
1. In the left sidebar, click **Actions**.
|
||||
1
data/reusables/saml/switching-from-org-to-enterprise.md
Normal file
1
data/reusables/saml/switching-from-org-to-enterprise.md
Normal file
@@ -0,0 +1 @@
|
||||
There are special considerations when enabling SAML SSO for your enterprise account if any of the organizations owned by the enterprise account are already configured to use SAML SSO.
|
||||
4
data/reusables/webhooks/workflow_job_properties.md
Normal file
4
data/reusables/webhooks/workflow_job_properties.md
Normal file
@@ -0,0 +1,4 @@
|
||||
Key | Type | Description
|
||||
----|------|-------------
|
||||
`action`|`string` | The action performed. Can be one of: <ul><li> `queued` - A new job was created.</li><li> `in_progress` - The job has started processing on the runner.</li><li> `completed` - The `status` of the job is `completed`.</li></ul>
|
||||
`workflow_job`|`object`| The workflow job. Many `workflow_job` keys, such as `head_sha`, `conclusion`, and `started_at` are the same as those in a [`check_run`](#check_run) object.
|
||||
1
data/reusables/webhooks/workflow_job_short_desc.md
Normal file
1
data/reusables/webhooks/workflow_job_short_desc.md
Normal file
@@ -0,0 +1 @@
|
||||
A {% data variables.product.prodname_actions %} workflow job has been queued, is in progress, or has been completed on a repository. {% data reusables.webhooks.action_type_desc %}
|
||||
@@ -8,11 +8,11 @@ import raw from 'rehype-raw'
|
||||
import slug from 'rehype-slug'
|
||||
import autolinkHeadings from 'rehype-autolink-headings'
|
||||
import highlight from 'rehype-highlight'
|
||||
import dockerfile from 'highlight.js/lib/languages/dockerfile.js'
|
||||
import http from 'highlight.js/lib/languages/http.js'
|
||||
import groovy from 'highlight.js/lib/languages/groovy.js'
|
||||
import erb from 'highlight.js/lib/languages/erb.js'
|
||||
import powershell from 'highlight.js/lib/languages/powershell.js'
|
||||
import dockerfile from 'highlight.js/lib/languages/dockerfile'
|
||||
import http from 'highlight.js/lib/languages/http'
|
||||
import groovy from 'highlight.js/lib/languages/groovy'
|
||||
import erb from 'highlight.js/lib/languages/erb'
|
||||
import powershell from 'highlight.js/lib/languages/powershell'
|
||||
import html from 'rehype-stringify'
|
||||
import HighlightjsGraphql from 'highlightjs-graphql'
|
||||
import remarkCodeExtra from 'remark-code-extra'
|
||||
|
||||
@@ -65384,13 +65384,13 @@
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/timeline",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/timeline</code></pre>"
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/timeline",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/timeline</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/timeline', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n mediaType: {\n previews: [\n 'mockingbird'\n ]\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'GET /repos/{owner}/{repo}/issues/{issue_number}/timeline'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">issue_number</span>: <span class=\"hljs-number\">42</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'mockingbird'</span>\n ]\n }\n})\n</code></pre>"
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/timeline', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'GET /repos/{owner}/{repo}/issues/{issue_number}/timeline'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">issue_number</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "List timeline events for an issue",
|
||||
@@ -65407,12 +65407,6 @@
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```",
|
||||
"html": "<p>The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-23-timeline-preview-api/\">blog post</a> for full details. To access the API you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.mockingbird-preview</code></pre>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
@@ -65444,11 +65438,6 @@
|
||||
"httpStatusCode": "410",
|
||||
"httpStatusMessage": "Gone",
|
||||
"description": "Gone"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
@@ -66491,6 +66480,149 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "put",
|
||||
"requestPath": "/repos/{owner}/{repo}/lfs",
|
||||
"serverUrl": "https://api.github.com",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/lfs",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/lfs</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('PUT /repos/{owner}/{repo}/lfs', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/lfs'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "Enable Git LFS for a repository",
|
||||
"description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.",
|
||||
"operationId": "repos/enable-lfs-for-repo",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository"
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": false,
|
||||
"previews": [],
|
||||
"category": "repos",
|
||||
"subcategory": "lfs"
|
||||
},
|
||||
"slug": "enable-git-lfs-for-a-repository",
|
||||
"category": "repos",
|
||||
"categoryLabel": "Repos",
|
||||
"subcategory": "lfs",
|
||||
"subcategoryLabel": "Lfs",
|
||||
"notes": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "202",
|
||||
"httpStatusMessage": "Accepted",
|
||||
"description": "Accepted"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "403",
|
||||
"httpStatusMessage": "Forbidden",
|
||||
"description": "We will return a 403 with one of the following messages:\n\n- Git LFS support not enabled because Git LFS is globally disabled.\n- Git LFS support not enabled because Git LFS is disabled for the root repository in the network.\n- Git LFS support not enabled because Git LFS is disabled for <owner>."
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> The Git LFS API endpoints are currently in beta and are subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/lfs",
|
||||
"serverUrl": "https://api.github.com",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/lfs",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/lfs</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/lfs', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'DELETE /repos/{owner}/{repo}/lfs'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "Disable Git LFS for a repository",
|
||||
"description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.",
|
||||
"operationId": "repos/disable-lfs-for-repo",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository"
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": false,
|
||||
"previews": [],
|
||||
"category": "repos",
|
||||
"subcategory": "lfs"
|
||||
},
|
||||
"slug": "disable-git-lfs-for-a-repository",
|
||||
"category": "repos",
|
||||
"categoryLabel": "Repos",
|
||||
"subcategory": "lfs",
|
||||
"subcategoryLabel": "Lfs",
|
||||
"notes": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"httpStatusMessage": "No Content",
|
||||
"description": "Response"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> The Git LFS API endpoints are currently in beta and are subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/license",
|
||||
|
||||
@@ -42967,12 +42967,6 @@
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```",
|
||||
"html": "<p>The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-23-timeline-preview-api/\">blog post</a> for full details. To access the API you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.mockingbird-preview</code></pre>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and 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.starfox-preview+json\n```",
|
||||
"html": "<p>Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the <a href=\"https://developer.github.com/changes/2018-09-05-project-card-events\">blog post</a>.</p>\n<p>To receive the <code>project_card</code> attribute, project boards must be <a href=\"https://help.github.com/articles/disabling-project-boards-in-a-repository\">enabled</a> for a repository, and you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.starfox-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
@@ -42999,11 +42993,6 @@
|
||||
"httpStatusCode": "410",
|
||||
"httpStatusMessage": "Gone",
|
||||
"description": "Gone"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
|
||||
@@ -43665,12 +43665,6 @@
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```",
|
||||
"html": "<p>The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-23-timeline-preview-api/\">blog post</a> for full details. To access the API you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.mockingbird-preview</code></pre>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and 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.starfox-preview+json\n```",
|
||||
"html": "<p>Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the <a href=\"https://developer.github.com/changes/2018-09-05-project-card-events\">blog post</a>.</p>\n<p>To receive the <code>project_card</code> attribute, project boards must be <a href=\"https://help.github.com/articles/disabling-project-boards-in-a-repository\">enabled</a> for a repository, and you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.starfox-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
@@ -43697,11 +43691,6 @@
|
||||
"httpStatusCode": "410",
|
||||
"httpStatusMessage": "Gone",
|
||||
"description": "Gone"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
|
||||
@@ -44146,12 +44146,6 @@
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```",
|
||||
"html": "<p>The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-23-timeline-preview-api/\">blog post</a> for full details. To access the API you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.mockingbird-preview</code></pre>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and 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.starfox-preview+json\n```",
|
||||
"html": "<p>Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the <a href=\"https://developer.github.com/changes/2018-09-05-project-card-events\">blog post</a>.</p>\n<p>To receive the <code>project_card</code> attribute, project boards must be <a href=\"https://help.github.com/articles/disabling-project-boards-in-a-repository\">enabled</a> for a repository, and you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.starfox-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
@@ -44178,11 +44172,6 @@
|
||||
"httpStatusCode": "410",
|
||||
"httpStatusMessage": "Gone",
|
||||
"description": "Gone"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
|
||||
@@ -48140,12 +48140,6 @@
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```",
|
||||
"html": "<p>The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-23-timeline-preview-api/\">blog post</a> for full details. To access the API you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.mockingbird-preview</code></pre>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and 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.starfox-preview+json\n```",
|
||||
"html": "<p>Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the <a href=\"https://developer.github.com/changes/2018-09-05-project-card-events\">blog post</a>.</p>\n<p>To receive the <code>project_card</code> attribute, project boards must be <a href=\"https://help.github.com/articles/disabling-project-boards-in-a-repository\">enabled</a> for a repository, and you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.starfox-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
@@ -48172,11 +48166,6 @@
|
||||
"httpStatusCode": "410",
|
||||
"httpStatusMessage": "Gone",
|
||||
"description": "Gone"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
|
||||
@@ -55914,12 +55914,6 @@
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```",
|
||||
"html": "<p>The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-23-timeline-preview-api/\">blog post</a> for full details. To access the API you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.mockingbird-preview</code></pre>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and 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.starfox-preview+json\n```",
|
||||
"html": "<p>Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the <a href=\"https://developer.github.com/changes/2018-09-05-project-card-events\">blog post</a>.</p>\n<p>To receive the <code>project_card</code> attribute, project boards must be <a href=\"https://help.github.com/articles/disabling-project-boards-in-a-repository\">enabled</a> for a repository, and you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.starfox-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
@@ -55946,11 +55940,6 @@
|
||||
"httpStatusCode": "410",
|
||||
"httpStatusMessage": "Gone",
|
||||
"description": "Gone"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
|
||||
@@ -60715,12 +60715,6 @@
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```",
|
||||
"html": "<p>The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-23-timeline-preview-api/\">blog post</a> for full details. To access the API you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.0/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.mockingbird-preview</code></pre>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and 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.starfox-preview+json\n```",
|
||||
"html": "<p>Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the <a href=\"https://developer.github.com/changes/2018-09-05-project-card-events\">blog post</a>.</p>\n<p>To receive the <code>project_card</code> attribute, project boards must be <a href=\"https://help.github.com/articles/disabling-project-boards-in-a-repository\">enabled</a> for a repository, and you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.0/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.starfox-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
@@ -60747,11 +60741,6 @@
|
||||
"httpStatusCode": "410",
|
||||
"httpStatusMessage": "Gone",
|
||||
"description": "Gone"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
|
||||
@@ -61405,12 +61405,6 @@
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```",
|
||||
"html": "<p>The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-23-timeline-preview-api/\">blog post</a> for full details. To access the API you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.mockingbird-preview</code></pre>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and 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.starfox-preview+json\n```",
|
||||
"html": "<p>Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the <a href=\"https://developer.github.com/changes/2018-09-05-project-card-events\">blog post</a>.</p>\n<p>To receive the <code>project_card</code> attribute, project boards must be <a href=\"https://help.github.com/articles/disabling-project-boards-in-a-repository\">enabled</a> for a repository, and you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.starfox-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
@@ -61437,11 +61431,6 @@
|
||||
"httpStatusCode": "410",
|
||||
"httpStatusMessage": "Gone",
|
||||
"description": "Gone"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
|
||||
@@ -63621,12 +63621,6 @@
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```",
|
||||
"html": "<p>The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-23-timeline-preview-api/\">blog post</a> for full details. To access the API you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.mockingbird-preview</code></pre>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```",
|
||||
"html": "<p>Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the <a href=\"https://developer.github.com/changes/2018-09-05-project-card-events\">blog post</a>.</p>\n<p>To receive the <code>project_card</code> attribute, project boards must be <a href=\"https://help.github.com/articles/disabling-project-boards-in-a-repository\">enabled</a> for a repository, and you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.starfox-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
@@ -63653,11 +63647,6 @@
|
||||
"httpStatusCode": "410",
|
||||
"httpStatusMessage": "Gone",
|
||||
"description": "Gone"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
|
||||
@@ -54856,13 +54856,13 @@
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline</code></pre>"
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/timeline', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n mediaType: {\n previews: [\n 'mockingbird'\n ]\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'GET /repos/{owner}/{repo}/issues/{issue_number}/timeline'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">issue_number</span>: <span class=\"hljs-number\">42</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'mockingbird'</span>\n ]\n }\n})\n</code></pre>"
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/timeline', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'GET /repos/{owner}/{repo}/issues/{issue_number}/timeline'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">issue_number</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "List timeline events for an issue",
|
||||
@@ -54879,12 +54879,6 @@
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```",
|
||||
"html": "<p>The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-23-timeline-preview-api/\">blog post</a> for full details. To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.mockingbird-preview</code></pre>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
@@ -54916,11 +54910,6 @@
|
||||
"httpStatusCode": "410",
|
||||
"httpStatusMessage": "Gone",
|
||||
"description": "Gone"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
@@ -56000,25 +55989,25 @@
|
||||
}
|
||||
],
|
||||
"summary": "Enable Git LFS for a repository",
|
||||
"description": "",
|
||||
"operationId": "enterprise-admin/enable-lfs-for-repo",
|
||||
"description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.",
|
||||
"operationId": "repos/enable-lfs-for-repo",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
"repos"
|
||||
],
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#enable-git-lfs-for-a-repository"
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#enable-git-lfs-for-a-repository"
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": false,
|
||||
"previews": [],
|
||||
"category": "enterprise-admin",
|
||||
"category": "repos",
|
||||
"subcategory": "lfs"
|
||||
},
|
||||
"slug": "enable-git-lfs-for-a-repository",
|
||||
"category": "enterprise-admin",
|
||||
"categoryLabel": "Enterprise admin",
|
||||
"category": "repos",
|
||||
"categoryLabel": "Repos",
|
||||
"subcategory": "lfs",
|
||||
"subcategoryLabel": "Lfs",
|
||||
"notes": [],
|
||||
@@ -56035,7 +56024,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": ""
|
||||
"descriptionHTML": "<p><strong>Note:</strong> The Git LFS API endpoints are currently in beta and are subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
@@ -56074,25 +56063,25 @@
|
||||
}
|
||||
],
|
||||
"summary": "Disable Git LFS for a repository",
|
||||
"description": "",
|
||||
"operationId": "enterprise-admin/disable-lfs-for-repo",
|
||||
"description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.",
|
||||
"operationId": "repos/disable-lfs-for-repo",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
"repos"
|
||||
],
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#disable-git-lfs-for-a-repository"
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#disable-git-lfs-for-a-repository"
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": false,
|
||||
"previews": [],
|
||||
"category": "enterprise-admin",
|
||||
"category": "repos",
|
||||
"subcategory": "lfs"
|
||||
},
|
||||
"slug": "disable-git-lfs-for-a-repository",
|
||||
"category": "enterprise-admin",
|
||||
"categoryLabel": "Enterprise admin",
|
||||
"category": "repos",
|
||||
"categoryLabel": "Repos",
|
||||
"subcategory": "lfs",
|
||||
"subcategoryLabel": "Lfs",
|
||||
"notes": [],
|
||||
@@ -56104,7 +56093,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": ""
|
||||
"descriptionHTML": "<p><strong>Note:</strong> The Git LFS API endpoints are currently in beta and are subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
|
||||
@@ -278568,39 +278568,12 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
@@ -279975,6 +279948,106 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/repos/{owner}/{repo}/lfs": {
|
||||
"put": {
|
||||
"summary": "Enable Git LFS for a repository",
|
||||
"description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.",
|
||||
"operationId": "repos/enable-lfs-for-repo",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"202": {
|
||||
"description": "Accepted",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "We will return a 403 with one of the following messages:\n\n- Git LFS support not enabled because Git LFS is globally disabled.\n- Git LFS support not enabled because Git LFS is disabled for the root repository in the network.\n- Git LFS support not enabled because Git LFS is disabled for <owner>."
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": false,
|
||||
"previews": [
|
||||
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "lfs"
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Disable Git LFS for a repository",
|
||||
"description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.",
|
||||
"operationId": "repos/disable-lfs-for-repo",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "Response"
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": false,
|
||||
"previews": [
|
||||
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "lfs"
|
||||
}
|
||||
}
|
||||
},
|
||||
"/repos/{owner}/{repo}/license": {
|
||||
"get": {
|
||||
"summary": "Get the license for a repository",
|
||||
|
||||
@@ -196052,28 +196052,6 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
@@ -196084,11 +196062,6 @@
|
||||
"required": true,
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and 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.starfox-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
|
||||
@@ -199578,28 +199578,6 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
@@ -199610,11 +199588,6 @@
|
||||
"required": true,
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and 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.starfox-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
|
||||
@@ -202026,28 +202026,6 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
@@ -202058,11 +202036,6 @@
|
||||
"required": true,
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and 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.starfox-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
|
||||
@@ -214453,28 +214453,6 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
@@ -214485,11 +214463,6 @@
|
||||
"required": true,
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and 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.starfox-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
|
||||
@@ -246234,28 +246234,6 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
@@ -246266,11 +246244,6 @@
|
||||
"required": true,
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and 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.starfox-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
|
||||
@@ -253066,28 +253066,6 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
@@ -253098,11 +253076,6 @@
|
||||
"required": true,
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and 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.starfox-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
|
||||
@@ -256038,28 +256038,6 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
@@ -256070,11 +256048,6 @@
|
||||
"required": true,
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and 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.starfox-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
|
||||
@@ -262850,28 +262850,6 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
@@ -262882,11 +262860,6 @@
|
||||
"required": true,
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
"note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "issues",
|
||||
|
||||
@@ -226899,39 +226899,12 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "mockingbird",
|
||||
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API 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.mockingbird-preview\n```"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
"name": "starfox",
|
||||
@@ -228309,14 +228282,14 @@
|
||||
"/repos/{owner}/{repo}/lfs": {
|
||||
"put": {
|
||||
"summary": "Enable Git LFS for a repository",
|
||||
"description": "",
|
||||
"operationId": "enterprise-admin/enable-lfs-for-repo",
|
||||
"description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.",
|
||||
"operationId": "repos/enable-lfs-for-repo",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
"repos"
|
||||
],
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#enable-git-lfs-for-a-repository"
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#enable-git-lfs-for-a-repository"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
@@ -228357,20 +228330,20 @@
|
||||
"previews": [
|
||||
|
||||
],
|
||||
"category": "enterprise-admin",
|
||||
"category": "repos",
|
||||
"subcategory": "lfs"
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Disable Git LFS for a repository",
|
||||
"description": "",
|
||||
"operationId": "enterprise-admin/disable-lfs-for-repo",
|
||||
"description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.",
|
||||
"operationId": "repos/disable-lfs-for-repo",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
"repos"
|
||||
],
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#disable-git-lfs-for-a-repository"
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#disable-git-lfs-for-a-repository"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
@@ -228401,7 +228374,7 @@
|
||||
"previews": [
|
||||
|
||||
],
|
||||
"category": "enterprise-admin",
|
||||
"category": "repos",
|
||||
"subcategory": "lfs"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:e3032be3c279897383425d4ef8bd965cdd60765f9f1d1e377f68da5262eeddab
|
||||
size 506660
|
||||
oid sha256:f50ee22894c3c152b7848b352b30f5cd0abd31d332bda2356ee553ab0573d08c
|
||||
size 506669
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:380a763e02200ab664a6e4d74b911d96783b7858e4e9ec8ef88b20499f9e0373
|
||||
size 801995
|
||||
oid sha256:93b376c6c8a00db64894387cf01797a88426da37a9291e8beaece4ecc99727e8
|
||||
size 802134
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:b96a355c778c1797782e671d3e98ebc03a6d91336b089cfeee8a5c4f065be52b
|
||||
size 469335
|
||||
oid sha256:726fd6ef337c3e410dbe78c485a12ed055516f269d7977b81ef465cca091389b
|
||||
size 469401
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:7ba4532b23c952b946546874ca37e7589e0ba10071d2d838109b299280c74872
|
||||
size 2076738
|
||||
oid sha256:a47cfe086304ebff58931daf26faa1479258325117cad9f8bea53ee289fe39b7
|
||||
size 2077093
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:dcd6d3cb83fce94d00a9e78b5cd2695565d26e8c6f5a7f877cf3d2845dd60034
|
||||
size 430919
|
||||
oid sha256:907dedfdb60f776f8c55d33467a53a91732f3f051063b14a6adbd83337eea252
|
||||
size 430428
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:bbedebbeb6f0bb3655f6626e67aeffe938557a1b0b775ef76113146de6bf7d21
|
||||
size 1681139
|
||||
oid sha256:4d9c2679718670fc03e2f6577522a8521e6aaa33be8b3396532ae58973dde5d9
|
||||
size 1681920
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:65d6a978a6bf23db32e39eec4e3f43bfddeb34ddf7ec601608707d961add2d60
|
||||
size 279972
|
||||
oid sha256:adce3f50e7fc02058aa3c1ad08519b0465f6aad6ed09a28a4350bbb5da42ce1b
|
||||
size 280209
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:331568c0732332b4b5a8ebd1dfc51a0e877a7b9e7b648999c361e11a91c39656
|
||||
size 1066658
|
||||
oid sha256:c441bb092459e109c62476ea897860d7c2ae5433abf0837ccd7479095aea5bb3
|
||||
size 1066280
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:5baa3649eed7f1e74d359dda7127b11ac75697d885d8ba9313e91b73e5741e24
|
||||
size 528542
|
||||
oid sha256:79909e29949a5ea4aa188633a631b4a5914b67a428edbe9de2e17720aee03597
|
||||
size 528713
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:7e577b6c30684621ac242249568ad494bc43a86e05375ef76ff12f6f66130e0a
|
||||
size 2796981
|
||||
oid sha256:94f6995aeec10d93c86fccc30c60732e01143587129ee2271b78aaf564c0f02c
|
||||
size 2796443
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:41ab99b846559718b69d12a0506c26cb9c1eb60bf10eb833ea8b0e1bd03f6125
|
||||
size 443182
|
||||
oid sha256:6ec33bcac8ac2a4bb532369870fe0e43d08cb72e29c859b9086332938d2b9a7b
|
||||
size 443093
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:3a62338633e82e8bef850f9b7db1c22874fa8d278ce7e28812602c4852b57d58
|
||||
size 1850199
|
||||
oid sha256:b77fa94ac0ef9b48b81d35dbc41707645a82bc51a48f7ff03ad0f560ea6d6107
|
||||
size 1849893
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:563dde49bdf7bf393fe0c922c712f39a6534f310ac143783a85607862eacde0a
|
||||
size 524518
|
||||
oid sha256:c65ece089c4c5777d7ea0eef7cc414ecda970eeba9d445270dfae54ec02813c3
|
||||
size 524481
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:ad99140460f917c11c9a273ce705359fd74553667d5d489a866984a5b7c1ff3d
|
||||
size 834145
|
||||
oid sha256:7a78683fb95c080c629f1cd038d7b0b47063acda8783d396fb5d48cfdeb6fa6b
|
||||
size 833304
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:af874ba2bffe716a36312469126a670c0de06040fd4b3137e41922073424d980
|
||||
size 490084
|
||||
oid sha256:9d5c834afd57550e8e9cd2aeca3c1cb27b3ab6cd90194ed47a81c4d9a118402b
|
||||
size 490124
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:ede9400fcc8ce2378fb6473395561bc67ea5a63ba0ad841c01712f1a954a9092
|
||||
size 2178149
|
||||
oid sha256:4bfb698536710b31a085522fc42d889f4190f18fa58f679c196852193d87d572
|
||||
size 2177670
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:7528c91f801722d576a8812c99eaad05fdee55aa30fd73526f3f1a695a1db668
|
||||
size 450559
|
||||
oid sha256:ca4e482cfe6b12487057b869bd316f86fcec2ad3d358311f3be5a8362f0a8362
|
||||
size 450609
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:41d93662a124a77ccb31f95d2ce7103a1ab5c4a34dab9e078f8001d1b99b10b2
|
||||
size 1755097
|
||||
oid sha256:c42711dc9b05cf8b91a299c6ac8105e242c368d6bb0dc2a28765c6cc93cca44c
|
||||
size 1755236
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:da8b8444dfe1e29d3993f4c773ffab20821f692ad4a87ad25b5118cb54fd2adc
|
||||
size 278133
|
||||
oid sha256:560544596725d7c56af6d45df16da4c2f596ef85543fc307c583261a6fef8a04
|
||||
size 278213
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:6ca1d8a3ea7b2e45ea1f62aa434cc0d2145662a1d979f874dbc36ec64cb1b2f9
|
||||
size 1054929
|
||||
oid sha256:eedfc63ac2c08ca9307628337e29e8c9efab25a27a71d7db653f2165b08d8257
|
||||
size 1055136
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:12aebcd09965253adf15d836265542a795552191b3481db7263ace81c0ff712a
|
||||
size 549880
|
||||
oid sha256:9189bdbdb15623b459313d6f1cec8ae010368079b345cfb95da3b4835e727288
|
||||
size 550010
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:18939b606894e9c535b3cd9eb778260d77c95cfc878d3fb1e2205c46156c1a9b
|
||||
size 2909638
|
||||
oid sha256:8e212059f730f559c3be7eebdbac308ed391f91700e55691a1e6fa24b803b610
|
||||
size 2911165
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:fa26937152186bc3aa79dd311872e586def281559ce73bc9cc1150ca4bdbdb89
|
||||
size 464415
|
||||
oid sha256:db10600531d14e8fbdd487034e1778faf60eba1cc03b3691edd0814e30666f53
|
||||
size 464491
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:c1341a8ae85d65dd80222bc13c89e1ecddaa161c90b745f036a984bbe20e7d8c
|
||||
size 1936477
|
||||
oid sha256:ed8a047f231abe94f3bc13dce06a823aee7650eff019221f26f234f4d5c93715
|
||||
size 1936075
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:1a22be3135e1f0019acd62d8391dd08b614c0aa5dcccc5dd1cd1954e4c89cd0c
|
||||
size 533843
|
||||
oid sha256:db28e98bca5d5fbeed6cd04ee081381cf8f5a3f5d1cb36f5051598b07f904d56
|
||||
size 533820
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:4a8e34aecb80b3ff6095796db66734f9f495c9791beddaf359b66c0d05e553e5
|
||||
size 845610
|
||||
oid sha256:4fac4b0e486c0990c36c7716510e946afae5e21510ce935e82bef58024e21c53
|
||||
size 845942
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:b2d70f43861bf1014114fd3a2bdfc016ecc45d0a423620d5b3cef95042f55450
|
||||
size 497070
|
||||
oid sha256:6091ebc6913e5acabfe5f720a5ab3df24c4ba4eeaacc1900580df65765caa720
|
||||
size 497115
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:25c88438d5ef4477c7b3791113ecd4c6879aa0b80b03c0f866f364c4c6b17b91
|
||||
size 2219916
|
||||
oid sha256:9a622569acfdf938c97e66085765e10fe02ae7492d27f7ef0afede575af41e69
|
||||
size 2219544
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user