зеркало из https://github.com/github/docs.git
Support GHAE internal-only semantic versioning (#29178)
Co-authored-by: Peter Bengtsson <mail@peterbe.com> Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
This commit is contained in:
Sarah Schneider
GitHub
Родитель
eeda4f2930
Коммит
b7f48ea2c1
|
|
@ -54,7 +54,7 @@ export type ProductLandingContextT = {
|
|||
whatsNewChangelog?: Array<{ href: string; title: string; date: string }>
|
||||
tocItems: Array<TocItem>
|
||||
hasGuidesPage: boolean
|
||||
releases: Array<{
|
||||
ghesReleases: Array<{
|
||||
version: string
|
||||
firstPreviousRelease: string
|
||||
secondPreviousRelease: string
|
||||
|
|
@ -115,7 +115,7 @@ export const getProductLandingContextFromRequest = (req: any): ProductLandingCon
|
|||
changelogUrl: req.context.changelogUrl || [],
|
||||
productCodeExamples: req.context.productCodeExamples || [],
|
||||
productCommunityExamples: req.context.productCommunityExamples || [],
|
||||
releases: req.context.releases || [],
|
||||
ghesReleases: req.context.ghesReleases || [],
|
||||
|
||||
productUserExamples: (req.context.productUserExamples || []).map(
|
||||
({ user, description }: any) => ({
|
||||
|
|
|
|||
|
|
@ -9,12 +9,12 @@ export function ProductReleases() {
|
|||
const { t } = useTranslation('product_landing')
|
||||
const router = useRouter()
|
||||
const { enterpriseServerReleases, allVersions } = useMainContext()
|
||||
const { releases, shortTitle } = useProductLandingContext()
|
||||
const { ghesReleases, shortTitle } = useProductLandingContext()
|
||||
const currentPath = router.asPath.split('?')[0]
|
||||
return (
|
||||
<div>
|
||||
<div className="d-lg-flex gutter-lg flex-items-stretch">
|
||||
{releases.map((release) => {
|
||||
{ghesReleases.map((release) => {
|
||||
const releaseNumber = release.version
|
||||
if (!enterpriseServerReleases.supported.includes(releaseNumber)) {
|
||||
return null
|
||||
|
|
|
|||
|
|
@ -1,15 +1,16 @@
|
|||
import { useRef, useEffect } from 'react'
|
||||
import dayjs from 'dayjs'
|
||||
import cx from 'classnames'
|
||||
|
||||
import { useTranslation } from 'components/hooks/useTranslation'
|
||||
import { useOnScreen } from 'components/hooks/useOnScreen'
|
||||
import { PatchNotes } from './PatchNotes'
|
||||
import { ReleaseNotePatch } from './types'
|
||||
import { CurrentVersion, ReleaseNotePatch } from './types'
|
||||
|
||||
import styles from './PatchNotes.module.scss'
|
||||
|
||||
type Props = { patch: ReleaseNotePatch; didEnterView: () => void }
|
||||
export function GHAEReleaseNotePatch({ patch, didEnterView }: Props) {
|
||||
type Props = { patch: ReleaseNotePatch; currentVersion: CurrentVersion; didEnterView: () => void }
|
||||
export function GHAEReleaseNotePatch({ patch, currentVersion, didEnterView }: Props) {
|
||||
const { t } = useTranslation('release_notes')
|
||||
const containerRef = useRef<HTMLDivElement>(null)
|
||||
const onScreen = useOnScreen(containerRef, { rootMargin: '-40% 0px -50%' })
|
||||
|
|
@ -25,11 +26,13 @@ export function GHAEReleaseNotePatch({ patch, didEnterView }: Props) {
|
|||
<div
|
||||
ref={containerRef}
|
||||
className={cx(styles.sectionHeading, 'mb-10 pb-6 border-bottom border-top')}
|
||||
id={patch.date}
|
||||
id={patch.release}
|
||||
>
|
||||
<header style={{ zIndex: 1 }} className="container-xl border-bottom px-3 pt-4 pb-2">
|
||||
<div className="d-flex flex-items-center">
|
||||
<h2 className="border-bottom-0 m-0 p-0">{patch.title}</h2>
|
||||
<h2 className="border-bottom-0 m-0 p-0">
|
||||
{currentVersion.versionTitle} {patch.release}
|
||||
</h2>
|
||||
|
||||
{patch.release_candidate && (
|
||||
<span
|
||||
|
|
@ -41,7 +44,7 @@ export function GHAEReleaseNotePatch({ patch, didEnterView }: Props) {
|
|||
)}
|
||||
</div>
|
||||
<p className="color-fg-muted mt-1">
|
||||
{bannerText} {patch.friendlyDate}.
|
||||
{bannerText} {dayjs(patch.date).format('MMMM DD, YYYY')}.
|
||||
</p>
|
||||
</header>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
import { SyntheticEvent, useState } from 'react'
|
||||
import { useState } from 'react'
|
||||
import cx from 'classnames'
|
||||
import { ChevronDownIcon } from '@primer/octicons-react'
|
||||
import dayjs from 'dayjs'
|
||||
import { GHAEReleaseNotePatch } from './GHAEReleaseNotePatch'
|
||||
import { GHAEReleaseNotesContextT } from './types'
|
||||
import { MarkdownContent } from 'components/ui/MarkdownContent'
|
||||
|
|
@ -29,6 +29,7 @@ export function GHAEReleaseNotes({ context }: GitHubAEProps) {
|
|||
<GHAEReleaseNotePatch
|
||||
key={patch.version}
|
||||
patch={patch}
|
||||
currentVersion={currentVersion}
|
||||
didEnterView={() => setFocusedPatch(patch.version)}
|
||||
/>
|
||||
)
|
||||
|
|
@ -69,50 +70,26 @@ const CollapsibleReleaseSection = ({
|
|||
release: GHAEReleaseNotesContextT['releases'][0]
|
||||
focusedPatch: string
|
||||
}) => {
|
||||
const defaultIsOpen = true
|
||||
const [isOpen, setIsOpen] = useState(defaultIsOpen)
|
||||
|
||||
const onToggle = (e: SyntheticEvent) => {
|
||||
const newIsOpen = (e.target as HTMLDetailsElement).open
|
||||
setIsOpen(newIsOpen)
|
||||
}
|
||||
|
||||
return (
|
||||
<li key={release.version} className="border-bottom">
|
||||
<details
|
||||
className="my-0 details-reset release-notes-version-picker"
|
||||
aria-current="page"
|
||||
open={defaultIsOpen}
|
||||
onToggle={onToggle}
|
||||
>
|
||||
<summary className="px-3 py-4 my-0 d-flex flex-items-center flex-justify-between outline-none">
|
||||
{release.version}
|
||||
<div className="d-flex">
|
||||
<span className="color-fg-muted text-small text-normal mr-1">
|
||||
{release.patches.length} {release.patches.length === 1 ? 'release' : 'releases'}
|
||||
</span>
|
||||
<ChevronDownIcon className={isOpen ? 'rotate-180' : ''} />
|
||||
</div>
|
||||
</summary>
|
||||
<ul className="color-bg-subtle border-top list-style-none py-4 px-0 my-0">
|
||||
{release.patches.map((patch) => {
|
||||
const isActive = patch.version === focusedPatch
|
||||
return (
|
||||
<li
|
||||
key={patch.version}
|
||||
className={cx('px-3 my-0 py-1', isActive && 'color-bg-accent')}
|
||||
<ul className="list-style-none py-4 px-0 my-0">
|
||||
{release.patches.map((patch) => {
|
||||
const isActive = patch.release === focusedPatch
|
||||
return (
|
||||
<li key={patch.release} className={cx('px-3 my-0', isActive && 'color-bg-accent')}>
|
||||
<a
|
||||
href={`#${patch.release}`}
|
||||
className="d-flex flex-items-center flex-justify-between"
|
||||
>
|
||||
<a
|
||||
href={`#${patch.date}`}
|
||||
className="d-flex flex-items-center flex-justify-between"
|
||||
>
|
||||
{patch.friendlyDate}
|
||||
</a>
|
||||
</li>
|
||||
)
|
||||
})}
|
||||
</ul>
|
||||
</details>
|
||||
{patch.release}
|
||||
<span className="color-fg-muted text-mono text-small text-normal">
|
||||
{dayjs(patch.date).format('MMMM DD, YYYY')}
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
)
|
||||
})}
|
||||
</ul>
|
||||
</li>
|
||||
)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -92,7 +92,8 @@ export function GHESReleaseNotes({ context }: Props) {
|
|||
>
|
||||
{release.version}
|
||||
<span className="color-fg-muted text-small text-normal mr-1">
|
||||
{release.patches.length} releases
|
||||
{release.patches.length}{' '}
|
||||
{release.patches.length === 1 ? 'release' : 'releases'}
|
||||
</span>
|
||||
</Link>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -22,6 +22,7 @@ export type ReleaseNotePatch = {
|
|||
patchVersion: string
|
||||
version: string
|
||||
downloadVersion: string
|
||||
release: string
|
||||
intro: string
|
||||
date: string
|
||||
friendlyDate: string
|
||||
|
|
@ -39,8 +40,6 @@ export type GHAEReleaseNotesContextT = {
|
|||
|
||||
export type GHESReleaseNotesContextT = {
|
||||
latestPatch: string
|
||||
prevRelease?: string
|
||||
nextRelease?: string
|
||||
latestRelease: string
|
||||
currentVersion: CurrentVersion
|
||||
releaseNotes: Array<ReleaseNotePatch>
|
||||
|
|
|
|||
|
|
@ -72,7 +72,7 @@ When you unwatch a repository, you unsubscribe from future updates from that rep
|
|||
- Ignore all notifications for a repository
|
||||
- If enabled, customize the types of event you receive notifications for ({% data reusables.notifications-v2.custom-notification-types %})
|
||||
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5819 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
1. Optionally, to unsubscribe from all repositories owned by a given user or organization, select the **Unwatch all** dropdown and click the organization whose repositories you'd like to unsubscribe from. The button to unwatch all repositories is only available if you are watching all activity or custom notifications on over 10 repositories.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -141,7 +141,7 @@ Email notifications from {% data variables.product.product_location %} contain t
|
|||
- There are updates in repositories or team discussions you're watching or in a conversation you're participating in. For more information, see "[About participating and watching notifications](#about-participating-and-watching-notifications)."
|
||||
- You gain access to a new repository or you've joined a new team. For more information, see "[Automatic watching](#automatic-watching)."
|
||||
- There are new {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see "[{% data variables.product.prodname_dependabot_alerts %} notification options](#dependabot-alerts-notification-options)." {% ifversion fpt or ghec %}
|
||||
- There are workflow runs updates on repositories set up with {% data variables.product.prodname_actions %}. For more information, see "[{% data variables.product.prodname_actions %} notification options](#github-actions-notification-options)."{% endif %}{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5668 %}
|
||||
- There are workflow runs updates on repositories set up with {% data variables.product.prodname_actions %}. For more information, see "[{% data variables.product.prodname_actions %} notification options](#github-actions-notification-options)."{% endif %}{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
- There are new deploy keys added to repositories that belong to organizations that you're an owner of. For more information, see "[Organization alerts notification options](#organization-alerts-notification-options)."{% endif %}
|
||||
|
||||
## Automatic watching
|
||||
|
|
@ -206,7 +206,7 @@ Choose how you want to receive workflow run updates for repositories that you ar
|
|||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5668 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
## Organization alerts notification options
|
||||
|
||||
If you're an organization owner, you'll receive email notifications by default when organization members add new deploy keys to repositories within the organization. You can unsubscribe from these notifications. On the notification settings page, under "Organization alerts", unselect **Email**.
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ If you're a member of an {% data variables.product.prodname_emu_enterprise %}, y
|
|||
1. Ask for the username of the person you're inviting as a collaborator.{% ifversion fpt or ghec %} If they don't have a username yet, they can sign up for {% data variables.product.prodname_dotcom %} For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/articles/signing-up-for-a-new-github-account)".{% endif %}
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658%}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4%}
|
||||
{% data reusables.repositories.click-collaborators-teams %}
|
||||
1. Click **Invite a collaborator**.
|
||||
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ While forks of private repositories are deleted when a collaborator is removed,
|
|||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
{% data reusables.repositories.click-collaborators-teams %}
|
||||
4. To the right of the collaborator you want to remove, click {% octicon "trash" aria-label="The trash icon" %}.
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ topics:
|
|||
shortTitle: Remove yourself
|
||||
---
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
2. In the "Code, planning, and automation" section of the sidebar, click **{% octicon "repo" aria-label="The repo icon" %} Repositories**.
|
||||
{% else %}
|
||||
2. In the left sidebar, click **Repositories**.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Managing your tab size rendering preference
|
|||
intro: You can manage the number of spaces a tab is equal to for your personal account.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghae: issue-5083
|
||||
ghae: '>= 3.4'
|
||||
ghes: '>=3.4'
|
||||
ghec: '*'
|
||||
topics:
|
||||
|
|
|
|||
|
|
@ -37,9 +37,9 @@ Once you complete this project, you should understand how to build your own Java
|
|||
|
||||
Before you begin, you'll need to download Node.js and create a public {% data variables.product.prodname_dotcom %} repository.
|
||||
|
||||
1. Download and install Node.js {% ifversion fpt or ghes > 3.3 or ghae-issue-5504 or ghec %}16.x{% else %}12.x{% endif %}, which includes npm.
|
||||
1. Download and install Node.js {% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}16.x{% else %}12.x{% endif %}, which includes npm.
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-5504 or ghec %}https://nodejs.org/en/download/{% else %}https://nodejs.org/en/download/releases/{% endif %}
|
||||
{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}https://nodejs.org/en/download/{% else %}https://nodejs.org/en/download/releases/{% endif %}
|
||||
|
||||
1. Create a new public repository on {% data variables.product.product_location %} and call it "hello-world-javascript-action". For more information, see "[Create a new repository](/articles/creating-a-new-repository)."
|
||||
|
||||
|
|
@ -73,7 +73,7 @@ outputs:
|
|||
time: # id of output
|
||||
description: 'The time we greeted you'
|
||||
runs:
|
||||
using: {% ifversion fpt or ghes > 3.3 or ghae-issue-5504 or ghec %}'node16'{% else %}'node12'{% endif %}
|
||||
using: {% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}'node16'{% else %}'node12'{% endif %}
|
||||
main: 'index.js'
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -145,11 +145,11 @@ For more information on how to use context syntax, see "[Contexts](/actions/lear
|
|||
|
||||
**Required** Configures the path to the action's code and the runtime used to execute the code.
|
||||
|
||||
### Example: Using Node.js {% ifversion fpt or ghes > 3.3 or ghae-issue-5504 or ghec %}v16{% else %}v12{% endif %}
|
||||
### Example: Using Node.js {% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}v16{% else %}v12{% endif %}
|
||||
|
||||
```yaml
|
||||
runs:
|
||||
using: {% ifversion fpt or ghes > 3.3 or ghae-issue-5504 or ghec %}'node16'{% else %}'node12'{% endif %}
|
||||
using: {% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}'node16'{% else %}'node12'{% endif %}
|
||||
main: 'main.js'
|
||||
```
|
||||
|
||||
|
|
@ -157,7 +157,7 @@ runs:
|
|||
|
||||
**Required** The runtime used to execute the code specified in [`main`](#runsmain).
|
||||
|
||||
- Use `node12` for Node.js v12.{% ifversion fpt or ghes > 3.3 or ghae-issue-5504 or ghec %}
|
||||
- Use `node12` for Node.js v12.{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}
|
||||
- Use `node16` for Node.js v16.{% endif %}
|
||||
|
||||
### `runs.main`
|
||||
|
|
@ -172,7 +172,7 @@ In this example, the `pre:` action runs a script called `setup.js`:
|
|||
|
||||
```yaml
|
||||
runs:
|
||||
using: {% ifversion fpt or ghes > 3.3 or ghae-issue-5504 or ghec %}'node16'{% else %}'node12'{% endif %}
|
||||
using: {% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}'node16'{% else %}'node12'{% endif %}
|
||||
pre: 'setup.js'
|
||||
main: 'index.js'
|
||||
post: 'cleanup.js'
|
||||
|
|
@ -199,7 +199,7 @@ In this example, the `post:` action runs a script called `cleanup.js`:
|
|||
|
||||
```yaml
|
||||
runs:
|
||||
using: {% ifversion fpt or ghes > 3.3 or ghae-issue-5504 or ghec %}'node16'{% else %}'node12'{% endif %}
|
||||
using: {% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}'node16'{% else %}'node12'{% endif %}
|
||||
main: 'index.js'
|
||||
post: 'cleanup.js'
|
||||
```
|
||||
|
|
@ -271,7 +271,7 @@ For more information, see "[`github context`](/actions/reference/context-and-exp
|
|||
**Required** The shell where you want to run the command. You can use any of the shells listed [here](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsshell). Required if `run` is set.
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-5504 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}
|
||||
#### `runs.steps[*].if`
|
||||
|
||||
**Optional** You can use the `if` conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional.
|
||||
|
|
@ -369,7 +369,7 @@ runs:
|
|||
```
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghes > 3.5 or ghae-issue-6573 %}
|
||||
{% ifversion ghes > 3.5 or ghae > 3.5 %}
|
||||
|
||||
#### `runs.steps[*].continue-on-error`
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,6 @@ redirect_from:
|
|||
- /actions/deployment/security-hardening-your-deployments/using-oidc-with-your-reusable-workflows
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghae: issue-4757
|
||||
ghec: '*'
|
||||
ghes: '>=3.5'
|
||||
type: how_to
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ intro: 'How to use advanced {% data variables.product.prodname_actions %} featur
|
|||
versions:
|
||||
fpt: '*'
|
||||
ghes: '>= 3.5'
|
||||
ghae: issue-4925
|
||||
ghae: '>= 3.5'
|
||||
ghec: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ You can set up automation to scale the number of self-hosted runners. For more i
|
|||
|
||||
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. For information about how to add a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)."
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.repositories.settings-sidebar-actions-runners %}
|
||||
|
|
@ -67,7 +67,7 @@ For more information, see "[Monitoring and troubleshooting self-hosted runners](
|
|||
|
||||
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. For information about how to add a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)."
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
{% data reusables.organizations.navigate-to-org %}
|
||||
{% data reusables.organizations.org_settings %}
|
||||
{% data reusables.organizations.settings-sidebar-actions-runners %}
|
||||
|
|
@ -93,7 +93,7 @@ For more information, see "[Monitoring and troubleshooting self-hosted runners](
|
|||
{% ifversion ghec or ghes or ghae %}
|
||||
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 ghec or ghes > 3.3 or ghae-issue-5091 %}
|
||||
{% ifversion ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
|
||||
To add a self-hosted runner to an enterprise, you must be an enterprise owner. For information about how to add a self-hosted runner with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runners).
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ 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. For information about how to remove a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)."
|
||||
|
||||
{% data reusables.actions.self-hosted-runner-reusing %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.repositories.settings-sidebar-actions-runners %}
|
||||
|
|
@ -85,7 +85,7 @@ If you use {% data variables.product.prodname_ghe_cloud %}, you can also remove
|
|||
To remove a self-hosted runner from an enterprise, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runners).
|
||||
|
||||
{% data reusables.actions.self-hosted-runner-reusing %}
|
||||
{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %}
|
||||
{% ifversion ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-tab %}
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ For information on how to use labels to route jobs to specific types of self-hos
|
|||
|
||||
## Creating a custom label
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
{% data reusables.actions.self-hosted-runner-navigate-to-repo-org-enterprise %}
|
||||
{% data reusables.actions.settings-sidebar-actions-runner-selection %}
|
||||
1. In the "Labels" section, click {% octicon "gear" aria-label="The Gear icon" %}.
|
||||
|
|
@ -38,7 +38,7 @@ The custom label is created and assigned to the self-hosted runner. Custom label
|
|||
|
||||
## Assigning a label to a self-hosted runner
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
{% data reusables.actions.self-hosted-runner-navigate-to-repo-org-enterprise %}
|
||||
{% data reusables.actions.settings-sidebar-actions-runner-selection %}
|
||||
{% data reusables.actions.runner-label-settings %}
|
||||
|
|
@ -53,7 +53,7 @@ The custom label is created and assigned to the self-hosted runner. Custom label
|
|||
|
||||
## Removing a custom label from a self-hosted runner
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
{% data reusables.actions.self-hosted-runner-navigate-to-repo-org-enterprise %}
|
||||
{% data reusables.actions.settings-sidebar-actions-runner-selection %}
|
||||
{% data reusables.actions.runner-label-settings %}
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ You can access contexts using the expression syntax. For more information, see "
|
|||
| `github` | `object` | Information about the workflow run. For more information, see [`github` context](#github-context). |
|
||||
| `env` | `object` | Contains environment variables set in a workflow, job, or step. For more information, see [`env` context](#env-context). |
|
||||
| `job` | `object` | Information about the currently running job. For more information, see [`job` context](#job-context). |
|
||||
{%- ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}
|
||||
{%- ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}
|
||||
| `jobs` | `object` | For reusable workflows only, contains outputs of jobs from the reusable workflow. For more information, see [`jobs` context](#jobs-context). |{% endif %}
|
||||
| `steps` | `object` | Information about the steps that have been run in the current job. For more information, see [`steps` context](#steps-context). |
|
||||
| `runner` | `object` | Information about the runner that is running the current job. For more information, see [`runner` context](#runner-context). |
|
||||
|
|
@ -46,7 +46,7 @@ You can access contexts using the expression syntax. For more information, see "
|
|||
| `strategy` | `object` | Information about the matrix execution strategy for the current job. For more information, see [`strategy` context](#strategy-context). |
|
||||
| `matrix` | `object` | Contains the matrix properties defined in the workflow that apply to the current job. For more information, see [`matrix` context](#matrix-context). |
|
||||
| `needs` | `object` | Contains the outputs of all jobs that are defined as a dependency of the current job. For more information, see [`needs` context](#needs-context). |
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4757 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
| `inputs` | `object` | Contains the inputs of a reusable {% ifversion actions-unified-inputs %}or manually triggered {% endif %}workflow. For more information, see [`inputs` context](#inputs-context). |{% endif %}
|
||||
|
||||
As part of an expression, you can access context information using one of two syntaxes.
|
||||
|
|
@ -70,7 +70,7 @@ In addition, some functions may only be used in certain places. For example, the
|
|||
|
||||
The following table indicates where each context and special function can be used within a workflow. Unless listed below, a function can be used anywhere.
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}
|
||||
|
||||
| Workflow key | Context | Special functions |
|
||||
| ---- | ------- | ----------------- |
|
||||
|
|
@ -196,7 +196,7 @@ The `github` context contains information about the workflow run and the event t
|
|||
| `github.head_ref` | `string` | The `head_ref` or source branch of the pull request in a workflow run. This property is only available when the event that triggers a workflow run is either `pull_request` or `pull_request_target`. |
|
||||
| `github.job` | `string` | The [`job_id`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_id) of the current job. <br /> Note: This context property is set by the Actions runner, and is only available within the execution `steps` of a job. Otherwise, the value of this property will be `null`. |
|
||||
| `github.ref` | `string` | {% data reusables.actions.ref-description %} |
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5338 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
| `github.ref_name` | `string` | {% data reusables.actions.ref_name-description %} |
|
||||
| `github.ref_protected` | `string` | {% data reusables.actions.ref_protected-description %} |
|
||||
| `github.ref_type` | `string` | {% data reusables.actions.ref_type-description %} |
|
||||
|
|
@ -208,7 +208,7 @@ The `github` context contains information about the workflow run and the event t
|
|||
| `github.retention_days` | `string` | The number of days that workflow run logs and artifacts are kept. |
|
||||
| `github.run_id` | `string` | {% data reusables.actions.run_id_description %} |
|
||||
| `github.run_number` | `string` | {% data reusables.actions.run_number_description %} |
|
||||
{%- ifversion fpt or ghec or ghes > 3.5 or ghae-issue-4722 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.5 or ghae > 3.4 %}
|
||||
| `github.run_attempt` | `string` | A unique number for each attempt of a particular workflow run in a repository. This number begins at 1 for the workflow run's first attempt, and increments with each re-run. |
|
||||
{%- endif %}
|
||||
| `github.server_url` | `string` | The URL of the GitHub server. For example: `https://github.com`. |
|
||||
|
|
@ -406,7 +406,7 @@ jobs:
|
|||
- run: ./run-tests
|
||||
```
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}
|
||||
|
||||
## `jobs` context
|
||||
|
||||
|
|
@ -782,7 +782,7 @@ jobs:
|
|||
- run: ./debug
|
||||
```
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4757 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
## `inputs` context
|
||||
|
||||
The `inputs` context contains input properties passed to a reusable workflow{% ifversion actions-unified-inputs %} or to a manually triggered workflow{% endif %}. {% ifversion actions-unified-inputs %}For reusable workflows, the{% else %}The{% endif %} input names and types are defined in the [`workflow_call` event configuration](/actions/learn-github-actions/events-that-trigger-workflows#workflow-reuse-events) of a reusable workflow, and the input values are passed from [`jobs.<job_id>.with`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idwith) in an external workflow that calls the reusable workflow. {% ifversion actions-unified-inputs %}For manually triggered workflows, the inputs are defined in the [`workflow_dispatch` event configuration](/actions/learn-github-actions/events-that-trigger-workflows#workflow_dispatch) of a workflow.{% endif %}
|
||||
|
|
|
|||
|
|
@ -144,7 +144,7 @@ We strongly recommend that actions use environment variables to access the files
|
|||
| `GITHUB_JOB` | The [job_id](/actions/reference/workflow-syntax-for-github-actions#jobsjob_id) of the current job. For example, `greeting_job`. |
|
||||
| `GITHUB_PATH` | The path on the runner to the file that sets system `PATH` variables from workflow commands. This file is unique to the current step and changes for each step in a job. For example, `/home/runner/work/_temp/_runner_file_commands/add_path_899b9445-ad4a-400c-aa89-249f18632cf5`. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path)." |
|
||||
| `GITHUB_REF` | {% data reusables.actions.ref-description %} |
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5338 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
| `GITHUB_REF_NAME` | {% data reusables.actions.ref_name-description %} |
|
||||
| `GITHUB_REF_PROTECTED` | {% data reusables.actions.ref_protected-description %} |
|
||||
| `GITHUB_REF_TYPE` | {% data reusables.actions.ref_type-description %} |
|
||||
|
|
|
|||
|
|
@ -277,7 +277,7 @@ Creates a hash for any `package-lock.json` and `Gemfile.lock` files in the repos
|
|||
`hashFiles('**/package-lock.json', '**/Gemfile.lock')`
|
||||
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-5504 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}
|
||||
## Status check functions
|
||||
|
||||
You can use the following status check functions as expressions in `if` conditionals. A default status check of `success()` is applied unless you include one of these functions. For more information about `if` conditionals, see "[Workflow syntax for GitHub Actions](/articles/workflow-syntax-for-github-actions/#jobsjob_idif)" and "[Metadata syntax for GitHub Composite Actions](/actions/creating-actions/metadata-syntax-for-github-actions/#runsstepsif)".
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ You can add an action to your workflow by referencing the action in your workflo
|
|||
|
||||
You can view the actions referenced in your {% data variables.product.prodname_actions %} workflows as dependencies in the dependency graph of the repository containing your workflows. For more information, see “[About the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph).”
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6269 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
|
||||
{% note %}
|
||||
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ You can configure a {% data variables.product.prodname_actions %} _workflow_ to
|
|||
|
||||
{% data reusables.actions.about-workflows-long %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}You can reference a workflow within another workflow, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."{% endif %}
|
||||
{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}You can reference a workflow within another workflow, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."{% endif %}
|
||||
|
||||
For more information about workflows, see "[Using workflows](/actions/using-workflows)."
|
||||
|
||||
|
|
|
|||
|
|
@ -187,7 +187,7 @@ You can help mitigate this risk by following these good practices:
|
|||
|
||||
Although pinning to a commit SHA is the most secure option, specifying a tag is more convenient and is widely used. If you’d like to specify a tag, then be sure that you trust the action's creators. The ‘Verified creator’ badge on {% data variables.product.prodname_marketplace %} is a useful signal, as it indicates that the action was written by a team whose identity has been verified by {% data variables.product.prodname_dotcom %}. Note that there is risk to this approach even if you trust the author, because a tag can be moved or deleted if a bad actor gains access to the repository storing the action.
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}
|
||||
## Reusing third-party workflows
|
||||
|
||||
The same principles described above for using third-party actions also apply to using third-party workflows. You can help mitigate the risks associated with reusing workflows by following the same good practices outlined above. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."
|
||||
|
|
|
|||
|
|
@ -195,7 +195,7 @@ To learn more about self-hosted runner labels, see "[Using labels with self-host
|
|||
To learn more about {% data variables.product.prodname_dotcom %}-hosted runner labels, see "[Supported runners and hardware resources](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources)."
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}
|
||||
### Reusing workflows
|
||||
{% data reusables.actions.reusable-workflows %}
|
||||
{% endif %}
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ Starter workflows can be created by users with write access to the organization'
|
|||
Starter workflows created by users can only be used to create workflows in public repositories. Organizations using {% data variables.product.prodname_ghe_cloud %} can also use starter workflows to create workflows in private repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/learn-github-actions/creating-starter-workflows-for-your-organization).
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}
|
||||
{% note %}
|
||||
|
||||
**Note:** To avoid duplication among starter workflows you can call reusable workflows from within a workflow. This can help make your workflows easier to maintain. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."
|
||||
|
|
|
|||
|
|
@ -1242,7 +1242,7 @@ on:
|
|||
types: [started]
|
||||
```
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}
|
||||
|
||||
### `workflow_call`
|
||||
|
||||
|
|
@ -1278,7 +1278,7 @@ You can configure custom-defined input properties, default input values, and req
|
|||
|
||||
{% data reusables.actions.inputs-vs-github-event-inputs %}
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5511 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
This example defines inputs called `logLevel`, `tags`, and `environment`. You pass values for these inputs to the workflow when you run it. This workflow then prints the values to the log, using the {% ifversion actions-unified-inputs %}`inputs.logLevel`, `inputs.tags`, and `inputs.environment`{% else %}`github.event.inputs.logLevel`, `github.event.inputs.tags`, and `github.event.inputs.environment`{% endif %} context properties.
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>=3.4'
|
||||
ghae: issue-4757
|
||||
ghae: '>= 3.4'
|
||||
type: how_to
|
||||
topics:
|
||||
- Workflows
|
||||
|
|
@ -217,7 +217,7 @@ You call a reusable workflow by using the `uses` keyword. Unlike when you are us
|
|||
|
||||
[`jobs.<job_id>.uses`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_iduses)
|
||||
|
||||
You reference reusable workflow files using {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6000 %}one of the following syntaxes:{% else %}the syntax:{% endif %}
|
||||
You reference reusable workflow files using {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}one of the following syntaxes:{% else %}the syntax:{% endif %}
|
||||
|
||||
{% data reusables.actions.reusable-workflow-calling-syntax %}
|
||||
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ Your organization can share workflows by reusing the workflows exactly or by cre
|
|||
{% data reusables.actions.internal-actions-summary %}
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}
|
||||
### Reusing workflows
|
||||
|
||||
{% data reusables.actions.reusable-workflows %}
|
||||
|
|
|
|||
|
|
@ -120,7 +120,7 @@ You can use activity types and filters to further control when your workflow wil
|
|||
|
||||
{% data reusables.actions.workflow-dispatch-inputs %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}
|
||||
## Defining inputs, outputs, and secrets for reusable workflows
|
||||
|
||||
{% data reusables.actions.reusable-workflows-ghes-beta %}
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ The name of your workflow. {% data variables.product.prodname_dotcom %} displays
|
|||
|
||||
{% data reusables.actions.workflows.section-triggering-a-workflow-schedule %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}
|
||||
## `on.workflow_call`
|
||||
|
||||
{% data reusables.actions.reusable-workflows-ghes-beta %}
|
||||
|
|
@ -926,12 +926,12 @@ Additional Docker container resource options. For a list of options, see "[`dock
|
|||
|
||||
{% endwarning %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}
|
||||
## `jobs.<job_id>.uses`
|
||||
|
||||
{% data reusables.actions.reusable-workflows-ghes-beta %}
|
||||
|
||||
The location and version of a reusable workflow file to run as a job. {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6000 %}Use one of the following syntaxes:{% endif %}
|
||||
The location and version of a reusable workflow file to run as a job. {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}Use one of the following syntaxes:{% endif %}
|
||||
|
||||
{% data reusables.actions.reusable-workflow-calling-syntax %}
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ intro: 'You can give users easy access to enterprise-specific links by adding cu
|
|||
versions:
|
||||
ghec: '*'
|
||||
ghes: '>=3.4'
|
||||
ghae: issue-5487
|
||||
ghae: '>= 3.4'
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
|
|
|
|||
|
|
@ -101,7 +101,7 @@ You can create a runner group to manage access to the runner that you added to y
|
|||
{% endwarning %}
|
||||
{%- endif %}
|
||||
{% data reusables.actions.create-runner-group %}
|
||||
{%- ifversion ghec or ghes > 3.3 or ghae-issue-5091 %}
|
||||
{%- ifversion ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
1. Click the "Runners" tab.
|
||||
1. In the list of runners, click the runner that you deployed in the previous section.
|
||||
1. Click **Edit**.
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ Then,{% else %}First,{% endif %} decide whether you'll allow third-party actions
|
|||
|
||||
{%- endif %}
|
||||
|
||||
{% ifversion ghec or ghae-issue-4757 %}
|
||||
{% ifversion ghec or ghes > 3.4 %}
|
||||
Consider combining OpenID Connect (OIDC) with reusable workflows to enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. For more information, see "[Using OpenID Connect with reusable workflows](/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows)."
|
||||
{% endif %}
|
||||
|
||||
|
|
@ -73,7 +73,7 @@ Think about how your enterprise can use features of {% data variables.product.pr
|
|||
|
||||
{% data reusables.actions.internal-actions-summary %}
|
||||
|
||||
{% ifversion ghec or ghes > 3.3 or ghae-issue-4757 %}
|
||||
{% ifversion ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
{% data reusables.actions.reusable-workflows-ghes-beta %}
|
||||
With reusable workflows, your team can call one workflow from another workflow, avoiding exact duplication. Reusable workflows promote best practice by helping your team use workflows that are well designed and have already been tested. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."
|
||||
{% endif %}
|
||||
|
|
|
|||
|
|
@ -171,7 +171,7 @@ Deleting a CA cannot be undone. If you want to use the same CA in the future, yo
|
|||
{% data reusables.enterprise-accounts.security-tab %}
|
||||
{% data reusables.organizations.delete-ssh-ca %}
|
||||
|
||||
{% ifversion ghec or ghae-issue-7803 %}
|
||||
{% ifversion ghec %}
|
||||
|
||||
## Managing SSO for unauthenticated users
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ shortTitle: Deploy keys
|
|||
---
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
3. In the "Security" section of the sidebar, click **{% octicon "key" aria-label="The key icon" %} Deploy keys**.
|
||||
{% else %}
|
||||
3. In the left sidebar, click **Deploy keys**.
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ shortTitle: Security log
|
|||
The security log lists all actions performed within the last 90 days.
|
||||
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
1. In the "Archives" section of the sidebar, click **{% octicon "log" aria-label="The log icon" %} Security log**.
|
||||
{% else %}
|
||||
1. In the user settings sidebar, click **Security log**.
|
||||
|
|
|
|||
|
|
@ -27,11 +27,11 @@ By default, {% data variables.product.prodname_code_scanning %} analyzes your co
|
|||
|
||||
Each alert highlights a problem with the code and the name of the tool that identified it. You can see the line of code that triggered the alert, as well as properties of the alert, such as the alert severity, security severity, and the nature of the problem. Alerts also tell you when the issue was first introduced. For alerts identified by {% data variables.product.prodname_codeql %} analysis, you will also see information on how to fix the problem.
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
{% data reusables.code-scanning.alert-default-branch %}
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
|
||||
{% else %}
|
||||
|
||||
|
|
@ -55,7 +55,7 @@ To calculate the security severity of an alert, we use Common Vulnerability Scor
|
|||
|
||||
By default, any {% data variables.product.prodname_code_scanning %} results with a security severity of `Critical` or `High` will cause a check failure. You can specify which security severity level for {% data variables.product.prodname_code_scanning %} results should cause a check failure. For more information, see "[Defining the severities causing pull request check failure](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#defining-the-severities-causing-pull-request-check-failure)."
|
||||
|
||||
{% ifversion fpt or ghes > 3.4 or ghae-issue-6251 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.4 or ghae > 3.4 or ghec %}
|
||||
### About analysis origins
|
||||
|
||||
You can set up multiple configurations of code analysis on a repository, using different tools and targeting different languages or areas of the code. Each configuration of code scanning is the analysis origin for all the alerts it generates. For example, an alert generated using the default CodeQL analysis with GitHub Actions will have a different analysis origin from an alert generated externally and uploaded via the code scanning API.
|
||||
|
|
|
|||
|
|
@ -511,7 +511,7 @@ For more information about using `exclude` and `include` filters in your custom
|
|||
|
||||
### Specifying directories to scan
|
||||
|
||||
For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python{% ifversion fpt or ghes > 3.3 or ghae-issue-5017 %}, Ruby{% endif %} and JavaScript/TypeScript), you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. You can exclude the files in specific directories from analysis by adding a `paths-ignore` array.
|
||||
For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python{% ifversion fpt or ghes > 3.3 or ghae > 3.3 %}, Ruby{% endif %} and JavaScript/TypeScript), you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. You can exclude the files in specific directories from analysis by adding a `paths-ignore` array.
|
||||
|
||||
``` yaml
|
||||
paths:
|
||||
|
|
|
|||
|
|
@ -42,11 +42,11 @@ By default, the code scanning alerts page is filtered to show alerts for the def
|
|||
{% data reusables.code-scanning.explore-alert %}
|
||||
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
{% data reusables.code-scanning.alert-default-branch %}
|
||||
{% endif %}
|
||||
1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used.
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
|
||||
{% else %}
|
||||
|
||||
|
|
@ -81,7 +81,7 @@ The benefit of using keyword filters is that only values with results are shown
|
|||
|
||||
If you enter multiple filters, the view will show alerts matching _all_ these filters. For example, `is:closed severity:high branch:main` will only display closed high-severity alerts that are present on the `main` branch. The exception is filters relating to refs (`ref`, `branch` and `pr`): `is:open branch:main branch:next` will show you open alerts from both the `main` branch and the `next` branch.
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
{% data reusables.code-scanning.filter-non-default-branches %}
|
||||
{% endif %}
|
||||
|
||||
|
|
@ -102,7 +102,7 @@ You can use the "Only alerts in application code" filter or `autofilter:true` ke
|
|||
You can search the list of alerts. This is useful if there is a large number of alerts in your repository, or if you don't know the exact name for an alert for example. {% data variables.product.product_name %} performs the free text search across:
|
||||
- The name of the alert
|
||||
- The alert details (this also includes the information hidden from view by default in the **Show more** collapsible section)
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
|
||||
{% else %}
|
||||
|
||||
|
|
@ -154,11 +154,11 @@ Alerts may be fixed in one branch but not in another. You can use the "Branch" f
|
|||
|
||||
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
{% data reusables.code-scanning.filter-non-default-branches %}
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.4 or ghae-issue-6251 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.4 or ghae > 3.4 or ghec %}
|
||||
{% note %}
|
||||
|
||||
**Note:** If you run code scanning using multiple configurations, then sometimes an alert will have multiple analysis origins. Unless you run all configurations regularly, you may see alerts that are fixed in one analysis origin but not in another. For more information, see "[About analysis origins](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-analysis-origins)."
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ You decide how to generate {% data variables.product.prodname_code_scanning %} a
|
|||
|
||||
{% data reusables.code-scanning.enabling-options %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.4 or ghae-issue-6251 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.4 or ghae > 3.4 or ghec %}
|
||||
{% data reusables.code-scanning.about-analysis-origins-link %}
|
||||
{% endif %}
|
||||
|
||||
|
|
@ -153,7 +153,7 @@ The names of the {% data variables.product.prodname_code_scanning %} analysis ch
|
|||
|
||||
When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis.
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-7095 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
<!--Troubleshooting section no longer relevant-->
|
||||
{% elsif ghes < 3.5 or ghae %}
|
||||
If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion ghes > 3.2 or ghae %}an "Analysis not found"{% elsif ghes = 3.2 %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check.
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ You can use more than one issue to track the same {% data variables.product.prod
|
|||
|
||||
- A "tracked in" section will also show in the corresponding alert page.
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
|
||||
{% else %}
|
||||
|
||||
|
|
@ -69,7 +69,7 @@ The status of the tracked alert won't change if you change the checkbox state of
|
|||
1. Optionally, to find the alert to track, you can use the free-text search or the drop-down menus to filter and locate the alert. For more information, see "[Managing code scanning alerts for your repository](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#filtering-code-scanning-alerts)."
|
||||
{% endif %}
|
||||
1. Towards the top of the page, on the right side, click **Create issue**.
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
|
||||
{% else %}
|
||||
|
||||
|
|
|
|||
|
|
@ -89,13 +89,13 @@ If you have write permission for the repository, some annotations contain links
|
|||
|
||||
To see more information about an alert, users with write permission can click the **Show more details** link shown in the annotation. This allows you to see all of the context and metadata provided by the tool in an alert view. In the example below, you can see tags showing the severity, type, and relevant common weakness enumerations (CWEs) for the problem. The view also shows which commit introduced the problem.
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
{% data reusables.code-scanning.alert-default-branch %}
|
||||
{% endif %}
|
||||
|
||||
In the detailed view for an alert, some {% data variables.product.prodname_code_scanning %} tools, like {% data variables.product.prodname_codeql %} analysis, also include a description of the problem and a **Show more** link for guidance on how to fix your code.
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
|
||||
{% else %}
|
||||
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ topics:
|
|||
|
||||
To produce more detailed logging output, you can enable step debug logging. For more information, see "[Enabling debug logging](/actions/managing-workflow-runs/enabling-debug-logging#enabling-step-debug-logging)."
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5601 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
|
||||
## Creating {% data variables.product.prodname_codeql %} debugging artifacts
|
||||
|
||||
|
|
@ -66,7 +66,7 @@ You need to ensure that you select **Enable debug logging** . This option enable
|
|||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5601 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
|
||||
### Creating {% data variables.product.prodname_codeql %} debugging artifacts using a workflow flag
|
||||
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ As an alternative to running {% data variables.product.prodname_code_scanning %}
|
|||
|
||||
If you use a third-party static analysis tool that can produce results as Static Analysis Results Interchange Format (SARIF) 2.1.0 data, you can upload this to {% data variables.product.prodname_dotcom %}. For more information, see "[Uploading a SARIF file to GitHub](/code-security/secure-coding/uploading-a-sarif-file-to-github)."
|
||||
|
||||
{% ifversion fpt or ghes > 3.4 or ghae-issue-6251 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.4 or ghae > 3.4 or ghec %}
|
||||
{% data reusables.code-scanning.about-analysis-origins-link %}
|
||||
{% endif %}
|
||||
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ redirect_from:
|
|||
|
||||
{% data reusables.code-scanning.codeql-cli-context-for-third-party-tools %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.4 or ghae-issue-6251 or ghec %}
|
||||
{% ifversion fpt or ghes > 3.4 or ghae > 3.4 or ghec %}
|
||||
{% data reusables.code-scanning.about-analysis-origins-link %}
|
||||
{% endif %}
|
||||
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ Generally, we name our supported ecosystems after the software programming langu
|
|||
- Composer (registry: https://packagist.org/){% ifversion GH-advisory-db-erlang-support %}
|
||||
- Erlang (registry: https://hex.pm/){% endif %}
|
||||
- Go (registry: https://pkg.go.dev/)
|
||||
{%- ifversion fpt or ghec or ghes > 3.6 or ghae-issue-7508 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.6 or ghae > 3.6 %}
|
||||
- GitHub Actions (https://github.com/marketplace?type=actions/) {% endif %}
|
||||
- Maven (registry: https://repo.maven.apache.org/maven2)
|
||||
- npm (registry: https://www.npmjs.com/)
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ topics:
|
|||
{% data reusables.dependabot.beta-security-and-version-updates %}
|
||||
{% data reusables.dependabot.enterprise-enable-dependabot %}
|
||||
|
||||
Your repository's {% data variables.product.prodname_dependabot_alerts %} tab lists all open and closed {% data variables.product.prodname_dependabot_alerts %}{% ifversion fpt or ghec or ghes > 3.2 %} and corresponding {% data variables.product.prodname_dependabot_security_updates %}{% endif %}. You can{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %} filter alerts by package, ecosystem, or manifest. You can {% endif %} sort the list of alerts, and you can click into specific alerts for more details. {% ifversion dependabot-bulk-alerts %}You can also dismiss or reopen alerts, either one by one or by selecting multiple alerts at once.{% else %}You can also dismiss or reopen alerts. {% endif %} For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."
|
||||
Your repository's {% data variables.product.prodname_dependabot_alerts %} tab lists all open and closed {% data variables.product.prodname_dependabot_alerts %}{% ifversion fpt or ghec or ghes > 3.2 %} and corresponding {% data variables.product.prodname_dependabot_security_updates %}{% endif %}. You can{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %} filter alerts by package, ecosystem, or manifest. You can {% endif %} sort the list of alerts, and you can click into specific alerts for more details. {% ifversion dependabot-bulk-alerts %}You can also dismiss or reopen alerts, either one by one or by selecting multiple alerts at once.{% else %}You can also dismiss or reopen alerts. {% endif %} For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.2 %}
|
||||
You can enable automatic security updates for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)."
|
||||
|
|
@ -39,7 +39,7 @@ You can enable automatic security updates for any repository that uses {% data v
|
|||
|
||||
Each {% data variables.product.prodname_dependabot %} alert has a unique numeric identifier and the {% data variables.product.prodname_dependabot_alerts %} tab lists an alert for every detected vulnerability. Legacy {% data variables.product.prodname_dependabot_alerts %} grouped vulnerabilities by dependency and generated a single alert per dependency. If you navigate to a legacy {% data variables.product.prodname_dependabot %} alert, you will be redirected to a {% data variables.product.prodname_dependabot_alerts %} tab filtered for that package. {% endif %}
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
You can filter and sort {% data variables.product.prodname_dependabot_alerts %} using a variety of filters and sort options available on the user interface. For more information, see "[Prioritizing {% data variables.product.prodname_dependabot_alerts %}](#prioritizing-across--data-variablesproductprodname_dependabot_alerts-)" below.
|
||||
|
||||
## Prioritizing {% data variables.product.prodname_dependabot_alerts %}
|
||||
|
|
@ -107,7 +107,7 @@ For more information, see "[Reviewing and fixing alerts](#reviewing-and-fixing-a
|
|||
|
||||
## Viewing {% data variables.product.prodname_dependabot_alerts %}
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-security %}
|
||||
{% data reusables.repositories.sidebar-dependabot-alerts %}
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ You can also enable or disable {% data variables.product.prodname_dependabot_sec
|
|||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.repositories.navigate-to-code-security-and-analysis %}
|
||||
1. Under "Code security and analysis", to the right of "{% data variables.product.prodname_dependabot %} security updates", click **Enable** to enable the feature or **Disable** to disable it. {% ifversion fpt or ghec %}For public repositories, the button is disabled if the feature is always enabled.{% endif %}
|
||||
{% ifversion fpt or ghec %}{% elsif ghes > 3.6 or ghae-issue-7044 %}<!--Insert screenshot for GHES 3.7 when available--> {% else %}{% endif %}
|
||||
{% ifversion fpt or ghec %}{% elsif ghes > 3.6 or ghae > 3.6 %}<!--Insert screenshot for GHES 3.7 when available--> {% else %}{% endif %}
|
||||
|
||||
## Overriding the default behavior with a configuration file
|
||||
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>3.2'
|
||||
ghae: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Actions
|
||||
|
|
@ -32,14 +33,14 @@ redirect_from:
|
|||
|
||||
{% data variables.product.prodname_dependabot %} is able to trigger {% data variables.product.prodname_actions %} workflows on its pull requests and comments; however, certain events are treated differently.
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5792 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
For workflows initiated by {% data variables.product.prodname_dependabot %} (`github.actor == 'dependabot[bot]'`) using the `pull_request`, `pull_request_review`, `pull_request_review_comment`, `push`, `create`, `deployment`, and `deployment_status` events, the following restrictions apply:
|
||||
{% endif %}
|
||||
|
||||
- {% ifversion ghes = 3.3 %}`GITHUB_TOKEN` has read-only permissions, unless your administrator has removed restrictions.{% else %}`GITHUB_TOKEN` has read-only permissions by default.{% endif %}
|
||||
- {% ifversion ghes = 3.3 %}Secrets are inaccessible, unless your administrator has removed restrictions.{% else %}Secrets are populated from {% data variables.product.prodname_dependabot %} secrets. {% data variables.product.prodname_actions %} secrets are not available.{% endif %}
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5792 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
For workflows initiated by {% data variables.product.prodname_dependabot %} (`github.actor == 'dependabot[bot]'`) using the `pull_request_target` event, if the base ref of the pull request was created by {% data variables.product.prodname_dependabot %} (`github.actor == 'dependabot[bot]'`), the `GITHUB_TOKEN` will be read-only and secrets are not available.
|
||||
{% endif %}
|
||||
|
||||
|
|
|
|||
|
|
@ -112,7 +112,7 @@ Show the full impact of changes to dependencies and see details of any vulnerabl
|
|||
{% elsif fpt %}<!--Feature requires enterprise product-->
|
||||
|
||||
{% else %}
|
||||
### Security overview for organizations{% ifversion ghes > 3.4 or ghae-issue-6199 %}, enterprises,{% endif %} and teams
|
||||
### Security overview for organizations{% ifversion ghes > 3.4 or ghae > 3.4 %}, enterprises,{% endif %} and teams
|
||||
|
||||
Review the security configuration and alerts for your organization and identify the repositories at greatest risk. For more information, see "[About the security overview](/code-security/security-overview/about-the-security-overview)."
|
||||
{% endif %}
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ The first step to securing a repository is to set up who can see and modify your
|
|||
|
||||
From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %}Settings**, then scroll down to the "Danger Zone."
|
||||
|
||||
- To change who can view your repository, click **Change visibility**. For more information, see "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)."{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5974 %}
|
||||
- To change who can view your repository, click **Change visibility**. For more information, see "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)."{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
- To change who can access your repository and adjust permissions, click **Manage access**. For more information, see"[Managing teams and people with access to your repository](/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository)."{% endif %}
|
||||
|
||||
## Setting a security policy
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ topics:
|
|||
|
||||
If your project communicates with an external service, you might use a token or private key for authentication. Tokens and private keys are examples of secrets that a service provider can issue. If you check a secret into a repository, anyone who has read access to the repository can use the secret to access the external service with your privileges. We recommend that you store secrets in a dedicated, secure location outside of the repository for your project.
|
||||
|
||||
{% data variables.product.prodname_secret_scanning_caps %} will scan your entire Git history on all branches present in your {% data variables.product.prodname_dotcom %} repository for secrets{% ifversion ghec or ghes > 3.4 or ghae-issue-6329 %}, even if the repository is archived{% endif %}.
|
||||
{% data variables.product.prodname_secret_scanning_caps %} will scan your entire Git history on all branches present in your {% data variables.product.prodname_dotcom %} repository for secrets{% ifversion ghec or ghes > 3.4 or ghae > 3.4 %}, even if the repository is archived{% endif %}.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
{% data variables.product.prodname_secret_scanning_caps %} is available on {% data variables.product.prodname_dotcom_the_website %} in two forms:
|
||||
|
|
@ -70,7 +70,7 @@ You cannot change the configuration of {% data variables.product.prodname_secret
|
|||
|
||||
{% data variables.product.prodname_secret_scanning_GHAS_caps %} is available on all organization-owned repositories as part of {% data variables.product.prodname_GH_advanced_security %}. It is not available on user-owned repositories. When you enable {% data variables.product.prodname_secret_scanning %} for a repository, {% data variables.product.prodname_dotcom %} scans the code for patterns that match secrets used by many service providers. For more information, see "{% ifversion ghec %}[Supported secrets for advanced security](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security){% else %}[{% data variables.product.prodname_secret_scanning_caps %} patterns](/code-security/secret-scanning/secret-scanning-patterns){% endif %}."
|
||||
|
||||
If you're a repository administrator you can enable {% data variables.product.prodname_secret_scanning_GHAS %} for any repository{% ifversion ghec or ghes > 3.4 or ghae-issue-6329 %}, including archived repositories{% endif %}. Organization owners can also enable {% data variables.product.prodname_secret_scanning_GHAS %} for all repositories or for all new repositories within an organization. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)."
|
||||
If you're a repository administrator you can enable {% data variables.product.prodname_secret_scanning_GHAS %} for any repository{% ifversion ghec or ghes > 3.4 or ghae > 3.4 %}, including archived repositories{% endif %}. Organization owners can also enable {% data variables.product.prodname_secret_scanning_GHAS %} for all repositories or for all new repositories within an organization. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)."
|
||||
|
||||
{% ifversion ghes or ghae or ghec %}You can also define custom {% data variables.product.prodname_secret_scanning %} patterns for a repository, organization, or enterprise. For more information, see "[Defining custom patterns for {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)."
|
||||
{% endif %}
|
||||
|
|
@ -91,12 +91,12 @@ For more information about viewing and resolving {% data variables.product.prodn
|
|||
|
||||
Repository administrators and organization owners can grant users and teams access to {% data variables.product.prodname_secret_scanning %} alerts. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."
|
||||
|
||||
{% ifversion ghec or ghes or ghae-issue-5503 %}
|
||||
{% ifversion ghec or ghes or ghae > 3.4 %}
|
||||
You can use the security overview to see an organization-level view of which repositories have enabled {% data variables.product.prodname_secret_scanning %} and the alerts found. For more information, see "[Viewing the security overview](/code-security/security-overview/viewing-the-security-overview)."
|
||||
{% endif %}
|
||||
|
||||
{%- ifversion ghec or ghes %}You can also use the REST API to {% endif %}
|
||||
monitor results from {% data variables.product.prodname_secret_scanning %} across your {% ifversion ghec %}private {% endif %}repositories{% ifversion ghes %} or your organization{% endif %}. For more information about API endpoints, see "[{% data variables.product.prodname_secret_scanning_caps %}](/rest/reference/secret-scanning)."
|
||||
{%- ifversion ghec or ghes or ghae %}You can also use the REST API to
|
||||
monitor results from {% data variables.product.prodname_secret_scanning %} across your {% ifversion ghec %}private {% endif %}repositories{% ifversion ghes %} or your organization{% endif %}. For more information about API endpoints, see "[{% data variables.product.prodname_secret_scanning_caps %}](/rest/reference/secret-scanning)."{% endif %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ topics:
|
|||
You can define custom patterns to identify secrets that are not detected by the default patterns supported by {% data variables.product.prodname_secret_scanning %}. For example, you might have a secret pattern that is internal to your organization. For details of the supported secrets and service providers, see "[{% data variables.product.prodname_secret_scanning_caps %} patterns](/code-security/secret-scanning/secret-scanning-patterns)."
|
||||
|
||||
You can define custom patterns for your enterprise, organization, or repository. {% data variables.product.prodname_secret_scanning_caps %} supports up to
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-7297 %} 500 custom patterns for each organization or enterprise account, and up to 100 custom patterns per repository.
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %} 500 custom patterns for each organization or enterprise account, and up to 100 custom patterns per repository.
|
||||
{%- elsif ghes = 3.2 %} 20 custom patterns for each organization or enterprise account, and per repository.
|
||||
{%- else %} 100 custom patterns for each organization or enterprise account, and 20 per repository.
|
||||
{%- endif %}
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ The security overview displays active alerts raised by security features. If the
|
|||
|
||||
At the organization-level, the security overview displays aggregate and repository-specific security information for repositories owned by your organization. You can filter information by security features at the organization-level.
|
||||
|
||||
{% ifversion ghec or ghes > 3.4 or ghae-issue-6199 %}
|
||||
{% ifversion ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
### About the enterprise-level security overview
|
||||
At the enterprise-level, the security overview displays aggregate and repository-specific security information for your enterprise. You can view repositories owned by your enterprise that have security alerts, view all security alerts, or security feature-specific alerts from across your enterprise.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ intro: Navigate to the different views available in the security overview
|
|||
permissions: '{% data reusables.security-overview.permissions %}'
|
||||
product: '{% data reusables.gated-features.security-overview %}'
|
||||
versions:
|
||||
ghae: issue-5503
|
||||
ghae: '>= 3.5'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
type: how_to
|
||||
|
|
@ -43,7 +43,7 @@ shortTitle: View the security overview
|
|||
2. Optionally, filter the list of alerts. Each view has its own selection of available filters. You can click multiple filters in the drop-down filter menus to narrow your search. You can also type search qualifiers in the search field. For more information about the available qualifiers, see "[Filtering alerts in the security overview](/code-security/security-overview/filtering-alerts-in-the-security-overview)."
|
||||
|
||||
|
||||
{% ifversion ghec or ghes > 3.4 or ghae-issue-6199 %}
|
||||
{% ifversion ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
## Viewing the security overview for an enterprise
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ For more information on supply chain features available on {% data variables.pro
|
|||
The dependency review feature becomes available when you enable the dependency graph. For more information, see "{% ifversion ghec %}[Enabling the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph#enabling-the-dependency-graph){% elsif ghes %}[Enabling the dependency graph for your enterprise](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise){% endif %}."
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6396 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.5 or ghae > 3.5 %}
|
||||
## Dependency review enforcement
|
||||
|
||||
{% data reusables.dependency-review.dependency-review-action-beta-note %}
|
||||
|
|
|
|||
|
|
@ -85,7 +85,7 @@ The recommended formats explicitly define which versions are used for all direct
|
|||
| Maven | Java, Scala | `pom.xml` | `pom.xml` |
|
||||
| npm | JavaScript | `package-lock.json` | `package-lock.json`, `package.json`|
|
||||
| pip | Python | `requirements.txt`, `pipfile.lock` | `requirements.txt`, `pipfile`, `pipfile.lock`, `setup.py`<sup>[‡]</sup> |
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4752 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
| Python Poetry | Python | `poetry.lock` | `poetry.lock`, `pyproject.toml` |
|
||||
{%- endif %}
|
||||
| RubyGems | Ruby | `Gemfile.lock` | `Gemfile.lock`, `Gemfile`, `*.gemspec` |
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ You can link to an image in a repository on {% data variables.product.product_na
|
|||
|
||||
[[https://github.com/USERNAME/REPOSITORY/blob/main/img/octocat.png|alt=octocat]]
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.6 or ghae-issue-7647 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.6 or ghae > 3.6 %}
|
||||
## Adding mathematical expressions and diagrams{% endif %}
|
||||
|
||||
{% data reusables.getting-started.math-and-diagrams %}
|
||||
|
|
|
|||
|
|
@ -1330,7 +1330,7 @@ Key | Type | Description
|
|||
{{ webhookPayloadsForCurrentVersion.secret_scanning_alert.reopened }}
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghes > 3.4 or ghec or ghae-issue-6581 %}
|
||||
{% ifversion ghes > 3.4 or ghec or ghae > 3.4 %}
|
||||
## secret_scanning_alert_location
|
||||
|
||||
{% data reusables.webhooks.secret_scanning_alert_location_event_short_desc %}
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ A {% data variables.product.prodname_GH_advanced_security %} license provides th
|
|||
- **Dependency review** - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)."
|
||||
|
||||
{% ifversion ghes < 3.7 or ghae %}
|
||||
<!-- Ref: ghae-issue-7114 remove GHAE versioning from this section when the `security-overview-displayed-alerts` flag is toggled for GHAE -->
|
||||
<!-- Ref: ghae > 3.6 remove GHAE versioning from this section when the `security-overview-displayed-alerts` flag is toggled for GHAE -->
|
||||
- **Security overview** - Review the security configuration and alerts for an organization and identify the repositories at greatest risk. For more information, see "[About the security overview](/code-security/security-overview/about-the-security-overview)."
|
||||
{% endif %}
|
||||
|
||||
|
|
|
|||
|
|
@ -89,8 +89,8 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|
|||
|-----------|------------
|
||||
|<kbd>Command</kbd>+<kbd>B</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>B</kbd> (Windows/Linux) | Inserts Markdown formatting for bolding text
|
||||
|<kbd>Command</kbd>+<kbd>I</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux) | Inserts Markdown formatting for italicizing text
|
||||
|<kbd>Command</kbd>+<kbd>E</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>E</kbd> (Windows/Linux) | Inserts Markdown formatting for code or a command within a line{% ifversion fpt or ghae-issue-5434 or ghes or ghec %}
|
||||
|<kbd>Command</kbd>+<kbd>K</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>K</kbd> (Windows/Linux) | Inserts Markdown formatting for creating a link{% endif %}{% ifversion fpt or ghae-issue-7103 or ghes > 3.5 or ghec %}
|
||||
|<kbd>Command</kbd>+<kbd>E</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>E</kbd> (Windows/Linux) | Inserts Markdown formatting for code or a command within a line{% ifversion fpt or ghae > 3.3 or ghes or ghec %}
|
||||
|<kbd>Command</kbd>+<kbd>K</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>K</kbd> (Windows/Linux) | Inserts Markdown formatting for creating a link{% endif %}{% ifversion fpt or ghae > 3.5 or ghes > 3.5 or ghec %}
|
||||
|<kbd>Command</kbd>+<kbd>V</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>V</kbd> (Windows/Linux) | Creates a Markdown link when applied over highlighted text{% endif %}
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux) | Toggles between the **Write** and **Preview** comment tabs{% ifversion fpt or ghae or ghes > 3.4 or ghec %}
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> (Windows/Linux) | Pastes HTML link as plain text{% endif %}{% ifversion fpt or ghae or ghes > 3.2 or ghec %}
|
||||
|
|
|
|||
|
|
@ -116,9 +116,9 @@ Here are the currently supported color models.
|
|||
|
||||
## Links
|
||||
|
||||
You can create an inline link by wrapping link text in brackets `[ ]`, and then wrapping the URL in parentheses `( )`. You can also use the keyboard shortcut <kbd>Command</kbd>+<kbd>K</kbd> to create a link.{% ifversion fpt or ghae-issue-5434 or ghes > 3.3 or ghec %} When you have text selected, you can paste a URL from your clipboard to automatically create a link from the selection.{% endif %}
|
||||
You can create an inline link by wrapping link text in brackets `[ ]`, and then wrapping the URL in parentheses `( )`. You can also use the keyboard shortcut <kbd>Command</kbd>+<kbd>K</kbd> to create a link.{% ifversion fpt or ghae > 3.3 or ghes > 3.3 or ghec %} When you have text selected, you can paste a URL from your clipboard to automatically create a link from the selection.{% endif %}
|
||||
|
||||
{% ifversion fpt or ghae-issue-7103 or ghes > 3.5 or ghec %} You can also create a Markdown hyperlink by highlighting the text and using the keyboard shortcut <kbd>Command</kbd>+<kbd>V</kbd>. If you'd like to replace the text with the link, use the keyboard shortcut <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd>.{% endif %}
|
||||
{% ifversion fpt or ghae > 3.5 or ghes > 3.5 or ghec %} You can also create a Markdown hyperlink by highlighting the text and using the keyboard shortcut <kbd>Command</kbd>+<kbd>V</kbd>. If you'd like to replace the text with the link, use the keyboard shortcut <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd>.{% endif %}
|
||||
|
||||
`This site was built using [GitHub Pages](https://pages.github.com/).`
|
||||
|
||||
|
|
@ -172,7 +172,7 @@ Here are some examples for using relative links to display an image.
|
|||
|
||||
For more information, see "[Relative Links](#relative-links)."
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5559 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
### Specifying the theme an image is shown to
|
||||
|
||||
You can specify the theme an image is displayed for in Markdown by using the HTML `<picture>` element in combination with the `prefers-color-scheme` media feature. We distinguish between light and dark color modes, so there are two options available. You can use these options to display images optimized for dark or light backgrounds. This is particularly helpful for transparent PNG images.
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ To enable clear communication of mathematical expressions, {% data variables.pro
|
|||
|
||||
{% data variables.product.company_short %}'s math rendering capability uses MathJax; an open source, JavaScript-based display engine. MathJax supports a wide range of LaTeX macros, and several useful accessibility extensions. For more information, see [the MathJax documentation](http://docs.mathjax.org/en/latest/input/tex/index.html#tex-and-latex-support) and [the MathJax Accessibility Extensions Documentation](https://mathjax.github.io/MathJax-a11y/docs/#reader-guide).
|
||||
|
||||
Mathematical expressions rendering is available in {% data variables.product.prodname_github_issues %}, {% data variables.product.prodname_discussions %}, pull requests, {% ifversion fpt or ghec or ghes > 3.6 or ghae-issue-7647 %}wikis, {% endif %}and Markdown files.
|
||||
Mathematical expressions rendering is available in {% data variables.product.prodname_github_issues %}, {% data variables.product.prodname_discussions %}, pull requests, {% ifversion fpt or ghec or ghes > 3.6 or ghae > 3.6 %}wikis, {% endif %}and Markdown files.
|
||||
|
||||
## Writing inline expressions
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ intro: You can create a branch to work on an issue directly from the issue page
|
|||
versions:
|
||||
fpt: '*'
|
||||
ghes: '>=3.5'
|
||||
ghae: issue-6234
|
||||
ghae: '>= 3.5'
|
||||
ghec: '*'
|
||||
allowTitleToDifferFromFilename: true
|
||||
topics:
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ You can manually link up to ten issues to each pull request. The issue and pull
|
|||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-pr %}
|
||||
3. In the list of pull requests, click the pull request that you'd like to link to an issue.
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6234 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
4. In the right sidebar, in the "Development" section click {% octicon "gear" aria-label="The Gear icon" %}.
|
||||
{% else %}
|
||||
4. In the right sidebar, click **Linked issues**.
|
||||
|
|
|
|||
|
|
@ -831,7 +831,7 @@ For more information, see "[Managing the publication of {% data variables.produc
|
|||
{% data reusables.actions.actions-audit-events-workflow %}
|
||||
## Further reading
|
||||
|
||||
- "[Keeping your organization secure](/articles/keeping-your-organization-secure)"{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5146 %}
|
||||
- "[Keeping your organization secure](/articles/keeping-your-organization-secure)"{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
{%- ifversion fpt or ghec %}
|
||||
- "[Exporting member information for your organization](/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization)"{% endif %}
|
||||
{%- endif %}
|
||||
|
|
@ -19,7 +19,7 @@ shortTitle: Review installed integrations
|
|||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
1. In the "Integrations" section of the sidebar, click **{% octicon "apps" aria-label="The apps icon" %} {% data variables.product.prodname_github_apps %}**.
|
||||
{% else %}
|
||||
1. In the left sidebar, click **Installed {% data variables.product.prodname_github_apps %}**.
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ If your organization requires two-factor authentication, all outside collaborato
|
|||
|
||||
## Adding outside collaborators to a repository
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5974 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
You can give outside collaborators access to a repository in your repository settings. For more information, see "[Managing teams and people with access to your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository#inviting-a-team-or-person)."
|
||||
{% else %}
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ When you remove a collaborator from a repository in your organization, the colla
|
|||
|
||||
{% data reusables.repositories.deleted_forks_from_private_repositories_warning %}
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5974 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
## Managing an individual's access to an organization repository
|
||||
You can give a person access to a repository or change a person's level of access to a repository in your repository settings. For more information, see "[Managing teams and people with access to your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)."
|
||||
{% else %}
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ People with admin access to a repository can manage team access to the repositor
|
|||
|
||||
## Giving a team access to a repository
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5974 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
You can give a team access to a repository or change a team's level of access to a repository in your repository settings. For more information, see "[Managing teams and people with access to your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository#inviting-a-team-or-person)."
|
||||
{% else %}
|
||||
{% data reusables.profile.access_org %}
|
||||
|
|
@ -44,7 +44,7 @@ You can give a team access to a repository or change a team's level of access to
|
|||
{% endif %}
|
||||
## Removing a team's access to a repository
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5974 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
You can remove a team's access to an organization repository in your repository settings. For more information, see "[Managing teams and people with access to your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository#removing-access-for-a-team-or-person)."
|
||||
|
||||
If a team has direct access to a repository, you can remove that team's access to the repository. If a team's access to the repository is inherited from a parent team, you must remove the repository from the parent team in order to remove the repository from child teams.
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@ If you only want to remove an outside collaborator from certain repositories in
|
|||
8. To confirm, click **Remove access**.
|
||||
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5974 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
You can also remove an outside collaborator from a repository in the access overview in your repository settings. For more information, see "[Managing teams and people with access to your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository#removing-access-for-a-team-or-person)."
|
||||
{% endif %}
|
||||
## Further reading
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ From least access to most access, the roles for an organization repository are:
|
|||
|
||||
{% ifversion fpt %}
|
||||
If your organization uses {% data variables.product.prodname_ghe_cloud %}, you can create custom repository roles. For more information, see "[Managing custom repository roles for an organization](/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)" in the {% data variables.product.prodname_ghe_cloud %} documentation.
|
||||
{% elsif ghec or ghes > 3.4 or ghae-issue-6271 %}
|
||||
{% elsif ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
You can create custom repository roles. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."
|
||||
{% endif %}
|
||||
|
||||
|
|
@ -111,7 +111,7 @@ Some of the features listed below are limited to organizations using {% data var
|
|||
| Configure [a publishing source for {% data variables.product.prodname_pages %}](/articles/configuring-a-publishing-source-for-github-pages) | | | | **✔️** | **✔️** |
|
||||
| [Manage branch protection rules](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule) | | | | | **✔️** |
|
||||
| [Push to protected branches](/articles/about-protected-branches) | | | | **✔️** | **✔️** |
|
||||
| Merge pull requests on protected branches, even if there are no approving reviews | | | | | **✔️** |{% ifversion fpt or ghes > 3.4 or ghae-issue-6337 or ghec %}
|
||||
| Merge pull requests on protected branches, even if there are no approving reviews | | | | | **✔️** |{% ifversion fpt or ghes > 3.4 or ghae > 3.4 or ghec %}
|
||||
| Create tags that match a [tag protection rule](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules) | | | | **✔️** | **✔️** |
|
||||
| Delete tags that match a [tag protection rule](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules) | | | | | **✔️** |{% endif %}
|
||||
| [Create and edit repository social cards](/articles/customizing-your-repositorys-social-media-preview) | | | | **✔️** | **✔️** |{% ifversion fpt or ghec %}
|
||||
|
|
|
|||
|
|
@ -24,14 +24,14 @@ You can use this information to help off-board people, gather data for complianc
|
|||
Organizations that use {% data variables.product.prodname_ghe_cloud %} can also export a CSV list of people who have access to a repository. For more information, see [the {% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/organizations/managing-access-to-your-organizations-repositories/viewing-people-with-access-to-your-repository).
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5974 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
|
||||
{% else %}
|
||||
|
||||
{% endif %}
|
||||
## Viewing people with access to your repository
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5974 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
You can see a combined overview of teams and people with access to your repository in your repository settings. For more information, see "[Managing teams and people with access to your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository#about-access-management-for-repositories)."
|
||||
{% else %}
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ When you disable project boards, you will no longer see project board informatio
|
|||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
1. In the "Code planning, and automation" section of the sidebar, click **{% octicon "table" aria-label="The table icon" %} Projects**.
|
||||
{% endif %}
|
||||
1. Decide whether to disable organization-wide project boards, disable repository project boards in the organization, or both. Then, under "Projects":
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ versions:
|
|||
ghae: '*'
|
||||
shortTitle: Integrate Jira
|
||||
---
|
||||
{% ifversion ghes > 3.4 or ghae-issue-5658 %}
|
||||
{% ifversion ghes > 3.4 or ghae > 3.4 %}
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
1. In the left sidebar, select **{% octicon "code" aria-label="The code icon" %} Developer settings**, then click **OAuth Apps**.
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ Members of a team with the security manager role have only the permissions requi
|
|||
Additional functionality, including a security overview for the organization, is available in organizations that use {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_advanced_security %}. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).
|
||||
{% endif %}
|
||||
|
||||
If a team has the security manager role, people with admin access to the team and a specific repository can change the team's level of access to that repository but cannot remove the access. For more information, see "[Managing team access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository){% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5974 %}" and "[Managing teams and people with access to your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)."{% else %}."{% endif %}
|
||||
If a team has the security manager role, people with admin access to the team and a specific repository can change the team's level of access to that repository but cannot remove the access. For more information, see "[Managing team access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository){% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}" and "[Managing teams and people with access to your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)."{% else %}."{% endif %}
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ Any team members that have set their status to "Busy" will not be selected for r
|
|||
{% data reusables.user-settings.access_org %}
|
||||
{% data reusables.organizations.specific_team %}
|
||||
{% data reusables.organizations.team_settings %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
1. In the left sidebar, click **{% octicon "code-review" aria-label="The code-review icon" %} Code review**.
|
||||
{% else %}
|
||||
1. In the left sidebar, click **Code review**
|
||||
|
|
@ -69,7 +69,7 @@ Any team members that have set their status to "Busy" will not be selected for r
|
|||
{% data reusables.user-settings.access_org %}
|
||||
{% data reusables.organizations.specific_team %}
|
||||
{% data reusables.organizations.team_settings %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
1. In the left sidebar, click **{% octicon "code-review" aria-label="The code-review icon" %} Code review**.
|
||||
{% else %}
|
||||
1. In the left sidebar, click **Code review**
|
||||
|
|
@ -86,7 +86,7 @@ Any team members that have set their status to "Busy" will not be selected for r
|
|||
{% ifversion ghes < 3.4 %}
|
||||
1. Optionally, to only notify the team members chosen by code review assignment for each pull review request, under "Notifications" select **If assigning team members, don't notify the entire team.**
|
||||
{%- endif %}
|
||||
{% ifversion fpt or ghec or ghae-issue-5108 or ghes > 3.2 %}
|
||||
{% ifversion fpt or ghec or ghae > 3.3 or ghes > 3.2 %}
|
||||
1. Optionally, to include members of child teams as potential reviewers when assigning requests, select **Child team members**.
|
||||
1. Optionally, to count any members whose review has already been requested against the total number of members to assign, select **Count existing requests**.
|
||||
1. Optionally, to remove the review request from the team when assigning team members, select **Team review request**.
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ If the branch you want to delete is associated with an open pull request, you mu
|
|||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.navigate-to-branches %}
|
||||
1. Scroll to the branch that you want to delete, then click {% octicon "trash" aria-label="The trash icon to delete the branch" %}.
|
||||
 {% ifversion fpt or ghes > 3.5 or ghae-issue-6763 or ghec %}
|
||||
 {% ifversion fpt or ghes > 3.5 or ghae > 3.5 or ghec %}
|
||||
1. If you try to delete a branch that is associated with at least one open pull request, you must confirm that you intend to close the pull request(s).
|
||||
|
||||
{% endif %}
|
||||
|
|
|
|||
|
|
@ -20,13 +20,13 @@ You can update a pull request's head branch from the command line or the pull re
|
|||
|
||||
* There are no merge conflicts between the pull request branch and the base branch.
|
||||
* The pull request branch is not up to date with the base branch.
|
||||
* The base branch requires branches to be up to date before merging{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6069 %} or the setting to always suggest updating branches is enabled{% endif %}.
|
||||
* The base branch requires branches to be up to date before merging{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %} or the setting to always suggest updating branches is enabled{% endif %}.
|
||||
|
||||
For more information, see "[Require status checks before merging](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches){% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6069 %}" and "[Managing suggestions to update pull request branches](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches){% endif %}."
|
||||
For more information, see "[Require status checks before merging](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches){% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}" and "[Managing suggestions to update pull request branches](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches){% endif %}."
|
||||
|
||||
If there are changes to the base branch that cause merge conflicts in your pull request branch, you will not be able to update the branch until all conflicts are resolved. For more information, see "[About merge conflicts](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)."
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6069 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
From the pull request page you can update your pull request's branch using a traditional merge or by rebasing. A traditional merge results in a merge commit that merges the base branch into the head branch of the pull request. Rebasing applies the changes from _your_ branch onto the latest version of the base branch. The result is a branch with a linear history, since no merge commit is created.
|
||||
{% else %}
|
||||
Updating your branch from the pull request page performs a traditional merge. The resulting merge commit merges the base branch into the head branch of the pull request.
|
||||
|
|
@ -38,7 +38,7 @@ Updating your branch from the pull request page performs a traditional merge. Th
|
|||
|
||||
1. In the "Pull requests" list, click the pull request you'd like to update.
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6069 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
1. In the merge section near the bottom of the page, you can:
|
||||
- Click **Update branch** to perform a traditional merge.
|
||||
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ shortTitle: Review dependency changes
|
|||
|
||||
Dependency review allows you to "shift left". You can use the provided predictive information to catch vulnerable dependencies before they hit production. For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)."
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6396 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.5 or ghae > 3.5 %}
|
||||
|
||||
You can use the {% data variables.product.prodname_dependency_review_action %} to help enforce dependency reviews on pull requests in your repository. {% data reusables.dependency-review.dependency-review-action-overview %}
|
||||
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ topics:
|
|||
{% endnote %}
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghec or ghes > 3.4 or ghae-issue-6329 %}
|
||||
{% ifversion ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
{% note %}
|
||||
|
||||
**Note:** Customers who use {% data variables.product.prodname_GH_advanced_security %} can enable {% data variables.product.prodname_secret_scanning %} on archived repositories. For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/about-secret-scanning#about-secret-scanning-for-private-repositories)."
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ shortTitle: Configure commit merging
|
|||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
1. Under {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select **Allow merge commits**. This allows contributors to merge a pull request with a full history of commits.{% ifversion default-merge-squash-commit-message %}
|
||||
1. Under {% ifversion fpt or ghec or ghes > 3.5 or ghae > 3.4 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select **Allow merge commits**. This allows contributors to merge a pull request with a full history of commits.{% ifversion default-merge-squash-commit-message %}
|
||||
{% endif %}{% ifversion ghes = 3.6 %}
|
||||
{% endif %}
|
||||
{% ifversion ghes < 3.6 %}
|
||||
|
|
|
|||
|
|
@ -18,11 +18,11 @@ shortTitle: Configure commit rebasing
|
|||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
3. Under {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select **Allow rebase merging**. This allows contributors to merge a pull request by rebasing their individual commits onto the base branch.
|
||||
3. Under {% ifversion fpt or ghec or ghes > 3.5 or ghae > 3.4 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select **Allow rebase merging**. This allows contributors to merge a pull request by rebasing their individual commits onto the base branch.
|
||||
{% ifversion default-merge-squash-commit-message %}
|
||||
{% endif %}{% ifversion ghes = 3.6 %}
|
||||
{% endif %}
|
||||
{% ifversion ghes < 3.6 %}
|
||||
{% endif %}
|
||||
|
||||
If you also select another merge method, collaborators will be able to choose the type of merge commit when merging a pull request. {% data reusables.repositories.squash-and-rebase-linear-commit-history %}
|
||||
If you also select another merge method, collaborators will be able to choose the type of merge commit when merging a pull request. {% data reusables.repositories.squash-and-rebase-linear-commit-history %}
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ shortTitle: Configure commit squashing
|
|||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
1. Under {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select **Allow squash merging**. This allows contributors to merge a pull request by squashing all commits into a single commit. The default commit message presented to contributors when merging is the commit title and message if the pull request contains only 1 commit, or the pull request title and list of commits if the pull request contains 2 or more commits. {% ifversion ghes = 3.6 %} To always use the title of the pull request regardless of the number of commits in the pull request select **Default to PR title for squash merge commits**.{% endif %}{% ifversion default-merge-squash-commit-message %}
|
||||
1. Under {% ifversion fpt or ghec or ghes > 3.5 or ghae > 3.4 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select **Allow squash merging**. This allows contributors to merge a pull request by squashing all commits into a single commit. The default commit message presented to contributors when merging is the commit title and message if the pull request contains only 1 commit, or the pull request title and list of commits if the pull request contains 2 or more commits. {% ifversion ghes = 3.6 %} To always use the title of the pull request regardless of the number of commits in the pull request select **Default to PR title for squash merge commits**.{% endif %}{% ifversion default-merge-squash-commit-message %}
|
||||
{% endif %}{% ifversion ghes = 3.6 %}
|
||||
{% endif %}
|
||||
{% ifversion ghes < 3.6 %}
|
||||
|
|
|
|||
|
|
@ -25,5 +25,5 @@ If you allow auto-merge for pull requests in your repository, people with write
|
|||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
1. Under {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6069 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select or deselect **Allow auto-merge**.
|
||||
1. Under {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select or deselect **Allow auto-merge**.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ intro: You can give users the ability to always update a pull request branch whe
|
|||
versions:
|
||||
fpt: '*'
|
||||
ghes: '> 3.4'
|
||||
ghae: issue-6069
|
||||
ghae: '>= 3.5'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Anyone with admin permissions to a repository can enable or disable the automati
|
|||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
3. Under {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6069 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select or unselect **Automatically delete head branches**.
|
||||
3. Under {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select or unselect **Automatically delete head branches**.
|
||||
|
||||
|
||||
## Further reading
|
||||
|
|
|
|||
|
|
@ -92,7 +92,7 @@ Before you can enable required status checks, you must configure the repository
|
|||
|
||||
After enabling required status checks, all required status checks must pass before collaborators can merge changes into the protected branch. After all required status checks pass, any commits must either be pushed to another branch and then merged or pushed directly to the protected branch.
|
||||
|
||||
Any person or integration with write permissions to a repository can set the state of any status check in the repository{% ifversion fpt or ghes > 3.3 or ghae-issue-5379 or ghec %}, but in some cases you may only want to accept a status check from a specific {% data variables.product.prodname_github_app %}. When you add a required status check, you can select an app that has recently set this check as the expected source of status updates.{% endif %} If the status is set by any other person or integration, merging won't be allowed. If you select "any source", you can still manually verify the author of each status, listed in the merge box.
|
||||
Any person or integration with write permissions to a repository can set the state of any status check in the repository{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}, but in some cases you may only want to accept a status check from a specific {% data variables.product.prodname_github_app %}. When you add a required status check, you can select an app that has recently set this check as the expected source of status updates.{% endif %} If the status is set by any other person or integration, merging won't be allowed. If you select "any source", you can still manually verify the author of each status, listed in the merge box.
|
||||
|
||||
You can set up required status checks to either be "loose" or "strict." The type of required status check you choose determines whether your branch is required to be up to date with the base branch before merging.
|
||||
|
||||
|
|
@ -177,7 +177,7 @@ You can only give push access to a protected branch, or give permission to creat
|
|||
|
||||
### Allow force pushes
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5624 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
By default, {% data variables.product.product_name %} blocks force pushes on all protected branches. When you enable force pushes to a protected branch, you can choose one of two groups who can force push:
|
||||
|
||||
1. Allow everyone with at least write permissions to the repository to force push to the branch, including those with admin permissions.
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ When you create a branch rule, the branch you specify doesn't have to exist yet
|
|||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.repositories.repository-branches %}
|
||||
{% data reusables.repositories.add-branch-protection-rules %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5506 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
1. Optionally, enable required pull requests.
|
||||
- Under "Protect matching branches", select **Require a pull request before merging**.
|
||||
|
||||
|
|
@ -67,7 +67,7 @@ When you create a branch rule, the branch you specify doesn't have to exist yet
|
|||
|
||||
- Optionally, to require review from a code owner when the pull request affects code that has a designated owner, select **Require review from Code Owners**. For more information, see "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)."
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5611 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
- Optionally, to allow specific actors to push code to the branch without creating pull requests when they're required, select **Allow specified actors to bypass required pull requests**. Then, search for and select the actors who should be allowed to skip creating a pull request.
|
||||
![Allow specific actors to bypass pull request requirements checkbox]{% ifversion integration-branch-protection-exceptions %}(/assets/images/help/repository/PR-bypass-requirements-with-apps.png){% else %}(/assets/images/help/repository/PR-bypass-requirements.png){% endif %}
|
||||
{% endif %}
|
||||
|
|
@ -111,7 +111,7 @@ When you create a branch rule, the branch you specify doesn't have to exist yet
|
|||
![Branch restriction search]{% ifversion restrict-pushes-create-branch %}(/assets/images/help/repository/restrict-branch-search-with-create.png){% else %}(/assets/images/help/repository/restrict-branch-search.png){% endif %}
|
||||
1. Optionally, under "Rules applied to everyone including administrators", select **Allow force pushes**.
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5624 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
Then, choose who can force push to the branch.
|
||||
- Select **Everyone** to allow everyone with at least write permissions to the repository to force push to the branch, including those with admin permissions.
|
||||
- Select **Specify who can force push** to allow only specific actors to force push to the branch. Then, search for and select those actors.
|
||||
|
|
|
|||
|
|
@ -111,7 +111,7 @@ Now the checks will always pass whenever someone sends a pull request that doesn
|
|||
|
||||
{% endnote %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-5379 or ghec %}It's also possible for a protected branch to require a status check from a specific {% data variables.product.prodname_github_app %}. If you see a message similar to the following, then you should verify that the check listed in the merge box was set by the expected app.
|
||||
{% ifversion fpt or ghes > 3.3 or ghae > 3.3 or ghec %}It's also possible for a protected branch to require a status check from a specific {% data variables.product.prodname_github_app %}. If you see a message similar to the following, then you should verify that the check listed in the merge box was set by the expected app.
|
||||
|
||||
```
|
||||
Required status check "build" was not set by the expected {% data variables.product.prodname_github_app %}.
|
||||
|
|
|
|||
|
|
@ -140,7 +140,7 @@ By default, when you create a new repository in your personal account, workflows
|
|||
1. Click **Save** to apply the settings.
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghes > 3.3 or ghae-issue-4757 or ghec %}
|
||||
{% ifversion ghes > 3.3 or ghae > 3.3 or ghec %}
|
||||
## Allowing access to components in an internal repository
|
||||
|
||||
Members of your enterprise can use internal repositories to work on projects without sharing information publicly. For information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-internal-repositories)."
|
||||
|
|
@ -152,11 +152,11 @@ You can use the steps below to configure whether {% ifversion internal-actions%}
|
|||
{% data reusables.repositories.settings-sidebar-actions-general %}
|
||||
1. Under **Access**, choose one of the access settings:
|
||||
|
||||
{% ifversion ghes > 3.4 or ghae-issue-6090 or ghec %}{% else %}{% endif %}
|
||||
{% ifversion ghes > 3.4 or ghae > 3.4 or ghec %}{% else %}{% endif %}
|
||||
|
||||
* **Not accessible** - Workflows in other repositories cannot access this repository.
|
||||
* **Accessible from repositories in the 'ORGANIZATION NAME' organization** - {% ifversion ghes > 3.4 or ghae-issue-6090 or ghec %}Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same organization and their visibility is private or internal.{% endif %}
|
||||
* **Accessible from repositories in the 'ENTERPRISE NAME' enterprise** - {% ifversion ghes > 3.4 or ghae-issue-6090 or ghec %}Workflows in other repositories that are part of the 'ENTERPRISE NAME' enterprise can access the actions and workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same enterprise and their visibility is private or internal.{% endif %}
|
||||
* **Accessible from repositories in the 'ORGANIZATION NAME' organization** - {% ifversion ghes > 3.4 or ghae > 3.4 or ghec %}Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same organization and their visibility is private or internal.{% endif %}
|
||||
* **Accessible from repositories in the 'ENTERPRISE NAME' enterprise** - {% ifversion ghes > 3.4 or ghae > 3.4 or ghec %}Workflows in other repositories that are part of the 'ENTERPRISE NAME' enterprise can access the actions and workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same enterprise and their visibility is private or internal.{% endif %}
|
||||
1. Click **Save** to apply the settings.
|
||||
{% endif %}
|
||||
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ You can manage the security and analysis features for your {% ifversion fpt or g
|
|||
{% ifversion fpt or ghes or ghec %}
|
||||
4. Under "Code security and analysis", to the right of the feature, click **Disable** or **Enable**. {% ifversion not fpt %}The control for "{% data variables.product.prodname_GH_advanced_security %}" is disabled if your enterprise has no available licenses for {% data variables.product.prodname_advanced_security %}.{% endif %}{% ifversion fpt %}
|
||||
{% elsif ghec %}
|
||||
{% elsif ghes > 3.6 or ghae-issue-7044 %}<!--Insert screenshot for GHES 3.7 when available-->{% elsif ghes = 3.2 %}
|
||||
{% elsif ghes > 3.6 or ghae > 3.6 %}<!--Insert screenshot for GHES 3.7 when available-->{% elsif ghes = 3.2 %}
|
||||
{% else %}
|
||||
{% endif %}
|
||||
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ This procedure demonstrates how to configure autolinks to reference external res
|
|||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
1. In the "Integrations" section of the sidebar, click **{% octicon "cross-reference" aria-label="The cross-reference icon" %} Autolink references**.
|
||||
{% else %}
|
||||
1. In the left sidebar, click **Autolink references**.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ intro: You can configure tag protection rules for your repository to prevent con
|
|||
product: '{% data reusables.gated-features.tag-protection-rules %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghae: issue-6337
|
||||
ghae: '>= 3.5'
|
||||
ghec: '*'
|
||||
ghes: '>3.4'
|
||||
---
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>3.3'
|
||||
ghae: issue-5974
|
||||
ghae: '>= 3.4'
|
||||
topics:
|
||||
- Repositories
|
||||
shortTitle: Teams & people
|
||||
|
|
@ -32,7 +32,7 @@ For more information about repository roles, see "[Permission levels for a perso
|
|||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
{% data reusables.repositories.click-collaborators-teams %}
|
||||
{% else %}
|
||||
{% data reusables.repositories.navigate-to-manage-access %}
|
||||
|
|
@ -44,7 +44,7 @@ For more information about repository roles, see "[Permission levels for a perso
|
|||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
{% data reusables.repositories.click-collaborators-teams %}
|
||||
{% else %}
|
||||
{% data reusables.repositories.navigate-to-manage-access %}
|
||||
|
|
@ -56,7 +56,7 @@ For more information about repository roles, see "[Permission levels for a perso
|
|||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
{% data reusables.repositories.click-collaborators-teams %}
|
||||
{% else %}
|
||||
{% data reusables.repositories.navigate-to-manage-access %}
|
||||
|
|
@ -71,7 +71,7 @@ For more information about repository roles, see "[Permission levels for a perso
|
|||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
{% data reusables.repositories.click-collaborators-teams %}
|
||||
{% else %}
|
||||
{% data reusables.repositories.navigate-to-manage-access %}
|
||||
|
|
|
|||
|
|
@ -19,10 +19,8 @@ topics:
|
|||
---
|
||||
## About releases
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4974 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
|
||||
{% elsif ghae-issue-4972 %}
|
||||
|
||||
{% else %}
|
||||
|
||||
{% endif %}
|
||||
|
|
@ -35,11 +33,11 @@ You can receive notifications when new releases are published in a repository wi
|
|||
|
||||
Anyone with read access to a repository can view and compare releases, but only people with write permissions to a repository can manage releases. For more information, see "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository)."
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4974 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %}
|
||||
You can manually create release notes while managing a release. Alternatively, you can automatically generate release notes from a default template, or customize your own release notes template. For more information, see "[Automatically generated release notes](/repositories/releasing-projects-on-github/automatically-generated-release-notes)."
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-7054 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.5 or ghae > 3.6 %}
|
||||
When viewing the details for a release, the creation date for each release asset is shown next to the release asset.
|
||||
{% endif %}
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>3.3'
|
||||
ghae: issue-4974
|
||||
ghae: '>= 3.4'
|
||||
topics:
|
||||
- Repositories
|
||||
shortTitle: Automated release notes
|
||||
|
|
|
|||
|
|
@ -16,13 +16,13 @@ redirect_from:
|
|||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.releases %}
|
||||
3. Next to the release you want to use as your base, click **Compare**.
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-4974 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.3 %}
|
||||
|
||||
{% else %}
|
||||
|
||||
{% endif %}
|
||||
4. Use the "Compare" drop-down menu and select the tags you want to compare.
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-4974 %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.3 %}
|
||||
|
||||
{% else %}
|
||||
|
||||
|
|
|
|||
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче