Merge branch 'main' into #1690-codeowners-for-emus
@@ -18,11 +18,8 @@ If you aren't comfortable going through the steps alone, sync up with a docs eng
|
||||
```
|
||||
script/update-enterprise-dates.js
|
||||
```
|
||||
- [ ] Create REST files based on previous version. For example `script/enterprise-server-releases/create-rest-files.js --oldVersion enterprise-server@3.2 --newVersion enterprise-server@3.3`:
|
||||
- [ ] Create REST files based on previous version. Copy the latest GHES version of the dereferenced file from `lib/rest/static/dereferenced` to a new file in the same directory for the new GHES release. Ex, `cp lib/rest/static/dereferenced/ghes-3.4.deref.json lib/rest/static/dereferenced/ghes-3.5.deref.json`. Then run `script/rest/updated-files.js --decorate-only` and check in the resulting files.
|
||||
|
||||
```
|
||||
script/enterprise-server-releases/create-rest-files.js --oldVersion <PLAN@RELEASE> --newVersion <PLAN@RELEASE>
|
||||
```
|
||||
- [ ] Create GraphQL files based on previous version:
|
||||
|
||||
```
|
||||
|
||||
@@ -59,6 +59,7 @@ jobs:
|
||||
IS_INTERNAL_BUILD: ${{ github.repository == 'github/docs-internal' }}
|
||||
# This may also run in forked repositories, not just 'github/docs'
|
||||
IS_PUBLIC_BUILD: ${{ github.repository != 'github/docs-internal' }}
|
||||
NONPROD_REGISTRY_USERNAME: ${{ fromJSON('["ghdocs", "ghdocsinternal"]')[github.repository == 'github/docs-internal'] }}
|
||||
|
||||
steps:
|
||||
- name: 'Az CLI login'
|
||||
@@ -70,7 +71,7 @@ jobs:
|
||||
uses: azure/docker-login@81744f9799e7eaa418697cb168452a2882ae844a
|
||||
with:
|
||||
login-server: ${{ secrets.NONPROD_REGISTRY_SERVER }}
|
||||
username: ${{ secrets.NONPROD_REGISTRY_USERNAME }}
|
||||
username: ${{ env.NONPROD_REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.NONPROD_REGISTRY_PASSWORD }}
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
@@ -205,7 +206,7 @@ jobs:
|
||||
parameters: appName="${{ env.APP_NAME }}"
|
||||
containerImage="${{ env.DOCKER_IMAGE }}"
|
||||
dockerRegistryUrl="${{ secrets.NONPROD_REGISTRY_SERVER }}"
|
||||
dockerRegistryUsername="${{ secrets.NONPROD_REGISTRY_USERNAME }}"
|
||||
dockerRegistryUsername="${{ env.NONPROD_REGISTRY_USERNAME }}"
|
||||
dockerRegistryPassword="${{ secrets.NONPROD_REGISTRY_PASSWORD }}"
|
||||
# this shows warnings in the github actions console, because the flag is passed through a validation run,
|
||||
# but it *is* functional during the actual execution
|
||||
|
||||
@@ -26,6 +26,7 @@ jobs:
|
||||
env:
|
||||
ENABLE_EARLY_ACCESS: ${{ github.repository == 'github/docs-internal' }}
|
||||
DOCKER_IMAGE_CACHE_REF: ${{ secrets.NONPROD_REGISTRY_SERVER }}/${{ github.repository }}:main-preview
|
||||
NONPROD_REGISTRY_USERNAME: ${{ fromJSON('["ghdocs", "ghdocsinternal"]')[github.repository == 'github/docs-internal'] }}
|
||||
|
||||
steps:
|
||||
- name: 'Az CLI login'
|
||||
@@ -37,7 +38,7 @@ jobs:
|
||||
uses: azure/docker-login@81744f9799e7eaa418697cb168452a2882ae844a
|
||||
with:
|
||||
login-server: ${{ secrets.NONPROD_REGISTRY_SERVER }}
|
||||
username: ${{ secrets.NONPROD_REGISTRY_USERNAME }}
|
||||
username: ${{ env.NONPROD_REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.NONPROD_REGISTRY_PASSWORD }}
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
|
||||
2
.github/workflows/repo-sync.yml
vendored
@@ -120,7 +120,7 @@ jobs:
|
||||
github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
|
||||
|
||||
- name: Create pull request
|
||||
uses: repo-sync/pull-request@65194d8015be7624d231796ddee1cd52a5023cb3
|
||||
uses: repo-sync/pull-request@9152b1c4aeeab247ba2ce12c5d7e693d287bf1b9
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
|
||||
with:
|
||||
|
||||
|
After Width: | Height: | Size: 98 KiB |
|
After Width: | Height: | Size: 122 KiB |
BIN
assets/images/help/branches/confirm-deleting-branch.png
Normal file
|
After Width: | Height: | Size: 110 KiB |
|
After Width: | Height: | Size: 47 KiB |
BIN
assets/images/help/codespaces/advanced-options.png
Normal file
|
After Width: | Height: | Size: 118 KiB |
|
Before Width: | Height: | Size: 83 KiB After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 75 KiB After Width: | Height: | Size: 56 KiB |
|
Before Width: | Height: | Size: 89 KiB After Width: | Height: | Size: 21 KiB |
|
Before Width: | Height: | Size: 147 KiB After Width: | Height: | Size: 47 KiB |
BIN
assets/images/help/codespaces/codespaces-accept-permissions.png
Normal file
|
After Width: | Height: | Size: 187 KiB |
|
After Width: | Height: | Size: 64 KiB |
BIN
assets/images/help/codespaces/configuration-file-choice.png
Normal file
|
After Width: | Height: | Size: 123 KiB |
BIN
assets/images/help/codespaces/default-machine-type.png
Normal file
|
After Width: | Height: | Size: 57 KiB |
|
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 57 KiB |
|
Before Width: | Height: | Size: 139 KiB After Width: | Height: | Size: 158 KiB |
|
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 159 KiB |
|
Before Width: | Height: | Size: 80 KiB After Width: | Height: | Size: 81 KiB |
BIN
assets/images/help/codespaces/prebuilt-codespace-found.png
Normal file
|
After Width: | Height: | Size: 22 KiB |
|
After Width: | Height: | Size: 195 KiB |
|
After Width: | Height: | Size: 194 KiB |
|
After Width: | Height: | Size: 172 KiB |
|
After Width: | Height: | Size: 206 KiB |
|
After Width: | Height: | Size: 136 KiB |
|
After Width: | Height: | Size: 159 KiB |
|
After Width: | Height: | Size: 132 KiB |
|
After Width: | Height: | Size: 144 KiB |
|
After Width: | Height: | Size: 195 KiB |
|
After Width: | Height: | Size: 19 KiB |
BIN
assets/images/help/security/enable-ghas-private-repo.png
Normal file
|
After Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 72 KiB After Width: | Height: | Size: 68 KiB |
@@ -218,7 +218,11 @@ export function Search({
|
||||
<div className="position-relative z-2">
|
||||
<form role="search" className="width-full d-flex" noValidate onSubmit={onFormSubmit}>
|
||||
<label className="text-normal width-full">
|
||||
<span className="visually-hidden">{t`placeholder`}</span>
|
||||
<span
|
||||
className="visually-hidden"
|
||||
aria-label={t`label`}
|
||||
aria-describedby={t`description`}
|
||||
>{t`placeholder`}</span>
|
||||
<input
|
||||
data-testid="site-search-input"
|
||||
ref={inputRef}
|
||||
@@ -237,13 +241,15 @@ export function Search({
|
||||
)}
|
||||
type="search"
|
||||
placeholder={t`placeholder`}
|
||||
autoComplete="off"
|
||||
autoComplete={localQuery ? 'on' : 'off'}
|
||||
autoCorrect="off"
|
||||
autoCapitalize="off"
|
||||
spellCheck="false"
|
||||
maxLength={512}
|
||||
onChange={onSearch}
|
||||
value={localQuery}
|
||||
aria-label={t`label`}
|
||||
aria-describedby={t`description`}
|
||||
/>
|
||||
</label>
|
||||
<button className="d-none" type="submit" title="Submit the search query." hidden />
|
||||
@@ -393,7 +399,12 @@ function ShowSearchResults({
|
||||
You're searching the <strong>{searchVersion}</strong> version.
|
||||
</p>
|
||||
<div className="float-right mr-4">
|
||||
<p className={cx(styles.selectWording, 'f6 d-inline-block')}>Select version:</p>
|
||||
<p
|
||||
aria-describedby={`You're searching the ${searchVersion} version`}
|
||||
className={cx(styles.selectWording, 'f6 d-inline-block')}
|
||||
>
|
||||
Select version:
|
||||
</p>
|
||||
<DropdownMenu
|
||||
placeholder={searchVersion}
|
||||
items={searchVersions}
|
||||
|
||||
@@ -2,8 +2,8 @@ import dedent from 'ts-dedent'
|
||||
import { PlaygroundArticleT } from 'components/playground/types'
|
||||
|
||||
const article: PlaygroundArticleT = {
|
||||
title: 'Add a dev container to your project',
|
||||
shortTitle: 'C# Codespaces',
|
||||
title: 'Add a dev container configuration to your repository',
|
||||
shortTitle: 'C# codespaces',
|
||||
topics: ['Codespaces', 'Developer', 'Organization'],
|
||||
type: 'tutorial',
|
||||
slug: '/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces',
|
||||
@@ -11,11 +11,13 @@ const article: PlaygroundArticleT = {
|
||||
'/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces',
|
||||
codeLanguageId: 'dotnet',
|
||||
intro: dedent`
|
||||
This guide shows you how to add a [dev container](/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project) to define the Codespaces configuration for your **C# (.NET)** project. For other project languages, click the language button to the right.
|
||||
This guide shows you how to add a dev container configuration to your repository to define the GitHub Codespaces development environment for your **C# (.NET)** codebase. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers)."
|
||||
|
||||
If you want to add a dev container configuration for another programming language, click the language button to the right.
|
||||
`,
|
||||
prerequisites: dedent`
|
||||
- You should have an existing C# (.NET) project in a repository on GitHub.com. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/python-quickstart.
|
||||
- Codespaces must be enabled for your organization. For more information, see "[Enabling Codespaces for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization)."
|
||||
- GitHub Codespaces must be enabled for your organization. For more information, see "[Enabling GitHub Codespaces for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization)."
|
||||
`,
|
||||
contentBlocks: [
|
||||
{
|
||||
@@ -25,17 +27,19 @@ const article: PlaygroundArticleT = {
|
||||
type: 'default',
|
||||
title: 'Step 1: Open your project in a codespace',
|
||||
content: dedent`
|
||||
1. Under the repository name, use the **Code** drop-down menu, and in the **Codespaces** tab, click **New codespace**.
|
||||
1. Under the repository name, use the **Code** drop-down menu, and in the **Codespaces** tab, click **Create codespace on BRANCH**.
|
||||
|
||||

|
||||
|
||||
If you don’t see this option, Codespaces isn't available for your project. See [Access to Codespaces](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
|
||||
If you don’t see this option, GitHub Codespaces isn't available for your project. See [Access to GitHub Codespaces](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
|
||||
|
||||
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including .NET. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
|
||||
|
||||
You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed.
|
||||
|
||||
Codespaces uses a file called \`devcontainer.json\` to store configurations. On launch Codespaces uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
|
||||
|
||||
GitHub Codespaces uses a file called \`devcontainer.json\` to configure the development container that you use when you work in a codespace. Each repository can contain one or more \`devcontainer.json\` files, to give you exactly the development environment you need to work on your code in a codespace.
|
||||
|
||||
On launch, GitHub Codespaces uses a \`devcontainer.json\` file, and any dependent files that make up the dev container configuration, to install tools and runtimes, and perform other setup tasks that the project requires. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
|
||||
`,
|
||||
},
|
||||
{
|
||||
@@ -43,11 +47,11 @@ const article: PlaygroundArticleT = {
|
||||
id: '0',
|
||||
},
|
||||
type: 'default',
|
||||
title: 'Step 2: Add a dev container to your codespace from a template',
|
||||
title: 'Step 2: Add a dev container configuration to your repository from a template',
|
||||
content: dedent`
|
||||
The default codespaces container comes with the latest .NET version and common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all Codespaces users in your repository.
|
||||
The default development container, or "dev container," for GitHub Codespaces comes with the latest .NET version and common tools preinstalled. However, we recommend that you configure your own dev container to include all of the tools and scripts that your project needs. This will ensure a fully reproducible environment for all GitHub Codespaces users in your repository.
|
||||
|
||||
To set up your project with a custom container, you will need to use a \`devcontainer.json\` file to define the environment. In Codespaces you can add this either from a template or you can create your own. For more information on dev containers, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)".
|
||||
To set up your repository to use a custom dev container, you will need to create one or more \`devcontainer.json\` files. You can add these either from a template, in Visual Studio Code, or you can write your own. For more information on dev container configurations, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)".
|
||||
|
||||
1. Access the Command Palette (\`Shift + Command + P\` / \`Ctrl + Shift + P\`), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...**.
|
||||

|
||||
@@ -70,7 +74,7 @@ const article: PlaygroundArticleT = {
|
||||
type: 'sub-section',
|
||||
title: 'Anatomy of your dev container',
|
||||
content: dedent`
|
||||
Adding the C# (.NET) dev container template adds a \`.devcontainer\` folder to the root of your project's repository with the following files:
|
||||
Adding the C# (.NET) dev container template adds a \`.devcontainer\` directory to the root of your project's repository with the following files:
|
||||
|
||||
- \`devcontainer.json\`
|
||||
- Dockerfile
|
||||
@@ -96,7 +100,7 @@ const article: PlaygroundArticleT = {
|
||||
},
|
||||
content: dedent`
|
||||
**\`build\`** - The build properties.
|
||||
- **\`dockerfil\`e** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template.
|
||||
- **\`dockerfile\`** - In the \`build\` object, \`dockerfile\` contains the path to the Dockerfile that was also added from the template.
|
||||
- **\`args\`**
|
||||
- **\`VARIANT\`**: This file only contains one build argument, which is the .NET Core version that we want to use.
|
||||
`,
|
||||
@@ -140,7 +144,7 @@ const article: PlaygroundArticleT = {
|
||||
highlight: 29,
|
||||
},
|
||||
content: dedent`
|
||||
**\`postCreateCommand\`** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like \`dotnet restore\`, you can do that here.
|
||||
**\`postCreateCommand\`** - Use this to run commands that aren't defined in the Dockerfile, like \`dotnet restore\`, after your codespace is created.
|
||||
`,
|
||||
},
|
||||
{
|
||||
@@ -160,7 +164,7 @@ const article: PlaygroundArticleT = {
|
||||
type: 'sub-section',
|
||||
title: 'Dockerfile',
|
||||
content: dedent`
|
||||
You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our Dockerfile.
|
||||
You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container.
|
||||
`,
|
||||
},
|
||||
{
|
||||
@@ -171,7 +175,7 @@ const article: PlaygroundArticleT = {
|
||||
type: 'default',
|
||||
title: 'Step 3: Modify your devcontainer.json file',
|
||||
content: dedent`
|
||||
With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches.
|
||||
With your dev container configuration added and a basic understanding of what everything does, you can now make changes to customize your environment further. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches.
|
||||
|
||||
1. In the Explorer, expand the \`.devcontainer\` folder and select the \`devcontainer.json\` file from the tree to open it.
|
||||
|
||||
@@ -182,7 +186,7 @@ const article: PlaygroundArticleT = {
|
||||
\`\`\`json{:copy}
|
||||
"extensions": [
|
||||
"ms-dotnettools.csharp",
|
||||
"streetsidesoftware.code-spell-checker",
|
||||
"streetsidesoftware.code-spell-checker"
|
||||
],
|
||||
\`\`\`
|
||||
|
||||
|
||||
@@ -2,8 +2,8 @@ import dedent from 'ts-dedent'
|
||||
import { PlaygroundArticleT } from 'components/playground/types'
|
||||
|
||||
const article: PlaygroundArticleT = {
|
||||
title: 'Add a dev container to your project',
|
||||
shortTitle: 'Add a dev container to your project',
|
||||
title: 'Add a dev container configuration to your repository',
|
||||
shortTitle: 'Java codespaces',
|
||||
topics: ['Codespaces', 'Developer', 'Organization', 'Java'],
|
||||
type: 'tutorial',
|
||||
slug: '/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces',
|
||||
@@ -11,11 +11,13 @@ const article: PlaygroundArticleT = {
|
||||
'/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces',
|
||||
codeLanguageId: 'java',
|
||||
intro: dedent`
|
||||
This guide shows you how to add a [dev container](/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project) to define the Codespaces configuration for your **Java** project. For other project languages, click the language button to the right.
|
||||
This guide shows you how to add a dev container configuration to your repository to define the GitHub Codespaces development environment for your **Java** codebase. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers)."
|
||||
|
||||
If you want to add a dev container configuration for another programming language, click the language button to the right.
|
||||
`,
|
||||
prerequisites: dedent`
|
||||
- You should have an existing Java project in a repository on GitHub.com. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-java
|
||||
- Codespaces must be enabled for your organization. For more information, see "[Enabling Codespaces for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization)."
|
||||
- GitHub Codespaces must be enabled for your organization. For more information, see "[Enabling GitHub Codespaces for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization)."
|
||||
`,
|
||||
contentBlocks: [
|
||||
{
|
||||
@@ -25,15 +27,17 @@ const article: PlaygroundArticleT = {
|
||||
type: 'default',
|
||||
title: 'Step 1: Open your project in a codespace',
|
||||
content: dedent`
|
||||
1. Under the repository name, use the **Code** drop-down menu, and in the **Codespaces** tab, click **New codespace**.
|
||||
1. Under the repository name, use the **Code** drop-down menu, and in the **Codespaces** tab, click **Create codespace on BRANCH**.
|
||||
|
||||

|
||||
|
||||
If you don’t see this option, Codespaces isn't available for your project. See [Access to Codespaces](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
|
||||
If you don’t see this option, GitHub Codespaces isn't available for your project. See [Access to GitHub Codespaces](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
|
||||
|
||||
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Java, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
|
||||
|
||||
Codespaces uses a file called \`devcontainer.json\` to store configurations. On launch Codespaces uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
|
||||
GitHub Codespaces uses a file called \`devcontainer.json\` to configure the development container that you use when you work in a codespace. Each repository can contain one or more \`devcontainer.json\` files, to give you exactly the development environment you need to work on your code in a codespace.
|
||||
|
||||
On launch, GitHub Codespaces uses a \`devcontainer.json\` file, and any dependent files that make up the dev container configuration, to install tools and runtimes, and perform other setup tasks that the project requires. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
|
||||
`,
|
||||
},
|
||||
{
|
||||
@@ -41,11 +45,11 @@ const article: PlaygroundArticleT = {
|
||||
id: '0',
|
||||
},
|
||||
type: 'default',
|
||||
title: 'Step 2: Add a dev container to your codespace from a template',
|
||||
title: 'Step 2: Add a dev container configuration to your repository from a template',
|
||||
content: dedent`
|
||||
The default codespaces container comes with the latest Java version, package managers (Maven, Gradle), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all Codespaces users in your repository.
|
||||
The default development container, or "dev container," for GitHub Codespaces comes with the latest Java version, package managers (Maven, Gradle), and other common tools preinstalled. However, we recommend that you configure your own dev container to include all of the tools and scripts that your project needs. This will ensure a fully reproducible environment for all GitHub Codespaces users in your repository.
|
||||
|
||||
To set up your project with a custom container, you will need to use a \`devcontainer.json\` file to define the environment. In Codespaces you can add this either from a template or you can create your own. For more information on dev containers, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)".
|
||||
To set up your repository to use a custom dev container, you will need to create one or more \`devcontainer.json\` files. You can add these either from a template, in Visual Studio Code, or you can write your own. For more information on dev container configurations, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)".
|
||||
|
||||
1. Access the Command Palette (\`Shift + Command + P\` / \`Ctrl + Shift + P\`), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...**.
|
||||

|
||||
@@ -65,7 +69,7 @@ const article: PlaygroundArticleT = {
|
||||
type: 'sub-section',
|
||||
title: 'Anatomy of your dev container',
|
||||
content: dedent`
|
||||
Adding the Java dev container template adds a .devcontainer folder to the root of your project's repository with the following files:
|
||||
Adding the Java dev container template adds a .devcontainer directory to the root of your project's repository with the following files:
|
||||
|
||||
- \`devcontainer.json\`
|
||||
- Dockerfile
|
||||
@@ -91,7 +95,7 @@ const article: PlaygroundArticleT = {
|
||||
},
|
||||
content: dedent`
|
||||
**\`build\`** - The build properties.
|
||||
- **\`dockerfile\`** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template.
|
||||
- **\`dockerfile\`** - In the \`build\` object, \`dockerfile\` contains the path to the Dockerfile that was also added from the template.
|
||||
- **\`args\`**
|
||||
- **\`VARIANT\`**: This file only contains one build argument, which is the Java version that is passed into the Dockerfile.
|
||||
`,
|
||||
@@ -135,7 +139,7 @@ const article: PlaygroundArticleT = {
|
||||
highlight: 34,
|
||||
},
|
||||
content: dedent`
|
||||
**\`postCreateCommand\`** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here.
|
||||
**\`postCreateCommand\`** - Use this to run commands that aren't defined in the Dockerfile, after your codespace is created.
|
||||
`,
|
||||
},
|
||||
{
|
||||
@@ -155,7 +159,7 @@ const article: PlaygroundArticleT = {
|
||||
type: 'sub-section',
|
||||
title: 'Dockerfile',
|
||||
content: dedent`
|
||||
You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our Dockerfile.
|
||||
You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container.
|
||||
`,
|
||||
},
|
||||
{
|
||||
@@ -166,7 +170,7 @@ const article: PlaygroundArticleT = {
|
||||
type: 'default',
|
||||
title: 'Step 3: Modify your devcontainer.json file',
|
||||
content: dedent`
|
||||
With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches.
|
||||
With your dev container configuration added and a basic understanding of what everything does, you can now make changes to customize your environment further. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches.
|
||||
|
||||
1. In the Explorer, expand the \`.devcontainer\` folder and select the \`devcontainer.json\` file from the tree to open it.
|
||||
|
||||
@@ -179,7 +183,7 @@ const article: PlaygroundArticleT = {
|
||||
"forwardPorts": [4000],
|
||||
\`\`\`
|
||||
|
||||
For more information on \`devcontainer.json\` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) on the Visual Studio Code docs.
|
||||
For more information about \`devcontainer.json\` properties, see the Visual Studio Code documentation: "[devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference)."
|
||||
|
||||
4. Access the command palette (\`Shift + Command + P\`/ \`Ctrl + Shift + P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**.
|
||||

|
||||
|
||||
@@ -2,8 +2,8 @@ import dedent from 'ts-dedent'
|
||||
import { PlaygroundArticleT } from 'components/playground/types'
|
||||
|
||||
const article: PlaygroundArticleT = {
|
||||
title: 'Add a dev container to your project',
|
||||
shortTitle: 'Node.js Codespaces',
|
||||
title: 'Add a dev container configuration to your repository',
|
||||
shortTitle: 'Node.js codespaces',
|
||||
topics: ['Codespaces', 'Developer', 'Organization', 'Node', 'JavaScript'],
|
||||
type: 'tutorial',
|
||||
slug: '/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces',
|
||||
@@ -11,11 +11,13 @@ const article: PlaygroundArticleT = {
|
||||
'/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces',
|
||||
codeLanguageId: 'nodejs',
|
||||
intro: dedent`
|
||||
This guide shows you how to add a [dev container](/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project) to define the Codespaces configuration for your **JavaScript**, **Node.js**, or **TypeScript** project. For other project languages, click the language button to the right.
|
||||
This guide shows you how to add a dev container configuration to your repository to define the GitHub Codespaces development environment for your **Node.js** codebase. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers)."
|
||||
|
||||
If you want to add a dev container configuration for another programming language, click the language button to the right.
|
||||
`,
|
||||
prerequisites: dedent`
|
||||
- You should have an existing JavaScript, Node.js, or TypeScript project in a repository on GitHub.com. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-node
|
||||
- Codespaces must be enabled for your organization. For more information, see "[Enabling Codespaces for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization)."
|
||||
- GitHub Codespaces must be enabled for your organization. For more information, see "[Enabling GitHub Codespaces for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization)."
|
||||
`,
|
||||
contentBlocks: [
|
||||
{
|
||||
@@ -25,17 +27,17 @@ const article: PlaygroundArticleT = {
|
||||
type: 'default',
|
||||
title: 'Step 1: Open your project in a codespace',
|
||||
content: dedent`
|
||||
1. Under the repository name, use the **Code** drop-down menu, and in the **Codespaces** tab, click **New codespace**.
|
||||
1. Under the repository name, use the **Code** drop-down menu, and in the **Codespaces** tab, click **Create codespace on BRANCH**.
|
||||
|
||||

|
||||
|
||||
If you don’t see this option, Codespaces isn't available for your project. See [Access to Codespaces](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
|
||||
If you don’t see this option, GitHub Codespaces isn't available for your project. See [Access to GitHub Codespaces](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
|
||||
|
||||
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
|
||||
|
||||
You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed.
|
||||
|
||||
Codespaces uses a file called \`devcontainer.json\` to store configurations. On launch, Codespaces uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
|
||||
GitHub Codespaces uses a file called \`devcontainer.json\` to configure the development container that you use when you work in a codespace. Each repository can contain one or more \`devcontainer.json\` files, to give you exactly the development environment you need to work on your code in a codespace. On launch, GitHub Codespaces uses a \`devcontainer.json\` file, and any dependent files that make up the dev container configuration, to install tools and runtimes, and perform other setup tasks that the project requires. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
|
||||
`,
|
||||
},
|
||||
{
|
||||
@@ -43,11 +45,11 @@ const article: PlaygroundArticleT = {
|
||||
id: '0',
|
||||
},
|
||||
type: 'default',
|
||||
title: 'Step 2: Add a dev container to your codespace from a template',
|
||||
title: 'Step 2: Add a dev container configuration to your repository from a template',
|
||||
content: dedent`
|
||||
The default codespaces container will support running Node.js projects like [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) out of the box. By setting up a custom container you can customize the tools and scripts that run as part of codespace creation and ensure a fully reproducible environment for all Codespaces users in your repository.
|
||||
The default development container, or "dev container," for GitHub Codespaces supports running Node.js projects like [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) out of the box. However, we recommend that you configure your own dev container to include all of the tools and scripts your project needs. This will ensure a fully reproducible environment for all GitHub Codespaces users in your repository.
|
||||
|
||||
To set up your project with a custom container, you will need to use a \`devcontainer.json\` file to define the environment. In Codespaces you can add this either from a template or you can create your own. For more information on dev containers, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)".
|
||||
To set up your repository to use a custom dev container, you will need to create one or more \`devcontainer.json\` files. You can add these either from a template, in Visual Studio Code, or you can write your own. For more information on dev container configurations, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)".
|
||||
|
||||
1. Access the Command Palette (\`Shift + Command + P\` / \`Ctrl + Shift + P\`), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...**.
|
||||

|
||||
@@ -67,7 +69,7 @@ const article: PlaygroundArticleT = {
|
||||
type: 'sub-section',
|
||||
title: 'Anatomy of your dev container',
|
||||
content: dedent`
|
||||
Adding the Node.js dev container template adds a \`.devcontainer\` folder to the root of your project's repository with the following files:
|
||||
Adding the Node.js dev container template adds a \`.devcontainer\` directory to the root of your project's repository with the following files:
|
||||
|
||||
- \`devcontainer.json\`
|
||||
- Dockerfile
|
||||
@@ -93,7 +95,7 @@ const article: PlaygroundArticleT = {
|
||||
},
|
||||
content: dedent`
|
||||
**\`build\`** - The build properties.
|
||||
- **\`dockerfile\`** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template.
|
||||
- **\`dockerfile\`** - In the \`build\` object, \`dockerfile\` contains the path to the Dockerfile that was also added from the template.
|
||||
- **\`args\`**
|
||||
- **\`VARIANT\`**: This file only contains one build argument, which is the node variant we want to use that is passed into the Dockerfile.
|
||||
`,
|
||||
@@ -137,7 +139,7 @@ const article: PlaygroundArticleT = {
|
||||
highlight: 25,
|
||||
},
|
||||
content: dedent`
|
||||
**\`postCreateCommand\`** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here.
|
||||
**\`postCreateCommand\`** - Use this to run commands that aren't defined in the Dockerfile, after your codespace is created.
|
||||
`,
|
||||
},
|
||||
{
|
||||
@@ -157,7 +159,7 @@ const article: PlaygroundArticleT = {
|
||||
type: 'sub-section',
|
||||
title: 'Dockerfile',
|
||||
content: dedent`
|
||||
You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our Dockerfile.
|
||||
You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container.
|
||||
`,
|
||||
},
|
||||
{
|
||||
@@ -168,7 +170,7 @@ const article: PlaygroundArticleT = {
|
||||
type: 'default',
|
||||
title: 'Step 3: Modify your devcontainer.json file',
|
||||
content: dedent`
|
||||
With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install npm when your codespace launches and make a list of ports inside the container available locally.
|
||||
With your dev container configuration added and a basic understanding of what everything does, you can now make changes to customize your environment further. In this example, you'll add properties to install npm when your codespace launches and make a list of ports inside the container available locally.
|
||||
|
||||
1. In the Explorer, select the \`devcontainer.json\` file from the tree to open it. You might have to expand the \`.devcontainer\` folder to see it.
|
||||

|
||||
@@ -178,7 +180,7 @@ const article: PlaygroundArticleT = {
|
||||
"postCreateCommand": "npm install",
|
||||
"forwardPorts": [4000],
|
||||
\`\`\`
|
||||
For more information on \`devcontainer.json\` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) in the Visual Studio Code docs.
|
||||
For more information about \`devcontainer.json\` properties, see the Visual Studio Code documentation: "[devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference)."
|
||||
|
||||
1. Access the command palette (\`Shift + Command + P\`/ \`Ctrl + Shift + P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**.
|
||||

|
||||
|
||||
@@ -2,8 +2,8 @@ import dedent from 'ts-dedent'
|
||||
import { PlaygroundArticleT } from 'components/playground/types'
|
||||
|
||||
const article: PlaygroundArticleT = {
|
||||
title: 'Add a dev container to your repository',
|
||||
shortTitle: 'Python Codespaces',
|
||||
title: 'Add a dev container configuration to your repository',
|
||||
shortTitle: 'Python codespaces',
|
||||
topics: ['Codespaces', 'Developer', 'Organization', 'Python'],
|
||||
type: 'tutorial',
|
||||
slug: '/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces',
|
||||
@@ -11,11 +11,13 @@ const article: PlaygroundArticleT = {
|
||||
'/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces',
|
||||
codeLanguageId: 'py',
|
||||
intro: dedent`
|
||||
This guide shows you how to add a [dev container](/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project) to define the Codespaces configuration for your **Python** project. For other project languages, click the language button to the right.
|
||||
This guide shows you how to add a dev container configuration to your repository to define the GitHub Codespaces development environment for your **Python** codebase. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers)."
|
||||
|
||||
If you want to add a dev container configuration for another programming language, click the language button to the right.
|
||||
`,
|
||||
prerequisites: dedent`
|
||||
- You should have an existing Python project in a repository on GitHub.com. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/python-quickstart.
|
||||
- Codespaces must be enabled for your organization. For more information, see "[Enabling Codespaces for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization)."
|
||||
- GitHub Codespaces must be enabled for your organization. For more information, see "[Enabling GitHub Codespaces for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization)."
|
||||
`,
|
||||
contentBlocks: [
|
||||
{
|
||||
@@ -25,17 +27,19 @@ const article: PlaygroundArticleT = {
|
||||
type: 'default',
|
||||
title: 'Step 1: Open your project in a codespace',
|
||||
content: dedent`
|
||||
1. Under the repository name, use the **Code** drop-down menu, and in the **Codespaces** tab, click **New codespace**.
|
||||
1. Under the repository name, use the **Code** drop-down menu, and in the **Codespaces** tab, click **Create codespace on BRANCH**.
|
||||
|
||||

|
||||
|
||||
If you don’t see this option, Codespaces isn't available for your project. See [Access to Codespaces](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
|
||||
If you don’t see this option, GitHub Codespaces isn't available for your project. See [Access to GitHub Codespaces](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
|
||||
|
||||
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Python, pip, and Miniconda. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
|
||||
|
||||
You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed.
|
||||
|
||||
Codespaces uses a file called \`devcontainer.json\` to store configurations. On launch Codespaces uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
|
||||
GitHub Codespaces uses a file called \`devcontainer.json\` to configure the development container that you use when you work in a codespace. Each repository can contain one or more \`devcontainer.json\` files, to give you exactly the development environment you need to work on your code in a codespace.
|
||||
|
||||
On launch, GitHub Codespaces uses a \`devcontainer.json\` file, and any dependent files that make up the dev container configuration, to install tools and runtimes, and perform other setup tasks that the project requires. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
|
||||
`,
|
||||
},
|
||||
{
|
||||
@@ -43,11 +47,11 @@ const article: PlaygroundArticleT = {
|
||||
id: '0',
|
||||
},
|
||||
type: 'default',
|
||||
title: 'Step 2: Add a dev container to your codespace from a template',
|
||||
title: 'Step 2: Add a dev container configuration to your repository from a template',
|
||||
content: dedent`
|
||||
The default codespaces container comes with the latest Python version, package managers (pip, Miniconda), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all Codespaces users in your repository.
|
||||
The default development container, or "dev container," for GitHub Codespaces comes with the latest Python version, package managers (pip, Miniconda), and other common tools preinstalled. However, we recommend that you configure your own dev container to include all of the tools and scripts that your project needs. This will ensure a fully reproducible environment for all GitHub Codespaces users in your repository.
|
||||
|
||||
To set up your project with a custom container, you will need to use a \`devcontainer.json\` file to define the environment. In Codespaces you can add this either from a template or you can create your own. For more information on dev containers, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)".
|
||||
To set up your repository to use a custom dev container, you will need to create one or more \`devcontainer.json\` files. You can add these either from a template, in Visual Studio Code, or you can write your own. For more information on dev container configurations, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)".
|
||||
|
||||
1. Access the Command Palette (\`Shift + Command + P\` / \`Ctrl + Shift + P\`), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...**.
|
||||

|
||||
@@ -69,7 +73,7 @@ const article: PlaygroundArticleT = {
|
||||
type: 'sub-section',
|
||||
title: 'Anatomy of your dev container',
|
||||
content: dedent`
|
||||
Adding the Python dev container template adds a .devcontainer folder to the root of your project's repository with the following files:
|
||||
Adding the Python dev container template adds a .devcontainer directory to the root of your project's repository with the following files:
|
||||
|
||||
- \`devcontainer.json\`
|
||||
- Dockerfile
|
||||
@@ -95,7 +99,7 @@ const article: PlaygroundArticleT = {
|
||||
},
|
||||
content: dedent`
|
||||
**\`build\`** - The build properties.
|
||||
- **\`dockerfile\`** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template.
|
||||
- **\`dockerfile\`** - In the \`build\` object, \`dockerfile\` contains the path to the Dockerfile that was also added from the template.
|
||||
- **\`args\`**
|
||||
- **\`VARIANT\`**: This is the node variant we want to use that is passed into the Dockerfile.
|
||||
`,
|
||||
@@ -139,7 +143,7 @@ const article: PlaygroundArticleT = {
|
||||
highlight: 41,
|
||||
},
|
||||
content: dedent`
|
||||
**\`postCreateCommand\`** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like pip3 install -r requirements, you can do that here.
|
||||
**\`postCreateCommand\`** - Use this to run commands that aren't defined in the Dockerfile, like \`pip3 install -r requirements\`, after your codespace is created.
|
||||
`,
|
||||
},
|
||||
{
|
||||
@@ -159,7 +163,7 @@ const article: PlaygroundArticleT = {
|
||||
type: 'sub-section',
|
||||
title: 'Dockerfile',
|
||||
content: dedent`
|
||||
You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our Dockerfile.
|
||||
You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container.
|
||||
`,
|
||||
},
|
||||
{
|
||||
@@ -170,7 +174,7 @@ const article: PlaygroundArticleT = {
|
||||
type: 'default',
|
||||
title: 'Step 3: Modify your devcontainer.json file',
|
||||
content: dedent`
|
||||
With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches.
|
||||
With your dev container configuration added and a basic understanding of what everything does, you can now make changes to customize your environment further. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches.
|
||||
|
||||
1. In the Explorer, expand the \`.devcontainer\` folder and select the \`devcontainer.json\` file from the tree to open it.
|
||||
|
||||
@@ -182,7 +186,7 @@ const article: PlaygroundArticleT = {
|
||||
"extensions": [
|
||||
"ms-python.python",
|
||||
"cstrap.flask-snippets",
|
||||
"streetsidesoftware.code-spell-checker",
|
||||
"streetsidesoftware.code-spell-checker"
|
||||
],
|
||||
\`\`\`
|
||||
|
||||
@@ -271,7 +275,7 @@ const article: PlaygroundArticleT = {
|
||||
|
||||
// Add the IDs of extensions you want installed when the container is created.
|
||||
"extensions": [
|
||||
"ms-python.python",
|
||||
"ms-python.python"
|
||||
],
|
||||
|
||||
// Use 'forwardPorts' to make a list of ports inside the container available locally.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Your account and profile on GitHub
|
||||
shortTitle: Account and profile
|
||||
intro: 'Make {% data variables.product.product_name %} work best for you by adjusting the settings for your user account, personalizing your profile page, and managing the notifications you receive for activity on {% data variables.product.prodname_dotcom %}.'
|
||||
intro: 'Make {% data variables.product.product_name %} work best for you by adjusting the settings for your personal account, personalizing your profile page, and managing the notifications you receive for activity on {% data variables.product.prodname_dotcom %}.'
|
||||
introLinks:
|
||||
quickstart: /get-started/onboarding/getting-started-with-your-github-account
|
||||
featuredLinks:
|
||||
|
||||
@@ -44,7 +44,7 @@ In general, you are automatically subscribed to conversations by default when yo
|
||||
- Changed the state of a thread, such as by closing an issue or merging a pull request.
|
||||
- Had a team you're a member of @mentioned.
|
||||
|
||||
By default, you also automatically watch all repositories that you create and are owned by your user account.
|
||||
By default, you also automatically watch all repositories that you create and are owned by your personal account.
|
||||
|
||||
To unsubscribe from conversations you're automatically subscribed to, you can change your notification settings or directly unsubscribe or unwatch activity on {% data variables.product.product_location %}. For more information, see "[Managing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)."
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Setting up and managing your GitHub user account
|
||||
intro: 'You can manage settings in your GitHub user account including email preferences, collaborator access for personal repositories, and organization memberships.'
|
||||
shortTitle: User accounts
|
||||
intro: 'You can manage settings in your GitHub personal account including email preferences, collaborator access for personal repositories, and organization memberships.'
|
||||
shortTitle: Personal accounts
|
||||
redirect_from:
|
||||
- /categories/setting-up-and-managing-your-github-user-account
|
||||
- /github/setting-up-and-managing-your-github-user-account
|
||||
|
||||
@@ -60,7 +60,7 @@ If you're a member of an {% data variables.product.prodname_emu_enterprise %}, y
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/#collaborator-access-for-a-repository-owned-by-a-user-account)"
|
||||
- "[Permission levels for a personal account repository](/articles/permission-levels-for-a-user-account-repository/#collaborator-access-for-a-repository-owned-by-a-personal-account)"
|
||||
- "[Removing a collaborator from a personal repository](/articles/removing-a-collaborator-from-a-personal-repository)"
|
||||
- "[Removing yourself from a collaborator's repository](/articles/removing-yourself-from-a-collaborator-s-repository)"
|
||||
- "[Organizing members into teams](/organizations/organizing-members-into-teams)"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Changing your primary email address
|
||||
intro: You can change the email address associated with your user account at any time.
|
||||
intro: You can change the email address associated with your personal account at any time.
|
||||
redirect_from:
|
||||
- /articles/changing-your-primary-email-address
|
||||
- /github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Remembering your GitHub username or email
|
||||
intro: 'Are you signing in to {% data variables.product.product_location %} for the first time in a while? If so, welcome back! If you can''t remember your {% data variables.product.product_name %} user account name, you can try these methods for remembering it.'
|
||||
intro: 'Are you signing in to {% data variables.product.product_location %} for the first time in a while? If so, welcome back! If you can''t remember the username for your personal account on {% data variables.product.product_name %}, you can try these methods for remembering it.'
|
||||
redirect_from:
|
||||
- /articles/oh-noes-i-ve-forgotten-my-username-email
|
||||
- /articles/oh-noes-i-ve-forgotten-my-username-or-email
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Best practices for leaving your company
|
||||
intro: 'Changing jobs is a fact of life. If you use your GitHub user account for both personal *and* work purposes, there are a few things to keep in mind when you leave your company or organization.'
|
||||
intro: 'If you use your account on {% data variables.product.product_name %} for both personal and work purposes, there are a few things to keep in mind when you leave your company or organization.'
|
||||
redirect_from:
|
||||
- /articles/best-practices-for-leaving-your-company
|
||||
- /github/setting-up-and-managing-your-github-user-account/best-practices-for-leaving-your-company
|
||||
@@ -12,7 +12,7 @@ topics:
|
||||
- Accounts
|
||||
shortTitle: Leaving your company
|
||||
---
|
||||
Before you leave your company, make sure you update the following information in your user account:
|
||||
Before you leave your company, make sure you update the following information in your personal account:
|
||||
|
||||
- Unverify your company email address by [deleting it in your Email settings](/articles/changing-your-primary-email-address). You can then re-add it without verifying to keep any associated commits linked to your account.
|
||||
- [Change your primary email address](/articles/changing-your-primary-email-address) from your company email to your personal email.
|
||||
@@ -27,7 +27,7 @@ If you've been working with repositories that belong to an organization, you'll
|
||||
|
||||
## Removing professional associations with personal repositories
|
||||
|
||||
If you've been collaborating professionally with another person on repositories that belong to their personal user account, you'll want to [remove yourself as a collaborator](/articles/removing-yourself-from-a-collaborator-s-repository) from those repositories.
|
||||
If you've been collaborating professionally with another person on repositories that belong to their personal account, you'll want to [remove yourself as a collaborator](/articles/removing-yourself-from-a-collaborator-s-repository) from those repositories.
|
||||
|
||||
- [Stop watching repositories](https://github.com/watching) related to your work. You won't want those notifications anymore!
|
||||
- [Transfer repositories you own](/articles/how-to-transfer-a-repository) that others may need to continue working on after you leave.
|
||||
|
||||
@@ -6,7 +6,7 @@ redirect_from:
|
||||
- /articles/converting-a-user-into-an-organization
|
||||
- /github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization
|
||||
- /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization
|
||||
intro: You can convert your user account into an organization. This allows more granular permissions for repositories that belong to the organization.
|
||||
intro: You can convert your personal account into an organization. This allows more granular permissions for repositories that belong to the organization.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -19,32 +19,32 @@ shortTitle: User into an organization
|
||||
|
||||
**Warning**: Before converting a user into an organization, keep these points in mind:
|
||||
|
||||
- You will **no longer** be able to sign into the converted user account.
|
||||
- You will **no longer** be able to create or modify gists owned by the converted user account.
|
||||
- You will **no longer** be able to sign into the converted personal account.
|
||||
- You will **no longer** be able to create or modify gists owned by the converted personal account.
|
||||
- An organization **cannot** be converted back to a user.
|
||||
- The SSH keys, OAuth tokens, job profile, reactions, and associated user information, **will not** be transferred to the organization. This is only true for the user account that's being converted, not any of the user account's collaborators.
|
||||
- Any commits made with the converted user account **will no longer be linked** to that account. The commits themselves **will** remain intact.
|
||||
- Any forks of private repositories made with the converted user account will be deleted.
|
||||
- The SSH keys, OAuth tokens, job profile, reactions, and associated user information, **will not** be transferred to the organization. This is only true for the personal account that's being converted, not any of the personal account's collaborators.
|
||||
- Any commits made with the converted personal account **will no longer be linked** to that account. The commits themselves **will** remain intact.
|
||||
- Any forks of private repositories made with the converted personal account will be deleted.
|
||||
|
||||
{% endwarning %}
|
||||
|
||||
## Keep your personal user account and create a new organization manually
|
||||
## Keep your personal account and create a new organization manually
|
||||
|
||||
If you want your organization to have the same name that you are currently using for your personal account, or if you want to keep your personal user account's information intact, then you must create a new organization and transfer your repositories to it instead of converting your user account into an organization.
|
||||
If you want your organization to have the same name that you are currently using for your personal account, or if you want to keep your personal account's information intact, then you must create a new organization and transfer your repositories to it instead of converting your personal account into an organization.
|
||||
|
||||
1. To retain your current user account name for your personal use, [change the name of your personal user account](/articles/changing-your-github-username) to something new and wonderful.
|
||||
2. [Create a new organization](/articles/creating-a-new-organization-from-scratch) with the original name of your personal user account.
|
||||
1. To retain your current personal account name for your personal use, [change the name of your personal account](/articles/changing-your-github-username) to something new and wonderful.
|
||||
2. [Create a new organization](/articles/creating-a-new-organization-from-scratch) with the original name of your personal account.
|
||||
3. [Transfer your repositories](/articles/transferring-a-repository) to your new organization account.
|
||||
|
||||
## Convert your personal account into an organization automatically
|
||||
|
||||
You can also convert your personal user account directly into an organization. Converting your account:
|
||||
You can also convert your personal account directly into an organization. Converting your account:
|
||||
- Preserves the repositories as they are without the need to transfer them to another account manually
|
||||
- Automatically invites collaborators to teams with permissions equivalent to what they had before
|
||||
{% ifversion fpt or ghec %}- For user accounts on {% data variables.product.prodname_pro %}, automatically transitions billing to [the paid {% data variables.product.prodname_team %}](/articles/about-billing-for-github-accounts) without the need to re-enter payment information, adjust your billing cycle, or double pay at any time{% endif %}
|
||||
{% ifversion fpt or ghec %}- For personal accounts on {% data variables.product.prodname_pro %}, automatically transitions billing to [the paid {% data variables.product.prodname_team %}](/articles/about-billing-for-github-accounts) without the need to re-enter payment information, adjust your billing cycle, or double pay at any time{% endif %}
|
||||
|
||||
1. Create a new personal account, which you'll use to sign into GitHub and access the organization and your repositories after you convert.
|
||||
2. [Leave any organizations](/articles/removing-yourself-from-an-organization) the user account you're converting has joined.
|
||||
2. [Leave any organizations](/articles/removing-yourself-from-an-organization) the personal account you're converting has joined.
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.user-settings.organizations %}
|
||||
5. Under "Transform account", click **Turn <username> into an organization**.
|
||||
@@ -55,11 +55,11 @@ You can also convert your personal user account directly into an organization. C
|
||||

|
||||
8. Choose your new organization's subscription and enter your billing information if prompted.
|
||||
9. Click **Create Organization**.
|
||||
10. Sign in to the new user account you created in step one, then use the context switcher to access your new organization.
|
||||
10. Sign in to the new personal account you created in step one, then use the context switcher to access your new organization.
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip**: When you convert a user account into an organization, we'll add collaborators on repositories that belong to the account to the new organization as *outside collaborators*. You can then invite *outside collaborators* to become members of your new organization if you wish. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)."
|
||||
**Tip**: When you convert a personal account into an organization, we'll add collaborators on repositories that belong to the account to the new organization as *outside collaborators*. You can then invite *outside collaborators* to become members of your new organization if you wish. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)."
|
||||
|
||||
{% endtip %}
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Deleting your user account
|
||||
intro: 'You can delete your {% data variables.product.product_name %} user account at any time.'
|
||||
intro: 'You can delete your personal account on {% data variables.product.product_name %} at any time.'
|
||||
redirect_from:
|
||||
- /articles/deleting-a-user-account
|
||||
- /articles/deleting-your-user-account
|
||||
@@ -12,13 +12,13 @@ versions:
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Delete your user account
|
||||
shortTitle: Delete your personal account
|
||||
---
|
||||
Deleting your user account removes all repositories, forks of private repositories, wikis, issues, pull requests, and pages owned by your account. {% ifversion fpt or ghec %} Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted - instead, they'll be associated with our [Ghost user](https://github.com/ghost).{% else %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted.{% endif %}
|
||||
Deleting your personal account removes all repositories, forks of private repositories, wikis, issues, pull requests, and pages owned by your account. {% ifversion fpt or ghec %} Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted - instead, they'll be associated with our [Ghost user](https://github.com/ghost).{% else %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted.{% endif %}
|
||||
|
||||
{% ifversion fpt or ghec %} When you delete your account we stop billing you. The email address associated with the account becomes available for use with a different account on {% data variables.product.product_location %}. After 90 days, the account name also becomes available to anyone else to use on a new account. {% endif %}
|
||||
|
||||
If you’re the only owner of an organization, you must transfer ownership to another person or delete the organization before you can delete your user account. If there are other owners in the organization, you must remove yourself from the organization before you can delete your user account.
|
||||
If you’re the only owner of an organization, you must transfer ownership to another person or delete the organization before you can delete your personal account. If there are other owners in the organization, you must remove yourself from the organization before you can delete your personal account.
|
||||
|
||||
For more information, see:
|
||||
- "[Transferring organization ownership](/articles/transferring-organization-ownership)"
|
||||
@@ -27,19 +27,19 @@ For more information, see:
|
||||
|
||||
## Back up your account data
|
||||
|
||||
Before you delete your user account, make a copy of all repositories, private forks, wikis, issues, and pull requests owned by your account.
|
||||
Before you delete your personal account, make a copy of all repositories, private forks, wikis, issues, and pull requests owned by your account.
|
||||
|
||||
{% warning %}
|
||||
|
||||
**Warning:** Once your user account has been deleted, GitHub cannot restore your content.
|
||||
**Warning:** Once your personal account has been deleted, GitHub cannot restore your content.
|
||||
|
||||
{% endwarning %}
|
||||
|
||||
## Delete your user account
|
||||
## Delete your personal account
|
||||
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.user-settings.account_settings %}
|
||||
3. At the bottom of the Account Settings page, under "Delete account", click **Delete your account**. Before you can delete your user account:
|
||||
3. At the bottom of the Account Settings page, under "Delete account", click **Delete your account**. Before you can delete your personal account:
|
||||
- If you're the only owner in the organization, you must transfer ownership to another person or delete your organization.
|
||||
- If there are other organization owners in the organization, you must remove yourself from the organization.
|
||||

|
||||
|
||||
@@ -30,6 +30,6 @@ children:
|
||||
- /integrating-jira-with-your-personal-projects
|
||||
- /best-practices-for-leaving-your-company
|
||||
- /what-does-the-available-for-hire-checkbox-do
|
||||
shortTitle: User account settings
|
||||
shortTitle: Personal account settings
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Integrating Jira with your personal projects
|
||||
intro: 'You can integrate Jira Cloud with your user account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues.'
|
||||
intro: 'You can integrate Jira Cloud with your personal account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues.'
|
||||
redirect_from:
|
||||
- /articles/integrating-jira-with-your-personal-projects
|
||||
- /github/setting-up-and-managing-your-github-user-account/integrating-jira-with-your-personal-projects
|
||||
|
||||
@@ -18,7 +18,7 @@ shortTitle: Manage security & analysis
|
||||
|
||||
You can still manage the security and analysis features for individual repositories. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."
|
||||
|
||||
You can also review the security log for all activity on your user account. For more information, see "[Reviewing your security log](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log)."
|
||||
You can also review the security log for all activity on your personal account. For more information, see "[Reviewing your security log](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log)."
|
||||
|
||||
{% data reusables.security.some-security-and-analysis-features-are-enabled-by-default %}
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Managing your tab size rendering preference
|
||||
intro: You can manage the number of spaces a tab is equal to for your user account.
|
||||
intro: You can manage the number of spaces a tab is equal to for your personal account.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghae: issue-5083
|
||||
|
||||
@@ -12,17 +12,17 @@ versions:
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Merge multiple user accounts
|
||||
shortTitle: Merge multiple personal accounts
|
||||
---
|
||||
{% tip %}
|
||||
|
||||
{% ifversion ghec %}
|
||||
|
||||
**Tip:** {% data variables.product.prodname_emus %} allow an enterprise to provision unique user accounts for its members through an identity provider (IdP). For more information, see "[About Enterprise Managed Users](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/about-enterprise-managed-users)." For other use cases, we recommend using only one user account to manage both personal and professional repositories.
|
||||
**Tip:** {% data variables.product.prodname_emus %} allow an enterprise to provision unique personal accounts for its members through an identity provider (IdP). For more information, see "[About Enterprise Managed Users](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/about-enterprise-managed-users)." For other use cases, we recommend using only one personal account to manage both personal and professional repositories.
|
||||
|
||||
{% else %}
|
||||
|
||||
**Tip:** We recommend using only one user account to manage both personal and professional repositories.
|
||||
**Tip:** We recommend using only one personal account to manage both personal and professional repositories.
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Permission levels for a user account repository
|
||||
intro: 'A repository owned by a user account has two permission levels: the repository owner and collaborators.'
|
||||
intro: 'A repository owned by a personal account has two permission levels: the repository owner and collaborators.'
|
||||
redirect_from:
|
||||
- /articles/permission-levels-for-a-user-account-repository
|
||||
- /github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository
|
||||
@@ -14,19 +14,19 @@ topics:
|
||||
- Accounts
|
||||
shortTitle: Permission user repositories
|
||||
---
|
||||
## About permissions levels for a user account repository
|
||||
## About permissions levels for a personal account repository
|
||||
|
||||
Repositories owned by user accounts have one owner. Ownership permissions can't be shared with another user account.
|
||||
Repositories owned by personal accounts have one owner. Ownership permissions can't be shared with another personal account.
|
||||
|
||||
You can also {% ifversion fpt or ghec %}invite{% else %}add{% endif %} users on {% data variables.product.product_name %} to your repository as collaborators. For more information, see "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)."
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** If you require more granular access to a repository owned by your user account, consider transferring the repository to an organization. For more information, see "[Transferring a repository](/github/administering-a-repository/transferring-a-repository#transferring-a-repository-owned-by-your-user-account)."
|
||||
**Tip:** If you require more granular access to a repository owned by your personal account, consider transferring the repository to an organization. For more information, see "[Transferring a repository](/github/administering-a-repository/transferring-a-repository#transferring-a-repository-owned-by-your-personal-account)."
|
||||
|
||||
{% endtip %}
|
||||
|
||||
## Owner access for a repository owned by a user account
|
||||
## Owner access for a repository owned by a personal account
|
||||
|
||||
The repository owner has full control of the repository. In addition to the actions that any collaborator can perform, the repository owner can perform the following actions.
|
||||
|
||||
@@ -53,13 +53,13 @@ The repository owner has full control of the repository. In addition to the acti
|
||||
| Display a sponsor button | "[Displaying a sponsor button in your repository](/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository)" |{% endif %}
|
||||
| Allow or disallow auto-merge for pull requests | "[Managing auto-merge for pull requests in your repository](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)" |
|
||||
|
||||
## Collaborator access for a repository owned by a user account
|
||||
## Collaborator access for a repository owned by a personal account
|
||||
|
||||
Collaborators on a personal repository can pull (read) the contents of the repository and push (write) changes to the repository.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** In a private repository, repository owners can only grant write access to collaborators. Collaborators can't have read-only access to repositories owned by a user account.
|
||||
**Note:** In a private repository, repository owners can only grant write access to collaborators. Collaborators can't have read-only access to repositories owned by a personal account.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Permission levels for user-owned project boards
|
||||
intro: 'A project board owned by a user account has two permission levels: the project board owner and collaborators.'
|
||||
intro: 'A project board owned by a personal account has two permission levels: the project board owner and collaborators.'
|
||||
redirect_from:
|
||||
- /articles/permission-levels-for-user-owned-project-boards
|
||||
- /github/setting-up-and-managing-your-github-user-account/permission-levels-for-user-owned-project-boards
|
||||
@@ -16,7 +16,7 @@ shortTitle: Permission user project boards
|
||||
---
|
||||
## Permissions overview
|
||||
|
||||
There is only one owner of a user-owned project board; this permission cannot be shared with another user account. In addition to the owner, other people can collaborate on project boards.
|
||||
There is only one owner of a user-owned project board; this permission cannot be shared with another personal account. In addition to the owner, other people can collaborate on project boards.
|
||||
|
||||
There are three levels of permissions for project board collaborators:
|
||||
|
||||
@@ -60,4 +60,4 @@ You can change the project board's visibility from private to {% ifversion ghae
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[Managing access to your user account's project boards](/articles/managing-access-to-your-user-account-s-project-boards)"
|
||||
- "[Managing access to your personal account's project boards](/articles/managing-access-to-your-user-account-s-project-boards)"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Accessing an organization
|
||||
intro: 'To access an organization that you''re a member of, you must sign in to your personal user account.'
|
||||
intro: 'To access an organization that you''re a member of, you must sign in to your personal account.'
|
||||
redirect_from:
|
||||
- /articles/error-cannot-log-in-that-account-is-an-organization
|
||||
- /articles/cannot-log-in-that-account-is-an-organization
|
||||
|
||||
@@ -21,7 +21,7 @@ You can set scheduled reminders for personal or team-level review requests for p
|
||||
|
||||
{% data reusables.reminders.scheduled-reminders-limitations %}
|
||||
|
||||
## Creating scheduled reminders for your user account
|
||||
## Creating scheduled reminders for your personal account
|
||||
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.reminders.scheduled-reminders %}
|
||||
@@ -39,7 +39,7 @@ You can set scheduled reminders for personal or team-level review requests for p
|
||||

|
||||
{% data reusables.reminders.create-reminder %}
|
||||
|
||||
## Managing scheduled reminders for your user account
|
||||
## Managing scheduled reminders for your personal account
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.reminders.scheduled-reminders %}
|
||||
1. Next to the organization you'd like to edit scheduled reminders for, click **Edit**.
|
||||
@@ -47,7 +47,7 @@ You can set scheduled reminders for personal or team-level review requests for p
|
||||
{% data reusables.reminders.edit-page %}
|
||||
{% data reusables.reminders.update-buttons %}
|
||||
|
||||
## Deleting scheduled reminders for your user account
|
||||
## Deleting scheduled reminders for your personal account
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.reminders.scheduled-reminders %}
|
||||
1. Next to the organization you'd like to delete reminders for, click **Edit**.
|
||||
|
||||
@@ -114,7 +114,7 @@ The token also includes custom claims provided by {% data variables.product.prod
|
||||
|
||||
| Claim | Description |
|
||||
| ----------- | ---------------------- |
|
||||
| `actor`| The user account that initiated the workflow run. |
|
||||
| `actor`| The personal account that initiated the workflow run. |
|
||||
| `base_ref`| The target branch of the pull request in a workflow run. |
|
||||
| `environment`| The name of the environment used by the job. |
|
||||
| `event_name`| The name of the event that triggered the workflow run. |
|
||||
|
||||
@@ -63,7 +63,7 @@ In the tutorial, you will first make a workflow file that uses the [`alex-page/g
|
||||
|
||||
Whenever an issue in your repository is assigned, the issue will be moved to the specified project board column. If the issue is not already on the project board, it will be added to the project board.
|
||||
|
||||
If your repository is user-owned, the `alex-page/github-project-automation-plus` action will act on all projects in your repository or user account that have the specified project name and column. Likewise, if your repository is organization-owned, the action will act on all projects in your repository or organization that have the specified project name and column.
|
||||
If your repository is user-owned, the `alex-page/github-project-automation-plus` action will act on all projects in your repository or personal account that have the specified project name and column. Likewise, if your repository is organization-owned, the action will act on all projects in your repository or organization that have the specified project name and column.
|
||||
|
||||
Test your workflow by assigning an issue in your repository.
|
||||
|
||||
|
||||
@@ -256,10 +256,10 @@ This list describes the recommended approaches for accessing repository data wit
|
||||
3. **{% data variables.product.prodname_github_app %} tokens**
|
||||
- {% data variables.product.prodname_github_apps %} can be installed on select repositories, and even have granular permissions on the resources within them. You could create a {% data variables.product.prodname_github_app %} internal to your organization, install it on the repositories you need access to within your workflow, and authenticate as the installation within your workflow to access those repositories.
|
||||
4. **Personal access tokens**
|
||||
- You should never use personal access tokens from your own account. These tokens grant access to all repositories within the organizations that you have access to, as well as all personal repositories in your user account. This indirectly grants broad access to all write-access users of the repository the workflow is in. In addition, if you later leave an organization, workflows using this token will immediately break, and debugging this issue can be challenging.
|
||||
- You should never use personal access tokens from your own account. These tokens grant access to all repositories within the organizations that you have access to, as well as all personal repositories in your personal account. This indirectly grants broad access to all write-access users of the repository the workflow is in. In addition, if you later leave an organization, workflows using this token will immediately break, and debugging this issue can be challenging.
|
||||
- If a personal access token is used, it should be one that was generated for a new account that is only granted access to the specific repositories that are needed for the workflow. Note that this approach is not scalable and should be avoided in favor of alternatives, such as deploy keys.
|
||||
5. **SSH keys on a user account**
|
||||
- Workflows should never use the SSH keys on a user account. Similar to personal access tokens, they grant read/write permissions to all of your personal repositories as well as all the repositories you have access to through organization membership. This indirectly grants broad access to all write-access users of the repository the workflow is in. If you're intending to use an SSH key because you only need to perform repository clones or pushes, and do not need to interact with public APIs, then you should use individual deploy keys instead.
|
||||
5. **SSH keys on a personal account**
|
||||
- Workflows should never use the SSH keys on a personal account. Similar to personal access tokens, they grant read/write permissions to all of your personal repositories as well as all the repositories you have access to through organization membership. This indirectly grants broad access to all write-access users of the repository the workflow is in. If you're intending to use an SSH key because you only need to perform repository clones or pushes, and do not need to interact with public APIs, then you should use individual deploy keys instead.
|
||||
|
||||
## Hardening for self-hosted runners
|
||||
|
||||
@@ -300,7 +300,7 @@ If you are using {% data variables.product.prodname_actions %} to deploy to a cl
|
||||
|
||||
## Auditing {% data variables.product.prodname_actions %} events
|
||||
|
||||
You can use the audit log to monitor administrative tasks in an organization. The audit log records the type of action, when it was run, and which user account performed the action.
|
||||
You can use the audit log to monitor administrative tasks in an organization. The audit log records the type of action, when it was run, and which personal account performed the action.
|
||||
|
||||
For example, you can use the audit log to track the `org.update_actions_secret` event, which tracks changes to organization secrets:
|
||||

|
||||
|
||||
@@ -21,7 +21,7 @@ Each node must have a root volume, as well as a separate data volume. These are
|
||||
| :-: | :-: | :-: |
|
||||
| `job-server`,<br/>`memcache-server`,<br/>`web-server` | 14 GB | 1 GB |
|
||||
| `consul-server`,<br/>`mysql-server`,<br/>`redis-server` | 14 GB | 10 GB |
|
||||
| `git-server`,<br/>`metrics-server`,<br/>`pages-server`,<br/>`storage-server` | 7 GB | 10 GB |
|
||||
| `git-server`,<br/>`metrics-server`,<br/>`pages-server`,<br/>`storage-server` | 14 GB | 10 GB |
|
||||
| `elasticsearch-server` | 14 GB | 10 GB |
|
||||
|
||||
## Services required for clustering
|
||||
|
||||
@@ -102,6 +102,7 @@ Across all organizations owned by your enterprise, you can allow members to crea
|
||||
{% data reusables.enterprise-accounts.repo-creation-types %}
|
||||
{% else %}
|
||||
6. Under "Repository creation", use the drop-down menu and choose a policy.
|
||||
|
||||

|
||||
{% endif %}
|
||||
|
||||
@@ -114,7 +115,15 @@ Across all organizations owned by your enterprise, you can allow people with acc
|
||||
{% data reusables.enterprise-accounts.repositories-tab %}
|
||||
3. Under "Repository forking", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %}
|
||||
4. Under "Repository forking", use the drop-down menu and choose a policy.
|
||||
|
||||

|
||||
|
||||
{% if innersource-fork-policies %}
|
||||
5. If forking is enabled, you can specify where users are allowed to fork repositories. Review the information about changing the setting and choose a policy.
|
||||
|
||||

|
||||
{% endif %}
|
||||
|
||||
|
||||
## Enforcing a policy for inviting{% ifversion ghec %} outside{% endif %} collaborators to repositories
|
||||
|
||||
@@ -125,6 +134,7 @@ Across all organizations owned by your enterprise, you can allow members to invi
|
||||
{% data reusables.enterprise-accounts.repositories-tab %}
|
||||
3. Under "Repository {% ifversion ghec %}outside collaborators{% elsif ghes or ghae %}invitations{% endif %}", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %}
|
||||
4. Under "Repository {% ifversion ghec %}outside collaborators{% elsif ghes or ghae %}invitations{% endif %}", use the drop-down menu and choose a policy.
|
||||
|
||||
{% ifversion ghec %}
|
||||

|
||||
{% elsif ghes or ghae %}
|
||||
@@ -180,6 +190,7 @@ Across all organizations owned by your enterprise, you can allow members with ad
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
3. On the **Repository policies** tab, under "Repository issue deletion", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %}
|
||||
4. Under "Repository issue deletion", use the drop-down menu and choose a policy.
|
||||
|
||||

|
||||
|
||||
{% ifversion ghes or ghae %}
|
||||
|
||||
@@ -26,7 +26,7 @@ If you can't access {% data variables.product.product_name %}, contact your loca
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
{% data reusables.saml.dotcom-saml-explanation %} Organization owners can invite your user account on {% data variables.product.prodname_dotcom %} to join their organization that uses SAML SSO, which allows you to contribute to the organization and retain your existing identity and contributions on {% data variables.product.prodname_dotcom %}.
|
||||
{% data reusables.saml.dotcom-saml-explanation %} Organization owners can invite your personal account on {% data variables.product.prodname_dotcom %} to join their organization that uses SAML SSO, which allows you to contribute to the organization and retain your existing identity and contributions on {% data variables.product.prodname_dotcom %}.
|
||||
|
||||
If you're a member of an {% data variables.product.prodname_emu_enterprise %}, you will use a new account that is provisioned for you. {% data reusables.enterprise-accounts.emu-more-info-account %}
|
||||
|
||||
|
||||
@@ -25,10 +25,12 @@ To maintain account security, you can regularly review your SSH keys list and re
|
||||
If you haven't used your SSH key for a year, then {% data variables.product.prodname_dotcom %} will automatically delete your inactive SSH key as a security precaution. For more information, see "[Deleted or missing SSH keys](/articles/deleted-or-missing-ssh-keys)."
|
||||
{% endif %}
|
||||
|
||||
If you're a member of an organization that provides SSH certificates, you can use your certificate to access that organization's repositories without adding the certificate to your account on {% data variables.product.product_name %}. You cannot use your certificate to access forks of the organization's repositories that are owned by your user account. For more information, see "[About SSH certificate authorities](/articles/about-ssh-certificate-authorities)."
|
||||
{% ifversion fpt %}
|
||||
Organizations that use {% data variables.product.prodname_ghe_cloud %} can provide SSH certificates, which members can use to access that organization's repositories without adding the certificate to their account on {% data variables.product.product_name %}. If you're using an SSH certificate, you cannot use the certificate to access forks of the organization's repositories, if the fork is owned by your personal account. For more information, see "[About SSH certificate authorities](/enterprise-cloud@latest/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)" in the {% data variables.product.prodname_ghe_cloud %} documentation.
|
||||
{% else ghec or ghes or ghae %}
|
||||
If you're a member of an organization that provides SSH certificates, you can use your certificate to access that organization's repositories without adding the certificate to your account on {% data variables.product.product_name %}. You cannot use your certificate to access forks of the organization's repositories, if the forks is owned by your personal account. For more information, see "[About SSH certificate authorities](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)."
|
||||
{% endif %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[Checking for existing SSH keys](/articles/checking-for-existing-ssh-keys)"
|
||||
- "[Testing your SSH connection](/articles/testing-your-ssh-connection)"
|
||||
- "[Troubleshooting SSH](/articles/troubleshooting-ssh)"
|
||||
|
||||
@@ -33,7 +33,7 @@ You can authenticate to {% data variables.product.product_name %} in your browse
|
||||
{% endif %}
|
||||
|
||||
- **Username and password only**
|
||||
- You'll create a password when you create your user account on {% data variables.product.product_name %}. We recommend that you use a password manager to generate a random and unique password. For more information, see "[Creating a strong password](/github/authenticating-to-github/creating-a-strong-password)."
|
||||
- You'll create a password when you create your personal account on {% data variables.product.product_name %}. We recommend that you use a password manager to generate a random and unique password. For more information, see "[Creating a strong password](/github/authenticating-to-github/creating-a-strong-password)."
|
||||
- **Two-factor authentication (2FA)** (recommended)
|
||||
- If you enable 2FA, we'll also prompt you to provide a code that's generated by an application on your mobile device or sent as a text message (SMS) after you successfully enter your username and password. For more information, see "[Accessing {% data variables.product.prodname_dotcom %} using two-factor authentication](/github/authenticating-to-github/accessing-github-using-two-factor-authentication#providing-a-2fa-code-when-signing-in-to-the-website)."
|
||||
- In addition to authentication with a mobile application or a text message, you can optionally add a secondary method of authentication with a security key using WebAuthn. For more information, see "[Configuring two-factor authentication using a security key](/github/authenticating-to-github/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)."
|
||||
|
||||
@@ -77,7 +77,7 @@ When {% data variables.product.prodname_oauth_apps %} request new access permiss
|
||||
|
||||
## {% data variables.product.prodname_oauth_apps %} and organizations
|
||||
|
||||
When you authorize an {% data variables.product.prodname_oauth_app %} for your personal user account, you'll also see how the authorization will affect each organization you're a member of.
|
||||
When you authorize an {% data variables.product.prodname_oauth_app %} for your personal account, you'll also see how the authorization will affect each organization you're a member of.
|
||||
|
||||
- **For organizations *with* {% data variables.product.prodname_oauth_app %} access restrictions, you can request that organization admins approve the application for use in that organization.** If the organization does not approve the application, then the application will only be able to access the organization's public resources. If you're an organization admin, you can [approve the application](/articles/approving-oauth-apps-for-your-organization) yourself.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Reviewing your security log
|
||||
intro: You can review the security log for your user account to better understand actions you've performed and actions others have performed that involve you.
|
||||
intro: You can review the security log for your personal account to better understand actions you've performed and actions others have performed that involve you.
|
||||
miniTocMaxHeadingLevel: 3
|
||||
redirect_from:
|
||||
- /articles/reviewing-your-security-log
|
||||
@@ -87,7 +87,7 @@ An overview of some of the most common actions that are recorded as events in th
|
||||
| `resume` | Triggered when you resume a suspended codespace.
|
||||
| `delete` | Triggered when you [delete a codespace](/github/developing-online-with-codespaces/deleting-a-codespace).
|
||||
| `manage_access_and_security` | Triggered when you update [the repositories a codespace has access to](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces).
|
||||
| `trusted_repositories_access_update` | Triggered when you change your user account's [access and security setting for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces).
|
||||
| `trusted_repositories_access_update` | Triggered when you change your personal account's [access and security setting for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces).
|
||||
|
||||
### `marketplace_agreement_signature` category actions
|
||||
|
||||
@@ -186,16 +186,16 @@ An overview of some of the most common actions that are recorded as events in th
|
||||
| `sponsor_sponsorship_payment_complete` | Triggered after you sponsor an account and your payment has been processed (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)")
|
||||
| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)")
|
||||
| `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
|
||||
| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `sponsored_developer_disable` | Triggered when your {% data variables.product.prodname_sponsors %} account is disabled
|
||||
| `sponsored_developer_redraft` | Triggered when your {% data variables.product.prodname_sponsors %} account is returned to draft state from approved state
|
||||
| `sponsored_developer_profile_update` | Triggered when you edit your sponsored developer profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)")
|
||||
| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)")
|
||||
| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors)")
|
||||
| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `waitlist_join` | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `waitlist_join` | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
@@ -203,11 +203,11 @@ An overview of some of the most common actions that are recorded as events in th
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `accept` | Triggered when you accept a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)")
|
||||
| `cancel` | Triggered when you cancel a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)")
|
||||
| `create` | Triggered when you create a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)")
|
||||
| `decline` | Triggered when you decline a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)")
|
||||
| `revoke` | Triggered when you revoke a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)")
|
||||
| `accept` | Triggered when you accept a succession invitation (see "[Maintaining ownership continuity of your personal account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)")
|
||||
| `cancel` | Triggered when you cancel a succession invitation (see "[Maintaining ownership continuity of your personal account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)")
|
||||
| `create` | Triggered when you create a succession invitation (see "[Maintaining ownership continuity of your personal account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)")
|
||||
| `decline` | Triggered when you decline a succession invitation (see "[Maintaining ownership continuity of your personal account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)")
|
||||
| `revoke` | Triggered when you revoke a succession invitation (see "[Maintaining ownership continuity of your personal account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)")
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghes or ghae %}
|
||||
@@ -239,9 +239,9 @@ An overview of some of the most common actions that are recorded as events in th
|
||||
| Action | Description
|
||||
|--------------------|---------------------
|
||||
| `add_email` | Triggered when you {% ifversion not ghae %}[add a new email address](/articles/changing-your-primary-email-address){% else %}add a new email address{% endif %}.{% ifversion fpt or ghec %}
|
||||
| `codespaces_trusted_repo_access_granted` | Triggered when you [allow the codespaces you create for a repository to access other repositories owned by your user account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces).
|
||||
| `codespaces_trusted_repo_access_revoked` | Triggered when you [disallow the codespaces you create for a repository to access other repositories owned by your user account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). {% endif %}
|
||||
| `create` | Triggered when you create a new user account.{% ifversion not ghae %}
|
||||
| `codespaces_trusted_repo_access_granted` | Triggered when you [allow the codespaces you create for a repository to access other repositories owned by your personal account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces).
|
||||
| `codespaces_trusted_repo_access_revoked` | Triggered when you [disallow the codespaces you create for a repository to access other repositories owned by your personal account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). {% endif %}
|
||||
| `create` | Triggered when you create a new personal account.{% ifversion not ghae %}
|
||||
| `change_password` | Triggered when you change your password.
|
||||
| `forgot_password` | Triggered when you ask for [a password reset](/articles/how-can-i-reset-my-password).{% endif %}
|
||||
| `hide_private_contributions_count` | Triggered when you [hide private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).
|
||||
|
||||
@@ -19,6 +19,8 @@ Before adding a new GPG key to your account on {% ifversion ghae %}{% data varia
|
||||
- [Checked for existing GPG keys](/articles/checking-for-existing-gpg-keys)
|
||||
- [Generated and copied a new GPG key](/articles/generating-a-new-gpg-key)
|
||||
|
||||
You can add multiple public keys to your GitHub account. Commits signed by any of the corresponding private keys will show as verified. If you remove a public key, any commits signed by the corresponding private key will no longer show as verified.
|
||||
|
||||
{% data reusables.gpg.supported-gpg-key-algorithms %}
|
||||
|
||||
When verifying a signature, we extract the signature and attempt to parse its key-id. We match the key-id with keys uploaded to {% data variables.product.product_name %}. Until you upload your GPG key to {% data variables.product.product_name %}, we cannot verify your signatures.
|
||||
|
||||
@@ -15,6 +15,6 @@ topics:
|
||||
- SSH
|
||||
shortTitle: Permission denied other-repo
|
||||
---
|
||||
To fix this, remove the deploy key from the repository, and [add the key to your user account](/articles/adding-a-new-ssh-key-to-your-github-account) instead.
|
||||
To fix this, remove the deploy key from the repository, and [add the key to your personal account](/articles/adding-a-new-ssh-key-to-your-github-account) instead.
|
||||
|
||||
If the key you are using is intended to be a deploy key, check out [our guide on deploy keys](/guides/managing-deploy-keys) for more details.
|
||||
|
||||
@@ -32,9 +32,9 @@ As soon as you set a spending limit other than $0, you will be responsible for a
|
||||
|
||||
Because you have not enabled overages, your next attempt to create a workflow artifact will fail. You will not receive a bill for the 0.1GB overage that month. However, if you enable overages, your first bill will include the 0.1GB of existing overage for the current billing cycle, as well as any additional overages you accrue.
|
||||
|
||||
## Managing the spending limit for {% data variables.product.prodname_actions %} for your user account
|
||||
## Managing the spending limit for {% data variables.product.prodname_actions %} for your personal account
|
||||
|
||||
Anyone can manage the spending limit for {% data variables.product.prodname_actions %} for their own user account.
|
||||
Anyone can manage the spending limit for {% data variables.product.prodname_actions %} for their own personal account.
|
||||
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.user-settings.billing_plans %}
|
||||
|
||||
@@ -17,9 +17,9 @@ shortTitle: View your Actions usage
|
||||
---
|
||||
You can also view the billable job execution minutes for an individual workflow run. For more information, see "[Viewing job execution time](/actions/managing-workflow-runs/viewing-job-execution-time)."
|
||||
|
||||
## Viewing {% data variables.product.prodname_actions %} usage for your user account
|
||||
## Viewing {% data variables.product.prodname_actions %} usage for your personal account
|
||||
|
||||
Anyone can view {% data variables.product.prodname_actions %} usage for their own user account.
|
||||
Anyone can view {% data variables.product.prodname_actions %} usage for their own personal account.
|
||||
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.user-settings.billing_plans %}
|
||||
|
||||
@@ -25,6 +25,8 @@ shortTitle: Advanced Security billing
|
||||
|
||||
If you want to use {% data variables.product.prodname_GH_advanced_security %} features on any repository apart from a public repository on {% data variables.product.prodname_dotcom_the_website %}, you will need a {% data variables.product.prodname_GH_advanced_security %} license, available with {% data variables.product.prodname_ghe_cloud %} or {% data variables.product.prodname_ghe_server %}. For more information about {% data variables.product.prodname_GH_advanced_security %}, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)."
|
||||
|
||||
For more information about billing for {% data variables.product.prodname_GH_advanced_security %}, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security).
|
||||
|
||||
{% elsif ghec %}
|
||||
|
||||
If you want to use {% data variables.product.prodname_GH_advanced_security %} features on any repository apart from a public repository on {% data variables.product.prodname_dotcom_the_website %}, you will need a {% data variables.product.prodname_GH_advanced_security %} license. For more information about {% data variables.product.prodname_GH_advanced_security %}, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)."
|
||||
@@ -35,12 +37,10 @@ You can make extra features for code security available to users by buying and u
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes or ghec %}
|
||||
{% ifversion ghes or ghec %}
|
||||
|
||||
{% data reusables.advanced-security.license-overview %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
To discuss licensing {% data variables.product.prodname_GH_advanced_security %} for your enterprise, contact {% data variables.contact.contact_enterprise_sales %}.
|
||||
|
||||
## About committer numbers for {% data variables.product.prodname_GH_advanced_security %}
|
||||
@@ -82,3 +82,5 @@ The following example timeline demonstrates how active committer count for {% da
|
||||
## Getting the most out of {% data variables.product.prodname_GH_advanced_security %}
|
||||
|
||||
{% data reusables.advanced-security.getting-the-most-from-your-license %}
|
||||
|
||||
{% endif %}
|
||||
@@ -11,7 +11,6 @@ redirect_from:
|
||||
- /github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-advanced-security-usage
|
||||
versions:
|
||||
ghes: '*'
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghae: issue-5378
|
||||
miniTocMaxHeadingLevel: 3
|
||||
|
||||
@@ -56,7 +56,9 @@ For information on managing and changing your account's spending limit, see "[Ma
|
||||
|
||||
## Limiting the choice of machine types
|
||||
|
||||
The type of machine a user chooses when they create a codespace affects the per-minute charge for that codespace, as shown above.
|
||||
By default the machine type with the lowest valid resources is used when a codespace is created. However, users may be able to choose a machine type with more resources. They can do this either when they create a codespace, or they can change the machine type of an existing codespace. For more information, see "[Creating a codespace"](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)" and "[Changing the machine type for your codespace](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace)."
|
||||
|
||||
If a machine type that has more resources is chosen, this will affect the per-minute charge for that codespace, as shown above.
|
||||
|
||||
Organization owners can create a policy to restrict the machine types that are available to users. For more information, see "[Restricting access to machine types](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)."
|
||||
|
||||
|
||||
@@ -33,9 +33,9 @@ As soon as you set a spending limit other than $0, you will be responsible for a
|
||||
|
||||
Because you have not enabled overages, your next attempt to publish a version of the package will fail. You will not receive a bill for the 0.1GB overage that month. However, if you enable overages, your first bill will include the 0.1GB of existing overage for the current billing cycle, as well as any additional overages you accrue.
|
||||
|
||||
## Managing the spending limit for {% data variables.product.prodname_registry %} for your user account
|
||||
## Managing the spending limit for {% data variables.product.prodname_registry %} for your personal account
|
||||
|
||||
Anyone can manage the spending limit for {% data variables.product.prodname_registry %} for their own user account.
|
||||
Anyone can manage the spending limit for {% data variables.product.prodname_registry %} for their own personal account.
|
||||
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.user-settings.billing_plans %}
|
||||
|
||||
@@ -16,9 +16,9 @@ topics:
|
||||
- User account
|
||||
shortTitle: View your usage
|
||||
---
|
||||
## Viewing {% data variables.product.prodname_registry %} usage for your user account
|
||||
## Viewing {% data variables.product.prodname_registry %} usage for your personal account
|
||||
|
||||
Anyone can view {% data variables.product.prodname_registry %} usage for their own user account.
|
||||
Anyone can view {% data variables.product.prodname_registry %} usage for their own personal account.
|
||||
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.user-settings.billing_plans %}
|
||||
|
||||
@@ -30,17 +30,17 @@ shortTitle: Downgrade subscription
|
||||
---
|
||||
## Downgrading your {% data variables.product.product_name %} subscription
|
||||
|
||||
When you downgrade your user account or organization's subscription, pricing and account feature changes take effect on your next billing date. Changes to your paid user account or organization subscription does not affect subscriptions or payments for other paid {% data variables.product.prodname_dotcom %} features. For more information, see "[How does upgrading or downgrading affect the billing process?](/articles/how-does-upgrading-or-downgrading-affect-the-billing-process)."
|
||||
When you downgrade your personal account or organization's subscription, pricing and account feature changes take effect on your next billing date. Changes to your paid personal account or organization subscription does not affect subscriptions or payments for other paid {% data variables.product.prodname_dotcom %} features. For more information, see "[How does upgrading or downgrading affect the billing process?](/articles/how-does-upgrading-or-downgrading-affect-the-billing-process)."
|
||||
|
||||
## Downgrading your user account's subscription
|
||||
## Downgrading your personal account's subscription
|
||||
|
||||
If you downgrade your user account from {% data variables.product.prodname_pro %} to {% data variables.product.prodname_free_user %}, the account will lose access to advanced code review tools on private repositories. {% data reusables.gated-features.more-info %}
|
||||
If you downgrade your personal account from {% data variables.product.prodname_pro %} to {% data variables.product.prodname_free_user %}, the account will lose access to advanced code review tools on private repositories. {% data reusables.gated-features.more-info %}
|
||||
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.user-settings.billing_plans %}
|
||||
1. Under "Current plan", use the **Edit** drop-down and click **Downgrade to Free**.
|
||||

|
||||
5. Read the information about the features your user account will no longer have access to on your next billing date, then click **I understand. Continue with downgrade**.
|
||||
5. Read the information about the features your personal account will no longer have access to on your next billing date, then click **I understand. Continue with downgrade**.
|
||||

|
||||
|
||||
If you published a {% data variables.product.prodname_pages %} site in a private repository and added a custom domain, remove or update your DNS records before downgrading from {% data variables.product.prodname_pro %} to {% data variables.product.prodname_free_user %}, to avoid the risk of a domain takeover. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."
|
||||
|
||||
@@ -16,7 +16,7 @@ topics:
|
||||
- User account
|
||||
shortTitle: Billing process
|
||||
---
|
||||
Changes to your paid user account or organization subscription does not affect subscriptions or payments for other paid {% data variables.product.prodname_dotcom %} features, such as {% data variables.large_files.product_name_long %} or paid apps purchased in {% data variables.product.prodname_marketplace %}.
|
||||
Changes to your paid personal account or organization subscription does not affect subscriptions or payments for other paid {% data variables.product.prodname_dotcom %} features, such as {% data variables.large_files.product_name_long %} or paid apps purchased in {% data variables.product.prodname_marketplace %}.
|
||||
|
||||
For more information, see "[{% data variables.product.prodname_dotcom %}'s products](/articles/github-s-products)" and "[About billing on {% data variables.product.prodname_dotcom %}](/articles/about-billing-on-github)."
|
||||
|
||||
|
||||
@@ -40,7 +40,7 @@ When you upgrade the subscription for an account, the upgrade changes the paid f
|
||||
|
||||
## Upgrading your personal account's subscription
|
||||
|
||||
You can upgrade your personal account from {% data variables.product.prodname_free_user %} to {% data variables.product.prodname_pro %} to get advanced code review tools on private repositories owned by your user account. Upgrading your personal account does not affect any organizations you may manage or repositories owned by those organizations. {% data reusables.gated-features.more-info %}
|
||||
You can upgrade your personal account from {% data variables.product.prodname_free_user %} to {% data variables.product.prodname_pro %} to get advanced code review tools on private repositories owned by your personal account. Upgrading your personal account does not affect any organizations you may manage or repositories owned by those organizations. {% data reusables.gated-features.more-info %}
|
||||
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.user-settings.billing_plans %}
|
||||
|
||||
@@ -23,15 +23,15 @@ shortTitle: About
|
||||
|
||||
{% data reusables.enterprise-accounts.vss-ghe-description %} {% data variables.product.prodname_vss_ghe %} is available from Microsoft under the terms of the Microsoft Enterprise Agreement. For more information, see [{% data variables.product.prodname_vss_ghe %}](https://visualstudio.microsoft.com/subscriptions/visual-studio-github/) on the {% data variables.product.prodname_vs %} website.
|
||||
|
||||
To use the {% data variables.product.prodname_enterprise %} portion of the license, each subscriber's user account on {% data variables.product.prodname_dotcom_the_website %} must be or become a member of an organization owned by your enterprise on {% data variables.product.prodname_dotcom_the_website %}. To accomplish this, organization owners can invite new members to an organization by email address. The subscriber can accept the invitation with an existing user account on {% data variables.product.prodname_dotcom_the_website %} or create a new account.
|
||||
To use the {% data variables.product.prodname_enterprise %} portion of the license, each subscriber's personal account on {% data variables.product.prodname_dotcom_the_website %} must be or become a member of an organization owned by your enterprise on {% data variables.product.prodname_dotcom_the_website %}. To accomplish this, organization owners can invite new members to an organization by email address. The subscriber can accept the invitation with an existing personal account on {% data variables.product.prodname_dotcom_the_website %} or create a new account.
|
||||
|
||||
For more information about the setup of {% data variables.product.prodname_vss_ghe %}, see "[Setting up {% data variables.product.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise)."
|
||||
|
||||
## About licenses for {% data variables.product.prodname_vss_ghe %}
|
||||
|
||||
After you assign a license for {% data variables.product.prodname_vss_ghe %} to a subscriber, the subscriber will use the {% data variables.product.prodname_enterprise %} portion of the license by joining an organization in your enterprise with a user account on {% data variables.product.prodname_dotcom_the_website %}. If the email address for the user account of an enterprise member on {% data variables.product.prodname_dotcom_the_website %} matches the User Primary Name (UPN) for a subscriber to your {% data variables.product.prodname_vs %} account, the {% data variables.product.prodname_vs %} subscriber will automatically consume one license for {% data variables.product.prodname_vss_ghe %}.
|
||||
After you assign a license for {% data variables.product.prodname_vss_ghe %} to a subscriber, the subscriber will use the {% data variables.product.prodname_enterprise %} portion of the license by joining an organization in your enterprise with a personal account on {% data variables.product.prodname_dotcom_the_website %}. If the email address for the personal account of an enterprise member on {% data variables.product.prodname_dotcom_the_website %} matches the User Primary Name (UPN) for a subscriber to your {% data variables.product.prodname_vs %} account, the {% data variables.product.prodname_vs %} subscriber will automatically consume one license for {% data variables.product.prodname_vss_ghe %}.
|
||||
|
||||
The total quantity of your licenses for your enterprise on {% data variables.product.prodname_dotcom %} is the sum of any standard {% data variables.product.prodname_enterprise %} licenses and the number of {% data variables.product.prodname_vs %} subscription licenses that include access to {% data variables.product.prodname_dotcom %}. If the user account for an enterprise member does not correspond with the email address for a {% data variables.product.prodname_vs %} subscriber, the license that the user account consumes is unavailable for a {% data variables.product.prodname_vs %} subscriber.
|
||||
The total quantity of your licenses for your enterprise on {% data variables.product.prodname_dotcom %} is the sum of any standard {% data variables.product.prodname_enterprise %} licenses and the number of {% data variables.product.prodname_vs %} subscription licenses that include access to {% data variables.product.prodname_dotcom %}. If the personal account for an enterprise member does not correspond with the email address for a {% data variables.product.prodname_vs %} subscriber, the license that the personal account consumes is unavailable for a {% data variables.product.prodname_vs %} subscriber.
|
||||
|
||||
For more information about {% data variables.product.prodname_enterprise %}, see "[{% data variables.product.company_short %}'s products](/github/getting-started-with-github/githubs-products#github-enterprise)." For more information about accounts on {% data variables.product.prodname_dotcom_the_website %}, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/github/getting-started-with-github/types-of-github-accounts)."
|
||||
|
||||
|
||||
@@ -27,9 +27,9 @@ Before setting up {% data variables.product.prodname_vss_ghe %}, it's important
|
||||
| :- | :- | :- | :- |
|
||||
| **Subscriptions admin** | {% data variables.product.prodname_vs %} subscription | Person who assigns licenses for {% data variables.product.prodname_vs %} subscription | [Overview of admin responsibilities](https://docs.microsoft.com/en-us/visualstudio/subscriptions/admin-responsibilities) in Microsoft Docs |
|
||||
| **Subscriber** | {% data variables.product.prodname_vs %} subscription | Person who uses a license for {% data variables.product.prodname_vs %} subscription | [Visual Studio Subscriptions documentation](https://docs.microsoft.com/en-us/visualstudio/subscriptions/) in Microsoft Docs |
|
||||
| **Enterprise owner** | {% data variables.product.prodname_dotcom %} | Person who has a user account that's an administrator of an enterprise on {% data variables.product.product_location %} | "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owner)" |
|
||||
| **Organization owner** | {% data variables.product.prodname_dotcom %} | Person who has a user account that's an owner of an organization in your team's enterprise on {% data variables.product.product_location %} | "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#organization-owners)" |
|
||||
| **Enterprise member** | {% data variables.product.prodname_dotcom %} | Person who has a user account that's a member of an enterprise on {% data variables.product.product_location %} | "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-members)" |
|
||||
| **Enterprise owner** | {% data variables.product.prodname_dotcom %} | Person who has a personal account that's an administrator of an enterprise on {% data variables.product.product_location %} | "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owner)" |
|
||||
| **Organization owner** | {% data variables.product.prodname_dotcom %} | Person who has a personal account that's an owner of an organization in your team's enterprise on {% data variables.product.product_location %} | "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#organization-owners)" |
|
||||
| **Enterprise member** | {% data variables.product.prodname_dotcom %} | Person who has a personal account that's a member of an enterprise on {% data variables.product.product_location %} | "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-members)" |
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -52,14 +52,14 @@ One person may be able to complete the tasks because the person has all of the r
|
||||
|
||||
1. If the subscription admin has not disabled email notifications, the subscriber will receive two confirmation emails. For more information, see [{% data variables.product.prodname_vs %} subscriptions with {% data variables.product.prodname_enterprise %}](https://docs.microsoft.com/en-us/visualstudio/subscriptions/access-github#what-is-the-visual-studio-subscription-with-github-enterprise-setup-process) in Microsoft Docs.
|
||||
|
||||
1. An organization owner must invite the subscriber to the organization on {% data variables.product.product_location %} from step 1. The subscriber can accept the invitation with an existing user account on {% data variables.product.prodname_dotcom_the_website %} or create a new account. After the subscriber joins the organization, the subscriber becomes an enterprise member. For more information, see "[Inviting users to join your organization](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)."
|
||||
1. An organization owner must invite the subscriber to the organization on {% data variables.product.product_location %} from step 1. The subscriber can accept the invitation with an existing personal account on {% data variables.product.prodname_dotcom_the_website %} or create a new account. After the subscriber joins the organization, the subscriber becomes an enterprise member. For more information, see "[Inviting users to join your organization](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)."
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tips**:
|
||||
|
||||
- While not required, we recommend that the organization owner sends an invitation to the same email address used for the subscriber's User Primary Name (UPN). When the email address on {% data variables.product.product_location %} matches the subscriber's UPN, you can ensure that another enterprise does not claim the subscriber's license.
|
||||
- If the subscriber accepts the invitation to the organization with an existing user account on {% data variables.product.product_location %}, we recommend that the subscriber add the email address they use for {% data variables.product.prodname_vs %} to their user account on {% data variables.product.product_location %}. For more information, see "[Adding an email address to your {% data variables.product.prodname_dotcom %} account](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/adding-an-email-address-to-your-github-account)."
|
||||
- If the subscriber accepts the invitation to the organization with an existing personal account on {% data variables.product.product_location %}, we recommend that the subscriber add the email address they use for {% data variables.product.prodname_vs %} to their personal account on {% data variables.product.product_location %}. For more information, see "[Adding an email address to your {% data variables.product.prodname_dotcom %} account](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/adding-an-email-address-to-your-github-account)."
|
||||
- If the organization owner must invite a large number of subscribers, a script may make the process faster. For more information, see [the sample PowerShell script](https://github.com/github/platform-samples/blob/master/api/powershell/invite_members_to_org.ps1) in the `github/platform-samples` repository.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
@@ -14,7 +14,7 @@ topics:
|
||||
- Organizations
|
||||
shortTitle: About organizations
|
||||
---
|
||||
To access an organization, each member must sign into their own personal user account.
|
||||
To access an organization, each member must sign into their own personal account.
|
||||
|
||||
Organization members can have different roles, such as *owner* or *billing manager*:
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ Before you start, make sure you know:
|
||||
|
||||
You will use your personal account to set up the organization. You'll also need to sign in to this account to renew or make changes to your client's subscription in the future.
|
||||
|
||||
If you already have a personal {% data variables.product.prodname_dotcom %} user account, skip to [step 2](#step-2-create-the-organization).
|
||||
If you already have a personal account on {% data variables.product.prodname_dotcom %}, skip to [step 2](#step-2-create-the-organization).
|
||||
|
||||
1. Go to the [Join GitHub](https://github.com/join) page.
|
||||
2. Under "Create your personal account," type your username, email address, and password, then click **Create an account**.
|
||||
|
||||
@@ -180,11 +180,9 @@ jobs:
|
||||
runs-on: [self-hosted, ubuntu-latest]
|
||||
```
|
||||
|
||||
{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} supports the latest versions of Ubuntu, Windows, and macOS. Typical values for this setting are therefore: `ubuntu-latest`, `windows-latest`, and `macos-latest`. For more information, see {% ifversion ghes %}"[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#self-hosted-runners)" and "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners){% else %}"[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on){% endif %}."
|
||||
{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} supports the latest versions of Ubuntu, Windows, and macOS. Typical values for this setting are therefore: `ubuntu-latest`, `windows-latest`, and `macos-latest`. For more information, see "[Choosing the runner for a job](/actions/using-jobs/choosing-the-runner-for-a-job)" and "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)."
|
||||
|
||||
{% ifversion ghes %}You must ensure that Git is in the PATH variable on your self-hosted runners.{% else %}If you use a self-hosted runner, you must ensure that Git is in the PATH variable.{% endif %}
|
||||
|
||||
For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)."
|
||||
{% ifversion ghes %}You must ensure that Git is in the PATH variable on your self-hosted runners.{% else %}If you use a self-hosted runner, you must ensure that Git is in the PATH variable.{% endif %} For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)."
|
||||
|
||||
For recommended specifications (RAM, CPU cores, and disk) for running {% data variables.product.prodname_codeql %} analysis{% ifversion not ghes %} on self-hosted machines{% endif %}, see "[Recommended hardware resources for running {% data variables.product.prodname_codeql %}](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/recommended-hardware-resources-for-running-codeql)."
|
||||
|
||||
|
||||
@@ -84,10 +84,16 @@ Enterprise owners, organization and repository administrators can add self-hoste
|
||||
|
||||
## Setting up {% data variables.product.prodname_code_scanning %} manually
|
||||
|
||||
{% ifversion fpt %}
|
||||
|
||||
You can set up {% data variables.product.prodname_code_scanning %} in any public repository where you have write access.
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.code-scanning.billing %}
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-security %}
|
||||
1. To the right of "{% data variables.product.prodname_code_scanning_capc %} alerts", click **Set up {% data variables.product.prodname_code_scanning %}**. If {% data variables.product.prodname_code_scanning %} is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" or "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."
|
||||
1. To the right of "{% data variables.product.prodname_code_scanning_capc %} alerts", click **Set up {% data variables.product.prodname_code_scanning %}**.{% ifversion ghec or ghes or ghae %} If {% data variables.product.prodname_code_scanning %} is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}.{% endif %} For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" or "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."
|
||||

|
||||
4. Under "Get started with {% data variables.product.prodname_code_scanning %}", click **Set up this workflow** on the {% data variables.product.prodname_codeql_workflow %} or on a third-party workflow.
|
||||
Workflows are only displayed if they are relevant for the programming languages detected in the repository. The {% data variables.product.prodname_codeql_workflow %} is always displayed, but the "Set up this workflow" button is only enabled if {% data variables.product.prodname_codeql %} analysis supports the languages present in the repository.
|
||||
|
||||
@@ -61,7 +61,7 @@ For a list of the ecosystems that {% data variables.product.product_name %} can
|
||||
|
||||
{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %} detects vulnerable dependencies in _public_ repositories and displays the dependency graph, but does not generate {% data variables.product.prodname_dependabot_alerts %} by default. Repository owners or people with admin access can enable {% data variables.product.prodname_dependabot_alerts %} for public repositories. Owners of private repositories, or people with admin access, can enable {% data variables.product.prodname_dependabot_alerts %} by enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for their repositories.
|
||||
|
||||
You can also enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)."
|
||||
You can also enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your user account or organization. For more information, see "[Configuring {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts)."
|
||||
|
||||
For information about access requirements for actions related to {% data variables.product.prodname_dependabot_alerts %}, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization#access-requirements-for-security-features)."
|
||||
|
||||
|
||||
@@ -0,0 +1,110 @@
|
||||
---
|
||||
title: Configuring Dependabot alerts
|
||||
intro: 'Enable {% data variables.product.prodname_dependabot_alerts %} to be notified when a new vulnerability is found in one of your dependencies.'
|
||||
shortTitle: Configure Dependabot alerts
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: issue-4864
|
||||
ghec: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Dependabot
|
||||
- Security updates
|
||||
- Alerts
|
||||
- Dependencies
|
||||
- Pull requests
|
||||
- Repositories
|
||||
---
|
||||
|
||||
## About {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies
|
||||
|
||||
{% data reusables.repositories.a-vulnerability-is %}
|
||||
|
||||
Dependabot performs a scan to detect vulnerable dependencies and sends Dependabot alerts when a new vulnerability is added to the GitHub Advisory Database or the dependency graph for a repository changes. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)."
|
||||
|
||||
You can enable or disable {% data variables.product.prodname_dependabot_alerts %} for:
|
||||
* Your personal account
|
||||
* Your repository
|
||||
* Your organization
|
||||
|
||||
## Managing {% data variables.product.prodname_dependabot_alerts %} for your personal account
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
You can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your personal account.
|
||||
|
||||
### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for existing repositories
|
||||
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.user-settings.security-analysis %}
|
||||
3. Under "Code security and analysis", to the right of {% data variables.product.prodname_dependabot_alerts %}, click **Disable all** or **Enable all**.
|
||||

|
||||
4. Optionally, enable {% data variables.product.prodname_dependabot_alerts %} by default for new repositories that you create.
|
||||

|
||||
5. Click **Disable {% data variables.product.prodname_dependabot_alerts %}** or **Enable {% data variables.product.prodname_dependabot_alerts %}** to disable or enable {% data variables.product.prodname_dependabot_alerts %} for all the repositories you own.
|
||||

|
||||
|
||||
When you enable {% data variables.product.prodname_dependabot_alerts %} for existing repositories, you will see any results displayed on GitHub within minutes.
|
||||
|
||||
### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for new repositories
|
||||
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.user-settings.security-analysis %}
|
||||
3. Under "Code security and analysis", to the right of {% data variables.product.prodname_dependabot_alerts %}, enable or disable {% data variables.product.prodname_dependabot_alerts %} by default for new repositories that you create.
|
||||

|
||||
|
||||
{% else %}
|
||||
{% data variables.product.prodname_dependabot_alerts %} for your repositories can be enabled or disabled by your enterprise owner. For more information, see "[Enabling Dependabot for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Managing {% data variables.product.prodname_dependabot_alerts %} for your repository
|
||||
|
||||
{% ifversion fpt or ghec %}You can manage {% data variables.product.prodname_dependabot_alerts %} for your public, private or internal repository.
|
||||
|
||||
By default, we notify people with admin permissions in the affected repositories about new {% data variables.product.prodname_dependabot_alerts %}. {% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository. You can also make {% data variables.product.prodname_dependabot_alerts %} visible to additional people or teams working repositories that you own or have admin permissions for.
|
||||
|
||||
{% data reusables.security.security-and-analysis-features-enable-read-only %}
|
||||
|
||||
### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for a repository
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% 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_alerts %}, click **Disable** or **Enable**.
|
||||

|
||||
{% endif %}{% ifversion ghes or ghae %}
|
||||
|
||||
{% data variables.product.prodname_dependabot_alerts %} for your repository can be enabled or disabled by your enterprise owner. For more information, see "[Enabling Dependabot for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)."
|
||||
{% endif %}
|
||||
|
||||
## Managing {% data variables.product.prodname_dependabot_alerts %} for your organization
|
||||
{% ifversion fpt or ghec %}You can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your organization. Your changes affect all repositories.
|
||||
|
||||
### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for all existing repositories
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% data reusables.organizations.security-and-analysis %}
|
||||
2. Under "Code security and analysis", to the right of {% data variables.product.prodname_dependabot_alerts %}, click **Disable all** or **Enable all**.
|
||||
{% ifversion fpt or ghec %}
|
||||

|
||||
{% endif %}
|
||||
{% ifversion ghae %}
|
||||

|
||||
{% endif %}
|
||||
{% ifversion fpt or ghec %}
|
||||
3. Optionally, enable {% data variables.product.prodname_dependabot_alerts %} by default for new repositories in your organization.
|
||||
{% ifversion fpt or ghec %}
|
||||

|
||||
{% endif %}
|
||||
|
||||
{% endif %}
|
||||
{% ifversion fpt or ghec %}
|
||||
4. Click **Disable {% data variables.product.prodname_dependabot_alerts %}** or **Enable {% data variables.product.prodname_dependabot_alerts %}** to disable or enable {% data variables.product.prodname_dependabot_alerts %} for all the repositories in your organization.
|
||||
{% ifversion fpt or ghec %}
|
||||

|
||||
{% endif %}{% endif %}{% endif %}{% ifversion ghes or ghae %}
|
||||
{% data variables.product.prodname_dependabot_alerts %} for your organization can be enabled or disabled by your enterprise owner. For more information, see "[About Dependabot for GitHub Enterprise Server](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)."
|
||||
{% endif %}
|
||||
@@ -18,6 +18,7 @@ children:
|
||||
- /browsing-security-vulnerabilities-in-the-github-advisory-database
|
||||
- /editing-security-advisories-in-the-github-advisory-database
|
||||
- /about-dependabot-alerts
|
||||
- /configuring-dependabot-alerts
|
||||
- /viewing-and-updating-dependabot-alerts
|
||||
- /configuring-notifications-for-dependabot-alerts
|
||||
---
|
||||
|
||||
@@ -32,7 +32,7 @@ topics:
|
||||
|
||||
You can enable {% data variables.product.prodname_dependabot_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 %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
|
||||
|
||||
You can disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository or for all repositories owned by your user account or organization. For more information, see "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories](#managing-dependabot-security-updates-for-your-repositories)" below.
|
||||
You can disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository or for all repositories owned by your personal account or organization. For more information, see "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories](#managing-dependabot-security-updates-for-your-repositories)" below.
|
||||
|
||||
{% ifversion fpt or ghec %}{% data reusables.dependabot.dependabot-tos %}{% endif %}
|
||||
|
||||
@@ -60,7 +60,8 @@ If security updates are not enabled for your repository and you don't know why,
|
||||
|
||||
You can enable or disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository (see below).
|
||||
|
||||
You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)."
|
||||
|
||||
You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories owned by your personal account or organization. For more information, see "[Managing security and analysis settings for your personal account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)."
|
||||
|
||||
{% data variables.product.prodname_dependabot_security_updates %} require specific repository settings. For more information, see "[Supported repositories](#supported-repositories)."
|
||||
|
||||
@@ -75,6 +76,7 @@ You can also enable or disable {% data variables.product.prodname_dependabot_sec
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"{% ifversion fpt or ghec %}
|
||||
- "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"
|
||||
- "[Configuring {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts)"{% ifversion fpt or ghec %}
|
||||
- "[Managing data use settings for your private repository](/get-started/privacy-on-github/managing-data-use-settings-for-your-private-repository)"{% endif %}
|
||||
- "[Supported package ecosystems](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)"
|
||||
|
||||
@@ -25,7 +25,7 @@ To give people instructions for reporting security vulnerabilities in your proje
|
||||
|
||||
{% ifversion not ghae %}
|
||||
<!-- no public repos in GHAE -->
|
||||
You can create a default security policy for your organization or user account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)."
|
||||
You can create a default security policy for your organization or personal account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)."
|
||||
{% endif %}
|
||||
|
||||
{% tip %}
|
||||
|
||||
@@ -75,7 +75,7 @@ For more information, see "[Exploring the dependencies of a repository](/code-se
|
||||
{% data reusables.dependabot.dependabot-alerts-beta %}
|
||||
{% data reusables.dependabot.dependabot-alerts-dependency-graph-enterprise %}
|
||||
|
||||
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 %}" and "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account){% endif %}."
|
||||
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 %}" and "[Managing security and analysis settings for your personal account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account){% endif %}."
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
||||
@@ -33,8 +33,7 @@ If your project communicates with an external service, you might use a token or
|
||||
|
||||
1. **{% data variables.product.prodname_secret_scanning_partner_caps %}.** Runs automatically on all public repositories. Any strings that match patterns that were provided by secret scanning partners are reported directly to the relevant partner.
|
||||
|
||||
2. **{% data variables.product.prodname_secret_scanning_GHAS_caps %}.** You can enable and configure additional scanning for repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. Any strings that match patterns provided by secret scanning partners, by other service providers, or defined by your organization, are reported as alerts in the "Security" tab of repositories. If a string in a public repository matches a partner pattern, it is also reported to the partner.
|
||||
{% endif %}
|
||||
2. **{% data variables.product.prodname_secret_scanning_GHAS_caps %}.** {% ifversion fpt %}Organizations using {% data variables.product.prodname_ghe_cloud %} with a license for {% data variables.product.prodname_GH_advanced_security %} can enable and configure additional scanning for repositories owned by the organization.{% elsif ghec %}You can enable and configure additional scanning for repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}.{% endif %} Any strings that match patterns provided by secret scanning partners, by other service providers, or defined by your organization, are reported as alerts in the "Security" tab of repositories. If a string in a public repository matches a partner pattern, it is also reported to the partner.{% endif %}{% ifversion fpt %} For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-advanced-security).{% endif %}
|
||||
|
||||
Service providers can partner with {% data variables.product.company_short %} to provide their secret formats for scanning. {% data reusables.secret-scanning.partner-program-link %}
|
||||
|
||||
|
||||
@@ -23,24 +23,16 @@ redirect_from:
|
||||
|
||||
## About dependency review
|
||||
|
||||
{% data reusables.dependency-review.feature-overview %}
|
||||
{% data reusables.dependency-review.feature-overview %}
|
||||
|
||||
If a pull request targets your repository's default branch and contains changes to package manifests or lock files, you can display a dependency review to see what has changed. The dependency review includes details of changes to indirect dependencies in lock files, and it tells you if any of the added or updated dependencies contain known vulnerabilities.
|
||||
|
||||
{% ifversion fpt %}
|
||||
Dependency review is available in all public repositories in all products and cannot be disabled. Dependency review is available in private repositories owned by organizations that use GitHub Enterprise Cloud and have a license for {% data variables.product.prodname_GH_advanced_security %}. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review).
|
||||
|
||||
{% elsif ghec %}
|
||||
Dependency review is included in {% data variables.product.product_name %} for public repositories. To use dependency review in private repositories owned by organizations, you must have a license for {% data variables.product.prodname_GH_advanced_security %} and have the dependency graph enabled. For more information, see "[Exploring the dependencies of a repository](/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)."
|
||||
|
||||
{% elsif ghes or ghae %}
|
||||
Dependency review is available when dependency graph is enabled for {% data variables.product.product_location %} and {% data variables.product.prodname_advanced_security %} is enabled for the organization or repository.
|
||||
{% endif %}
|
||||
|
||||
Sometimes you might just want to update the version of one dependency in a manifest and generate a pull request. However, if the updated version of this direct dependency also has updated dependencies, your pull request may have more changes than you expected. The dependency review for each manifest and lock file provides an easy way to see what has changed, and whether any of the new dependency versions contain known vulnerabilities.
|
||||
|
||||
By checking the dependency reviews in a pull request, and changing any dependencies that are flagged as vulnerable, you can avoid vulnerabilities being added to your project. For more information about how dependency review works, see "[Reviewing dependency changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)."
|
||||
|
||||
For more information about configuring dependency review, see "[Configuring dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review)."
|
||||
|
||||
{% data variables.product.prodname_dependabot_alerts %} will find vulnerabilities that are already in your dependencies, but it's much better to avoid introducing potential problems than to fix problems at a later date. For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."
|
||||
|
||||
Dependency review supports the same languages and package management ecosystems as the dependency graph. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)."
|
||||
|
||||
@@ -19,12 +19,6 @@ shortTitle: Dependency graph
|
||||
<!--For this article in earlier GHES versions, see /content/github/visualizing-repository-data-with-graphs-->
|
||||
<!--Marketing-LINK: From /features/security and /features/security/software-supply-chain pages "How GitHub's dependency graph is generated".-->
|
||||
|
||||
## Dependency graph availability
|
||||
|
||||
{% ifversion fpt or ghec %}The dependency graph is available for every public repository that defines dependencies in a supported package ecosystem using a supported file format. Repository administrators can also set up the dependency graph for private repositories.{% endif %}
|
||||
|
||||
{% data reusables.dependabot.dependabot-alerts-dependency-graph-enterprise %}
|
||||
|
||||
## About the dependency graph
|
||||
|
||||
{% data reusables.dependabot.about-the-dependency-graph %}
|
||||
@@ -35,6 +29,12 @@ When you push a commit to {% data variables.product.product_name %} that changes
|
||||
When you create a pull request containing changes to dependencies that targets the default branch, {% data variables.product.prodname_dotcom %} uses the dependency graph to add dependency reviews to the pull request. These indicate whether the dependencies contain vulnerabilities and, if so, the version of the dependency in which the vulnerability was fixed. For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)."
|
||||
{% endif %}
|
||||
|
||||
## Dependency graph availability
|
||||
|
||||
{% ifversion fpt or ghec %}The dependency graph is available for every public repository that defines dependencies in a supported package ecosystem using a supported file format. Repository administrators can also set up the dependency graph for private repositories. For more information, see "[Configuring the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph)."{% endif %}
|
||||
|
||||
{% data reusables.dependabot.dependabot-alerts-dependency-graph-enterprise %}
|
||||
|
||||
## Dependencies included
|
||||
|
||||
The dependency graph includes all the dependencies of a repository that are detailed in the manifest and lock files, or their equivalent, for supported ecosystems. This includes:
|
||||
@@ -45,6 +45,7 @@ The dependency graph includes all the dependencies of a repository that are deta
|
||||
The dependency graph identifies indirect dependencies{% ifversion fpt or ghec %} either explicitly from a lock file or by checking the dependencies of your direct dependencies. For the most reliable graph, you should use lock files (or their equivalent) because they define exactly which versions of the direct and indirect dependencies you currently use. If you use lock files, you also ensure that all contributors to the repository are using the same versions, which will make it easier for you to test and debug code{% else %} from the lock files{% endif %}.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
## Dependents included
|
||||
|
||||
For public repositories, only public repositories that depend on it or on packages that it publishes are reported. This information is not reported for private repositories.{% endif %}
|
||||
@@ -58,14 +59,6 @@ You can use the dependency graph to:
|
||||
- View and update vulnerable dependencies for your repository. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."{% ifversion fpt or ghes > 3.1 or ghec %}
|
||||
- See information about vulnerable dependencies in pull requests. For more information, see "[Reviewing dependency changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)."{% endif %}
|
||||
|
||||
## Enabling the dependency graph
|
||||
|
||||
{% ifversion fpt or ghec %}To generate a dependency graph, {% data variables.product.product_name %} needs read-only access to the dependency manifest and lock files for a repository. The dependency graph is automatically generated for all public repositories and you can choose to enable it for private repositories. For information about enabling or disabling it for private repositories, see "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)."{% endif %}
|
||||
|
||||
{% ifversion ghes %}If the dependency graph is not available in your system, your enterprise owner can enable the dependency graph. For more information, see "[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 %}
|
||||
|
||||
{% ifversion fpt or ghec or ghes %}When the dependency graph is first enabled, {% endif %}{% data variables.product.product_name %} immediately parses manifest and lock files for supported ecosystems. The graph is usually populated within minutes but this may take longer for repositories with many dependencies. Once enabled, the graph is automatically updated with every push to the repository{% ifversion fpt or ghec %} and every push to other repositories in the graph{% endif %}.
|
||||
|
||||
## Supported package ecosystems
|
||||
|
||||
The recommended formats explicitly define which versions are used for all direct and all indirect dependencies. If you use these formats, your dependency graph is more accurate. It also reflects the current build set up and enables the dependency graph to report vulnerabilities in both direct and indirect dependencies.{% ifversion fpt or ghec %} Indirect dependencies that are inferred from a manifest file (or equivalent) are excluded from the checks for vulnerable dependencies.{% endif %}
|
||||
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: Configuring dependency review
|
||||
intro: 'You can use dependency review to catch vulnerabilities before they are added to your project.'
|
||||
shortTitle: Configure dependency review
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '>= 3.2'
|
||||
ghae: issue-4864
|
||||
ghec: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Advanced Security
|
||||
- Dependency review
|
||||
- Vulnerabilities
|
||||
- Dependencies
|
||||
- Pull requests
|
||||
---
|
||||
|
||||
{% data reusables.dependency-review.beta %}
|
||||
|
||||
## About dependency review
|
||||
|
||||
{% data reusables.dependency-review.feature-overview %}
|
||||
|
||||
For more information, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)" and "[Reviewing dependency changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)."
|
||||
|
||||
## About configuring dependency review
|
||||
|
||||
{% ifversion fpt %}
|
||||
Dependency review is available in all public repositories in all products and cannot be disabled. Dependency review is available in private repositories owned by organizations that use GitHub Enterprise Cloud and have a license for [{% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security). For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review).
|
||||
|
||||
{% elsif ghec %}
|
||||
Dependency review is included in {% data variables.product.product_name %} for public repositories. To use dependency review in private repositories owned by organizations, you must have a license for [{% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security) and have the dependency graph enabled.
|
||||
|
||||
{% data reusables.dependabot.enabling-disabling-dependency-graph-private-repo %}
|
||||
1. If "{% data variables.product.prodname_GH_advanced_security %}" is not enabled, click **Enable** next to the feature.
|
||||

|
||||
|
||||
{% elsif ghes or ghae %}
|
||||
Dependency review is available when dependency graph is enabled for {% data variables.product.product_location %} and {% data variables.product.prodname_advanced_security %} is enabled for the organization or repository. For more information, see "[Enabling {% data variables.product.prodname_GH_advanced_security %} for your enterprise](/admin/code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise)."
|
||||
|
||||
### Checking if the dependency graph is enabled
|
||||
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.repositories.navigate-to-code-security-and-analysis %}
|
||||
1. Under "Configure security and analysis features", check if the dependency graph is enabled.
|
||||
1. If dependency graph is enabled, click **Enable** next to "{% data variables.product.prodname_GH_advanced_security %}" to enable {% data variables.product.prodname_advanced_security %}, including dependency review. The enable button is disabled if your enterprise has no available licenses for {% data variables.product.prodname_advanced_security %}.{% ifversion ghes < 3.3 %}
|
||||
{% endif %}{% ifversion ghes > 3.2 %}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
title: Configuring the dependency graph
|
||||
intro: You can allow users to identify their projects' dependencies by enabling the dependency graph.
|
||||
redirect_from:
|
||||
- /code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph#enabling-the-dependency-graph
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: issue-4864
|
||||
ghec: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Dependency graph
|
||||
- Dependencies
|
||||
- Repositories
|
||||
shortTitle: Configure dependency graph
|
||||
---
|
||||
## About the dependency graph
|
||||
|
||||
{% data reusables.dependabot.about-the-dependency-graph %}
|
||||
|
||||
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 %} ## About configuring the dependency graph {% endif %}
|
||||
{% ifversion fpt or ghec %}To generate a dependency graph, {% data variables.product.product_name %} needs read-only access to the dependency manifest and lock files for a repository. The dependency graph is automatically generated for all public repositories and you can choose to enable it for private repositories. For more information on viewing the dependency graph, see "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)."{% endif %}
|
||||
|
||||
{% ifversion ghes or ghae %} ## Enabling the dependency graph
|
||||
{% data reusables.dependabot.ghes-ghae-enabling-dependency-graph %}{% endif %}{% ifversion fpt or ghec %}
|
||||
|
||||
### Enabling and disabling the dependency graph for a private repository
|
||||
|
||||
{% data reusables.dependabot.enabling-disabling-dependency-graph-private-repo %}
|
||||
{% endif %}
|
||||
|
||||
When the dependency graph is first enabled, any manifest and lock files for supported ecosystems are parsed immediately. The graph is usually populated within minutes but this may take longer for repositories with many dependencies. Once enabled, the graph is automatically updated with every push to the repository{% ifversion fpt or ghec %} and every push to other repositories in the graph{% endif %}.
|
||||
|
||||
## Further reading
|
||||
|
||||
{% ifversion fpt or ghec %}- "[Viewing insights for your organization](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization)"{% endif %}
|
||||
- "[Viewing {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)"
|
||||
- "[Troubleshooting the detection of vulnerable dependencies](/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies)"
|
||||
@@ -70,17 +70,7 @@ For public repositories, the dependents view shows how the repository is used by
|
||||
|
||||
## Enabling and disabling the dependency graph for a private repository
|
||||
|
||||
Repository administrators can enable or disable the dependency graph for private repositories.
|
||||
|
||||
You can also enable or disable the dependency graph for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)."
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.repositories.navigate-to-code-security-and-analysis %}
|
||||
4. Read the message about granting {% data variables.product.product_name %} read-only access to the repository data to enable the dependency graph, then next to "Dependency Graph", click **Enable**.
|
||||

|
||||
|
||||
You can disable the dependency graph at any time by clicking **Disable** next to "Dependency Graph" on the Security & analysis tab.
|
||||
{% data reusables.dependabot.enabling-disabling-dependency-graph-private-repo %}
|
||||
|
||||
## Changing the "Used by" package
|
||||
|
||||
|
||||
@@ -13,7 +13,9 @@ shortTitle: Understand your supply chain
|
||||
children:
|
||||
- /about-supply-chain-security
|
||||
- /about-the-dependency-graph
|
||||
- /configuring-the-dependency-graph
|
||||
- /about-dependency-review
|
||||
- /configuring-dependency-review
|
||||
- /exploring-the-dependencies-of-a-repository
|
||||
- /troubleshooting-the-dependency-graph
|
||||
---
|
||||
|
||||
@@ -99,7 +99,9 @@ There are some additional good practices and risks that you should be aware of w
|
||||
|
||||
#### Understanding a repository's devcontainer.json file
|
||||
|
||||
When creating a codespace, the [devcontainer.json](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) is parsed and applied from the source repo, if one exists. The devcontainer contains powerful features, such as installing third-party extensions and running arbitrary code through a supplied `postCreateCommand`.
|
||||
When you create a codespace, if a `devcontainer.json` file is found for your repository, it is parsed and used to configure your codespace. The `devcontainer.json` file can contain powerful features, such as installing third-party extensions and running arbitrary code supplied in a `postCreateCommand`.
|
||||
|
||||
For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers)."
|
||||
|
||||
#### Granting access through features
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ This article explains how billing works for your codespaces, and explains how yo
|
||||
|
||||
## Getting access to {% data variables.product.prodname_codespaces %}
|
||||
|
||||
Your organization's administrator might limit {% data variables.product.prodname_codespaces %} usage to only specific user accounts. To get access, you will need to contact your billing manager. For more information, see "[Managing access and security for your codespaces](/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces)."
|
||||
Your organization's administrator might limit {% data variables.product.prodname_codespaces %} usage to only specific personal accounts. To get access, you will need to contact your billing manager. For more information, see "[Managing access and security for your codespaces](/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces)."
|
||||
|
||||
## How much it costs to use {% data variables.product.prodname_codespaces %}
|
||||
|
||||
|
||||