Merge branch 'main' into patch-1
This commit is contained in:
Laura Coursen
@@ -33,14 +33,14 @@ If you've enabled security updates, you'll sometimes see extra pull requests for
|
||||
|
||||
### Supported repositories and ecosystems
|
||||
|
||||
You can configure version updates for repositories that contain a dependency manifest or lock file for one of the supported package managers. For some package managers, you can also configure vendoring for dependencies. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#vendor)."
|
||||
|
||||
{% note %}
|
||||
|
||||
{% data reusables.dependabot.private-dependencies %}
|
||||
{% data reusables.dependabot.private-dependencies-note %} Additionally, {% data variables.product.prodname_dependabot %} doesn't support private {% data variables.product.prodname_dotcom %} dependencies for all package managers. See the details in the table below.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
You can configure version updates for repositories that contain a dependency manifest or lock file for one of the supported package managers. For some package managers, you can also configure vendoring for dependencies. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#vendor)."
|
||||
|
||||
{% data reusables.dependabot.supported-package-managers %}
|
||||
|
||||
If your repository already uses an integration for dependency management, you will need to disable this before enabling {% data variables.product.prodname_dependabot %}. For more information, see "[About integrations](/github/customizing-your-github-workflow/about-integrations)."
|
||||
|
||||
@@ -35,7 +35,7 @@ If a release fixes a security vulnerability, you should publish a security advis
|
||||
You can view the **Dependents** tab of the dependency graph to see which repositories and packages depend on code in your repository, and may therefore be affected by a new release. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."
|
||||
{% endif %}
|
||||
|
||||
You can also use the Releases API to gather information, such as the number of times people download a release asset. For more information, see "[Releases](/v3/repos/releases/)."
|
||||
You can also use the Releases API to gather information, such as the number of times people download a release asset. For more information, see "[Releases](/rest/reference/repos#releases)."
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
### Storage and bandwidth quotas
|
||||
|
||||
@@ -36,7 +36,7 @@ You can set up either loose or strict status checks, depending on whether you wa
|
||||
|
||||
### Troubleshooting required status checks
|
||||
|
||||
If you have a check and a status with the same name and you select that name as a required status check, both the check and the status are required. For more information, see "[Checks](/v3/checks/)."
|
||||
If you have a check and a status with the same name and you select that name as a required status check, both the check and the status are required. For more information, see "[Checks](/rest/reference/checks)."
|
||||
|
||||
Once you've set up required status checks, your branch must be up to date with the base branch before merging. This ensures that your branch has been tested with the latest code from the base branch. If your branch is out of date, you'll need to merge the base branch into your branch.
|
||||
|
||||
@@ -62,7 +62,7 @@ remote: error: Required status check "ci-build" is failing
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
|
||||
|
||||
Sometimes, the results of the status checks for the test merge commit and head commit will conflict. If the test merge commit has a status, it must pass. Otherwise, the status of the head commit must pass before you can merge the branch. For more information about test merge commits, see "[Pull Requests](/v3/pulls/#response-1)."
|
||||
Sometimes, the results of the status checks for the test merge commit and head commit will conflict. If the test merge commit has a status, it must pass. Otherwise, the status of the head commit must pass before you can merge the branch. For more information about test merge commits, see "[Pull Requests](/rest/reference/pulls#response-1)."
|
||||
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: About secret scanning
|
||||
intro: '{% data variables.product.product_name %} scans repositories for known types of secrets, to prevent fraudulent use of secrets that were committed accidentally.'
|
||||
product: '{% data reusables.gated-features.secret-scanning %}'
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/about-token-scanning
|
||||
- /articles/about-token-scanning
|
||||
@@ -17,7 +18,9 @@ Service providers can partner with {% data variables.product.company_short %} to
|
||||
|
||||
### About {% data variables.product.prodname_secret_scanning %} for public repositories
|
||||
|
||||
When you push to a public repository, {% data variables.product.product_name %} scans the content of the commits for secrets. If you switch a private repository to public, {% data variables.product.product_name %} scans the entire repository for secrets.
|
||||
{% data variables.product.prodname_secret_scanning_caps %} is automatically enabled on public repositories, where it scans code for secrets, to check for known secret formats. When a match of your secret format is found in a public repository, {% data variables.product.company_short %} doesn't publicly disclose the information as an alert, but instead sends a payload to an HTTP endpoint of your choice. For an overview of how secret scanning works on public repositories, see "[Secret scanning](/developers/overview/secret-scanning)."
|
||||
|
||||
When you push to a public repository, {% data variables.product.product_name %} scans the content of the commits for secrets. If you switch a private repository to public, {% data variables.product.product_name %} scans the entire repository for secrets.
|
||||
|
||||
When {% data variables.product.prodname_secret_scanning %} detects a set of credentials, we notify the service provider who issued the secret. The service provider validates the credential and then decides whether they should revoke the secret, issue a new secret, or reach out to you directly, which will depend on the associated risks to you or the service provider.
|
||||
|
||||
@@ -33,6 +36,7 @@ When {% data variables.product.prodname_secret_scanning %} detects a set of cred
|
||||
- Databricks
|
||||
- Datadog
|
||||
- Discord
|
||||
- Doppler
|
||||
- Dropbox
|
||||
- Dynatrace
|
||||
- Finicity
|
||||
@@ -64,6 +68,8 @@ When {% data variables.product.prodname_secret_scanning %} detects a set of cred
|
||||
|
||||
{% data reusables.secret-scanning.beta %}
|
||||
|
||||
If you're a repository administrator or an organization owner, you can enable {% data variables.product.prodname_secret_scanning %} for private repositories that are owned by organizations. You can enable {% data variables.product.prodname_secret_scanning %} for all your repositories, or for all new repositories within your organization. {% data variables.product.prodname_secret_scanning_caps %} is not available for user account-owned private 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)" and "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)."
|
||||
|
||||
When you push commits to a private repository with {% data variables.product.prodname_secret_scanning %} enabled, {% data variables.product.product_name %} scans the contents of the commits for secrets.
|
||||
|
||||
When {% data variables.product.prodname_secret_scanning %} detects a secret in a private repository, {% data variables.product.prodname_dotcom %} sends alerts.
|
||||
@@ -72,6 +78,8 @@ When {% data variables.product.prodname_secret_scanning %} detects a secret in a
|
||||
|
||||
- {% data variables.product.prodname_dotcom %} displays an alert in the repository. For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."
|
||||
|
||||
Repository administrators and organization owners can grant users and team access to {% data variables.product.prodname_secret_scanning %} alerts. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."
|
||||
|
||||
{% data variables.product.product_name %} currently scans private repositories for secrets issued by the following service providers.
|
||||
|
||||
- Adafruit
|
||||
@@ -83,6 +91,7 @@ When {% data variables.product.prodname_secret_scanning %} detects a secret in a
|
||||
- CloudBees CodeShip
|
||||
- Databricks
|
||||
- Discord
|
||||
- Doppler
|
||||
- Dropbox
|
||||
- Dynatrace
|
||||
- Finicity
|
||||
|
||||
@@ -22,7 +22,7 @@ To browse the most used topics, go to https://github.com/topics/.
|
||||
|
||||
Repository admins can add any topics they'd like to a repository. Helpful topics to classify a repository include the repository's intended purpose, subject area, community, or language.{% if currentVersion == "free-pro-team@latest" %} Additionally, {% data variables.product.product_name %} analyzes public repository content and generates suggested topics that repository admins can accept or reject. Private repository content is not analyzed and does not receive topic suggestions.{% endif %}
|
||||
|
||||
Public and private repositories can have topics, although you will only see private repositories that you have access to in topic search results.
|
||||
{% if currentVersion == "github-ae@latest" %}Internal {% else %}Public, internal, {% endif %}and private repositories can have topics, although you will only see private repositories that you have access to in topic search results.
|
||||
|
||||
You can search for repositories that are associated with a particular topic. For more information, see "[Searching for repositories](/articles/searching-for-repositories#search-by-topic)." You can also search for a list of topics on {% data variables.product.product_name %}. For more information, see "[Searching topics](/articles/searching-topics)."
|
||||
|
||||
|
||||
@@ -302,13 +302,14 @@ updates:
|
||||
- dependency-name: "express"
|
||||
# For Express, ignore all updates for version 4 and 5
|
||||
versions: ["4.x", "5.x"]
|
||||
# For Loadash, ignore all updates
|
||||
- dependency-name: "loadash"
|
||||
# For Lodash, ignore all updates
|
||||
- dependency-name: "lodash"
|
||||
```
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: {% data variables.product.prodname_dependabot_version_updates %} can't run version updates for any dependencies in manifests containing private git dependencies or private git registries, even if you add the private dependencies to the `ignore` option of your configuration file. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot#supported-repositories-and-ecosystems)."
|
||||
**Note**: {% data variables.product.prodname_dependabot %} can only run version updates on manifest or lock files if it can access all of the dependencies in the file, even if you add inaccessible dependencies to the `ignore` option of your configuration file. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-repositories)" and "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors#dependabot-cant-resolve-your-dependency-files)."
|
||||
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Configuring secret scanning for private repositories
|
||||
intro: 'You can configure how {% data variables.product.product_name %} scans your private repositories for secrets.'
|
||||
product: '{% data reusables.gated-features.secret-scanning %}'
|
||||
permissions: 'People with admin permissions to a private repository can enable {% data variables.product.prodname_secret_scanning %} for the repository.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
|
||||
@@ -11,7 +11,7 @@ versions:
|
||||
|
||||
Until you add an image, repository links expand to show basic information about the repository and the owner's avatar. Adding an image to your repository can help identify your project across various social platforms.
|
||||
|
||||
You can upload an image to a private repository, but your image can only be shared from a public repository.
|
||||
{% if currentVersion != "github-ae@latest" %}You can upload an image to a private repository, but your image can only be shared from a public repository.{% endif %}
|
||||
|
||||
{% tip %}
|
||||
Tip: Your image should be a PNG, JPG, or GIF file under 1 MB in size. For the best quality rendering, we recommend keeping the image at 640 by 320 pixels.
|
||||
|
||||
@@ -13,17 +13,16 @@ versions:
|
||||
|
||||
{% data reusables.organizations.owners-and-admins-can %} delete an organization repository. If **Allow members to delete or transfer repositories for this organization** has been disabled, only organization owners can delete organization repositories. {% data reusables.organizations.new-repo-permissions-more-info %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
{% if currentVersion != "github-ae@latest" %}Deleting a public repository will not delete any forks of the repository.{% endif %}
|
||||
|
||||
{% warning %}
|
||||
|
||||
**Warning**: Deleting a repository will **permanently** delete release attachments and team permissions. This action **cannot** be undone.
|
||||
**Warnings**:
|
||||
|
||||
- Deleting a repository will **permanently** delete release attachments and team permissions. This action **cannot** be undone.
|
||||
- Deleting a private {% if currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %}or internal {% endif %}repository will delete all forks of the repository.
|
||||
|
||||
{% endwarning %}
|
||||
{% endif %}
|
||||
|
||||
Please also keep in mind that:
|
||||
- Deleting a private repository will delete all of its forks.
|
||||
- Deleting a public repository will not delete its forks.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
You can restore some deleted repositories within 90 days. For more information, see "[Restoring a deleted repository](/articles/restoring-a-deleted-repository)."
|
||||
|
||||
@@ -14,14 +14,10 @@ You enable {% data variables.product.prodname_dependabot_version_updates %} by c
|
||||
|
||||
{% data reusables.dependabot.initial-updates %} For more information, see "[Customizing dependency updates](/github/administering-a-repository/customizing-dependency-updates)."
|
||||
|
||||
{% data reusables.dependabot.private-dependencies-note %} Additionally, {% data variables.product.prodname_dependabot %} doesn't support private {% data variables.product.prodname_dotcom %} dependencies for all package managers. For more information, see "[About Dependabot version updates](/github/administering-a-repository/about-dependabot-version-updates#supported-repositories-and-ecosystems)."
|
||||
|
||||
### Enabling {% data variables.product.prodname_dependabot_version_updates %}
|
||||
|
||||
{% note %}
|
||||
|
||||
{% data reusables.dependabot.private-dependencies %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% data reusables.dependabot.create-dependabot-yml %}
|
||||
1. Use `package-ecosystem` to specify the package managers to monitor.
|
||||
1. For each package manager, use:
|
||||
|
||||
@@ -5,7 +5,6 @@ redirect_from:
|
||||
- /articles/enabling-anonymous-git-read-access-for-a-repository
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
Repository administrators can change the anonymous Git read access setting for a specific repository if:
|
||||
|
||||
@@ -12,36 +12,24 @@ versions:
|
||||
### Table of Contents
|
||||
|
||||
{% topic_link_in_list /managing-repository-settings %}
|
||||
{% link_in_list /setting-repository-visibility %}{% if currentVersion == "free-pro-team@latest" %}
|
||||
{% link_in_list /managing-teams-and-people-with-access-to-your-repository %}{% endif %}
|
||||
{% link_in_list /setting-repository-visibility %}
|
||||
{% link_in_list /managing-teams-and-people-with-access-to-your-repository %}
|
||||
{% link_in_list /classifying-your-repository-with-topics %}
|
||||
{% link_in_list /customizing-how-changed-files-appear-on-github %}
|
||||
{% link_in_list /about-email-notifications-for-pushes-to-your-repository %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /displaying-a-sponsor-button-in-your-repository %}
|
||||
<!-- endif -->
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.17" -->
|
||||
{% link_in_list /customizing-your-repositorys-social-media-preview %}
|
||||
<!-- endif -->
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /viewing-deployment-activity-for-your-repository %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /managing-the-forking-policy-for-your-repository %}
|
||||
<!-- if enterpriseServerVersions contains currentVersion -->
|
||||
{% link_in_list /configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository %}
|
||||
{% link_in_list /disabling-or-limiting-github-actions-for-a-repository %}
|
||||
{% link_in_list /managing-git-lfs-objects-in-archives-of-your-repository %}
|
||||
{% link_in_list /enabling-anonymous-git-read-access-for-a-repository %}
|
||||
<!-- endif -->
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.18" -->
|
||||
{% link_in_list /configuring-autolinks-to-reference-external-resources %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /renaming-a-repository %}
|
||||
{% link_in_list /transferring-a-repository %}
|
||||
{% link_in_list /deleting-a-repository %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /restoring-a-deleted-repository %}
|
||||
<!-- endif -->
|
||||
{% topic_link_in_list /managing-branches-in-your-repository %}
|
||||
{% link_in_list /viewing-branches-in-your-repository %}
|
||||
{% link_in_list /changing-the-default-branch %}
|
||||
@@ -50,9 +38,7 @@ versions:
|
||||
{% link_in_list /about-merge-methods-on-github %}
|
||||
{% link_in_list /configuring-commit-squashing-for-pull-requests %}
|
||||
{% link_in_list /configuring-commit-rebasing-for-pull-requests %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.18" -->
|
||||
{% link_in_list /managing-the-automatic-deletion-of-branches %}
|
||||
<!-- endif -->
|
||||
{% topic_link_in_list /defining-the-mergeability-of-pull-requests %}
|
||||
{% link_in_list /about-protected-branches %}
|
||||
{% link_in_list /configuring-protected-branches %}
|
||||
@@ -65,31 +51,22 @@ versions:
|
||||
{% link_in_list /enabling-required-reviews-for-pull-requests %}
|
||||
{% link_in_list /about-required-commit-signing %}
|
||||
{% link_in_list /enabling-required-commit-signing %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" -->
|
||||
{% link_in_list /requiring-a-linear-commit-history %}
|
||||
{% link_in_list /enabling-force-pushes-to-a-protected-branch %}
|
||||
{% link_in_list /enabling-deletion-of-a-protected-branch %}
|
||||
<!-- endif -->
|
||||
{% topic_link_in_list /releasing-projects-on-github %}
|
||||
{% link_in_list /about-releases %}
|
||||
{% link_in_list /managing-releases-in-a-repository %}
|
||||
{% link_in_list /viewing-your-repositorys-releases-and-tags %}
|
||||
{% link_in_list /linking-to-releases %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" -->
|
||||
{% link_in_list /comparing-releases %}
|
||||
<!-- endif -->
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.15" -->
|
||||
{% link_in_list /automation-for-release-forms-with-query-parameters %}
|
||||
<!-- endif -->
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% topic_link_in_list /securing-your-repository %}
|
||||
{% link_in_list /about-securing-your-repository %}
|
||||
{% link_in_list /about-secret-scanning %}
|
||||
{% link_in_list /configuring-secret-scanning-for-private-repositories %}
|
||||
{% link_in_list /managing-alerts-from-secret-scanning %}
|
||||
{% link_in_list /managing-security-and-analysis-settings-for-your-repository %}
|
||||
<!-- endif -->
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% topic_link_in_list /keeping-your-dependencies-updated-automatically %}
|
||||
{% link_in_list /about-dependabot-version-updates %}
|
||||
{% link_in_list /enabling-and-disabling-version-updates %}
|
||||
@@ -98,4 +75,3 @@ versions:
|
||||
{% link_in_list /customizing-dependency-updates %}
|
||||
{% link_in_list /configuration-options-for-dependency-updates %}
|
||||
{% link_in_list /keeping-your-actions-up-to-date-with-dependabot %}
|
||||
<!-- endif -->
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Managing alerts from secret scanning
|
||||
intro: You can view and close alerts for secrets checked in to your repository.
|
||||
product: '{% data reusables.gated-features.secret-scanning %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
@@ -15,11 +15,14 @@ versions:
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion ver_gt "github-ae@latest" %}
|
||||
|
||||
### About release management
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
You can also publish an action from a specific release in {% data variables.product.prodname_marketplace %}. For more information, see "<a href="/actions/creating-actions/publishing-actions-in-github-marketplace" class="dotcom-only">Publishing an action in the {% data variables.product.prodname_marketplace %}</a>."
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
|
||||
You can choose whether {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}) objects are included in the ZIP files and tarballs that {% data variables.product.product_name %} creates for each release. For more information, see "[Managing {% data variables.large_files.product_name_short %} objects in archives of your repository](/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository)."
|
||||
{% endif %}
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Managing repository settings
|
||||
intro: 'Repository administrators and organization owners can change several settings, including the names and ownership of a repository and the public or private visibility of a repository. They can also delete a repository.'
|
||||
intro: 'Repository administrators and organization owners can change settings for a repository, like the name, ownership, and visibility, or delete the repository.'
|
||||
mapTopic: true
|
||||
redirect_from:
|
||||
- /articles/managing-repository-settings
|
||||
|
||||
@@ -23,31 +23,31 @@ versions:
|
||||
4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**.
|
||||
|
||||
|
||||
### Granting access to {% data variables.product.prodname_dependabot_alerts %}
|
||||
### Granting access to security alerts
|
||||
|
||||
After you enable {% data variables.product.prodname_dependabot_alerts %} for a repository in an organization, organization owners and repository administrators can view the alerts by default. You can give additional teams and people access to the alerts for a repository.
|
||||
After you enable {% data variables.product.prodname_dependabot %} or {% data variables.product.prodname_secret_scanning %} alerts for a repository in an organization, organization owners and repository administrators can view the alerts by default. You can give additional teams and people access to the alerts for a repository.
|
||||
|
||||
{% note %}
|
||||
|
||||
Organization owners and repository administrators can only grant access to view {% data variables.product.prodname_dependabot_alerts %} to people or teams who have write access to the repo.
|
||||
Organization owners and repository administrators can only grant access to view security alerts, such as {% data variables.product.prodname_dependabot %} and {% data variables.product.prodname_secret_scanning %} alerts, to people or teams who have write access to the repo.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.repositories.navigate-to-security-and-analysis %}
|
||||
4. Under "Dependabot alerts", in the search field, start typing the name of the person or team you'd like to find, then click a name in the list of matches.
|
||||
|
||||
4. Under "Access to alerts", in the search field, start typing the name of the person or team you'd like to find, then click a name in the list of matches.
|
||||
|
||||
5. Click **Save changes**.
|
||||
|
||||
|
||||
|
||||
### Removing access to {% data variables.product.prodname_dependabot_alerts %}
|
||||
### Removing access to security alerts
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.repositories.navigate-to-security-and-analysis %}
|
||||
4. Under "Dependabot alerts", to the right of the person or team whose access you'd like to remove, click {% octicon "x" aria-label="X symbol" %}.
|
||||
|
||||
4. Under "Access to alerts", to the right of the person or team whose access you'd like to remove, click {% octicon "x" aria-label="X symbol" %}.
|
||||
|
||||
|
||||
### Further reading
|
||||
|
||||
|
||||
@@ -19,17 +19,36 @@ Organization owners can restrict the ability to change repository visibility to
|
||||
We recommend reviewing the following caveats before you change the visibility of a repository.
|
||||
|
||||
#### Making a repository private
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
* {% data variables.product.product_name %} will detach public forks of the public repository and put them into a new network. Public forks are not made private.{% endif %}
|
||||
* If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository. {% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}The visibility of any forks will also change to private.{% elsif currentVersion == "github-ae@latest" %}If the internal repository has any forks, the visibility of the forks is already private.{% endif %} For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)"{% if currentVersion == "free-pro-team@latest" %}
|
||||
* If you're using {% data variables.product.prodname_free_user %} for user accounts or organizations, some features won't be available in the repository after you change the visibility to private. {% data reusables.gated-features.more-info %}{% endif %}
|
||||
* Any published {% data variables.product.prodname_pages %} site will be automatically unpublished.{% if currentVersion == "free-pro-team@latest" %} If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, 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)."{% endif %}{% if currentVersion == "free-pro-team@latest" %}
|
||||
* {% data variables.product.prodname_dotcom %} will no longer included the repository in the {% data variables.product.prodname_archive %}. For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)."{% endif %}{% if enterpriseServerVersions contains currentVersion %}
|
||||
* Anonymous Git read access is no longer available. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)."{% endif %}
|
||||
|
||||
* {% data variables.product.prodname_dotcom %} will detach public forks of the public repository and put them into a new network. Public forks are not made private. {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository.{% endif %} For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-public-repository-to-a-private-repository)"
|
||||
{% if currentVersion == "free-pro-team@latest" %}* If you're using {% data variables.product.prodname_free_user %} for user accounts or organizations, some features won't be available in the repository after you change the visibility to private. {% data reusables.gated-features.more-info %}
|
||||
* Any published {% data variables.product.prodname_pages %} site will be automatically unpublished. If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, 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)."
|
||||
* {% data variables.product.prodname_dotcom %} will no longer included the repository in the {% data variables.product.prodname_archive %}. For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)."{% endif %}
|
||||
{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}* Anonymous Git read access is no longer available. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)."{% endif %}
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
|
||||
|
||||
#### Making a repository internal
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** {% data reusables.gated-features.internal-repos %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
* Any forks of the repository will remain in the repository network, and {% data variables.product.product_name %} maintains the relationship between the root repository and the fork. For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)"
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
#### Making a repository public
|
||||
|
||||
* {% data variables.product.prodname_dotcom %} will detach private forks and turn them into a standalone private repository. For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-private-repository-to-a-public-repository)"
|
||||
* If you're converting your private repository to a public repository as part of a move toward creating an open source project, see the [Open Source Guides](http://opensource.guide) for helpful tips and guidelines.{% if currentVersion == "free-pro-team@latest" %} You can also take a free course on managing an open source project with [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). Once your repository is public, you can also view your repository's community profile to see whether your project meets best practices for supporting contributors. For more information, see "[Viewing your community profile](/articles/viewing-your-community-profile)."{% endif %}
|
||||
* {% data variables.product.product_name %} will detach private forks and turn them into a standalone private repository. For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-private-repository-to-a-public-repository)"{% if currentVersion == "free-pro-team@latest" %}
|
||||
* If you're converting your private repository to a public repository as part of a move toward creating an open source project, see the [Open Source Guides](http://opensource.guide) for helpful tips and guidelines. You can also take a free course on managing an open source project with [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). Once your repository is public, you can also view your repository's community profile to see whether your project meets best practices for supporting contributors. For more information, see "[Viewing your community profile](/articles/viewing-your-community-profile)."{% endif %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
To host your images, {% data variables.product.product_name %} uses the [open-source project Camo](https://github.com/atmos/camo). Camo generates an anonymous URL proxy for each image that starts with ```https://camo.githubusercontent.com/``` and hides your browser details and related information from other users.
|
||||
To host your images, {% data variables.product.product_name %} uses the [open-source project Camo](https://github.com/atmos/camo). Camo generates an anonymous URL proxy for each image which hides your browser details and related information from other users. The URL starts `https://<subdomain>.githubusercontent.com/`, with different subdomains depending on how you uploaded the image.
|
||||
|
||||
Anyone who receives your anonymized image URL, directly or indirectly, may view your image. To keep sensitive images private, restrict them to a private network or a server that requires authentication instead of using Camo.
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ redirect_from:
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
You can retrieve a list of {% data variables.product.prodname_dotcom %}'s IP addresses from the [meta](https://api.github.com/meta) API endpoint. For more information, see "[Meta](/v3/meta/)."
|
||||
You can retrieve a list of {% data variables.product.prodname_dotcom %}'s IP addresses from the [meta](https://api.github.com/meta) API endpoint. For more information, see "[Meta](/rest/reference/meta)."
|
||||
|
||||
These ranges are in [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation). You can use an online conversion tool such as this [CIDR / VLSM Supernet Calculator](http://www.subnet-calculator.com/cidr.php) to convert from CIDR notation to IP address ranges.
|
||||
|
||||
|
||||
@@ -19,13 +19,13 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc
|
||||
|
||||
{% mac %}
|
||||
|
||||
1. Copy the SSH key to your clipboard.
|
||||
1. Copy the SSH public key to your clipboard.
|
||||
|
||||
If your SSH key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace.
|
||||
If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace.
|
||||
|
||||
```shell
|
||||
$ pbcopy < ~/.ssh/id_rsa.pub
|
||||
# Copies the contents of the id_rsa.pub file to your clipboard
|
||||
$ pbcopy < ~/.ssh/id_ed25519.pub
|
||||
# Copies the contents of the id_ed25519.pub file to your clipboard
|
||||
```
|
||||
|
||||
{% tip %}
|
||||
@@ -49,13 +49,13 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc
|
||||
|
||||
{% windows %}
|
||||
|
||||
1. Copy the SSH key to your clipboard.
|
||||
1. Copy the SSH public key to your clipboard.
|
||||
|
||||
If your SSH key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace.
|
||||
If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace.
|
||||
|
||||
```shell
|
||||
$ clip < ~/.ssh/id_rsa.pub
|
||||
# Copies the contents of the id_rsa.pub file to your clipboard
|
||||
$ clip < ~/.ssh/id_ed25519.pub
|
||||
# Copies the contents of the id_ed25519.pub file to your clipboard
|
||||
```
|
||||
|
||||
{% tip %}
|
||||
@@ -80,16 +80,16 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc
|
||||
|
||||
{% linux %}
|
||||
|
||||
1. Copy the SSH key to your clipboard.
|
||||
1. Copy the SSH public key to your clipboard.
|
||||
|
||||
If your SSH key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace.
|
||||
If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace.
|
||||
|
||||
```shell
|
||||
$ sudo apt-get install xclip
|
||||
# Downloads and installs xclip. If you don't have `apt-get`, you might need to use another installer (like `yum`)
|
||||
|
||||
$ xclip -selection clipboard < ~/.ssh/id_rsa.pub
|
||||
# Copies the contents of the id_rsa.pub file to your clipboard
|
||||
$ xclip -selection clipboard < ~/.ssh/id_ed25519.pub
|
||||
# Copies the contents of the id_ed25519.pub file to your clipboard
|
||||
```
|
||||
{% tip %}
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ versions:
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
Personal access tokens (PATs) are an alternative to using passwords for authentication to {% data variables.product.product_name %} when using the [GitHub API](/v3/auth/#via-oauth-and-personal-access-tokens) or the [command line](#using-a-token-on-the-command-line).
|
||||
Personal access tokens (PATs) are an alternative to using passwords for authentication to {% data variables.product.product_name %} when using the [GitHub API](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens) or the [command line](#using-a-token-on-the-command-line).
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}If you want to use a PAT to access resources owned by an organization that uses SAML SSO, you must authorize the PAT. For more information, see "[About authentication with SAML single sign-on](/articles/about-authentication-with-saml-single-sign-on)" and "[Authorizing a personal access token for use with SAML single sign-on](/articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)."{% endif %}
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ versions:
|
||||
enterprise-server: '*'
|
||||
---
|
||||
|
||||
You must choose or generate a password for your {% data variables.product.product_name %} account that is:
|
||||
You must choose or generate a password for your {% data variables.product.product_name %} account that is at least:
|
||||
- Eight characters long, if it includes a number and a lowercase letter, or
|
||||
- 16 characters long with any combination of characters
|
||||
|
||||
|
||||
@@ -98,13 +98,19 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav
|
||||
IdentityFile ~/.ssh/id_ed25519
|
||||
```
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** If you chose not to add a passphrase to your key, you should omit the `UseKeychain` line.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
3. Add your SSH private key to the ssh-agent and store your passphrase in the keychain. {% data reusables.ssh.add-ssh-key-to-ssh-agent %}
|
||||
```shell
|
||||
$ ssh-add -K ~/.ssh/id_ed25519
|
||||
```
|
||||
{% note %}
|
||||
|
||||
**Note:** The `-K` option is Apple's standard version of `ssh-add`, which stores the passphrase in your keychain for you when you add an ssh key to the ssh-agent.
|
||||
**Note:** The `-K` option is Apple's standard version of `ssh-add`, which stores the passphrase in your keychain for you when you add an ssh key to the ssh-agent. If you chose not to add a passphrase to your key, run the command without the `-K` option.
|
||||
|
||||
If you don't have Apple's standard version installed, you may receive an error. For more information on resolving this error, see "[Error: ssh-add: illegal option -- K](/articles/error-ssh-add-illegal-option-k)."
|
||||
|
||||
|
||||
@@ -35,11 +35,9 @@ versions:
|
||||
{% link_in_list /reviewing-your-authorized-applications-oauth %}
|
||||
{% link_in_list /reviewing-your-security-log %}
|
||||
{% link_in_list /removing-sensitive-data-from-a-repository %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /about-anonymized-image-urls %}
|
||||
{% link_in_list /about-githubs-ip-addresses %}
|
||||
{% link_in_list /githubs-ssh-key-fingerprints %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /sudo-mode %}
|
||||
{% link_in_list /preventing-unauthorized-access %}
|
||||
{% topic_link_in_list /securing-your-account-with-two-factor-authentication-2fa %}
|
||||
@@ -48,18 +46,14 @@ versions:
|
||||
{% link_in_list /configuring-two-factor-authentication-recovery-methods %}
|
||||
{% link_in_list /accessing-github-using-two-factor-authentication %}
|
||||
{% link_in_list /recovering-your-account-if-you-lose-your-2fa-credentials %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /changing-two-factor-authentication-delivery-methods-for-your-mobile-device %}
|
||||
{% link_in_list /countries-where-sms-authentication-is-supported %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /disabling-two-factor-authentication-for-your-personal-account %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% topic_link_in_list /authenticating-with-saml-single-sign-on %}
|
||||
{% link_in_list /about-authentication-with-saml-single-sign-on %}
|
||||
{% link_in_list /authorizing-an-ssh-key-for-use-with-saml-single-sign-on %}
|
||||
{% link_in_list /authorizing-a-personal-access-token-for-use-with-saml-single-sign-on %}
|
||||
{% link_in_list /viewing-and-managing-your-active-saml-sessions %}
|
||||
<!-- endif -->
|
||||
{% topic_link_in_list /connecting-to-github-with-ssh %}
|
||||
{% link_in_list /about-ssh %}
|
||||
{% link_in_list /checking-for-existing-ssh-keys %}
|
||||
@@ -68,13 +62,9 @@ versions:
|
||||
{% link_in_list /testing-your-ssh-connection %}
|
||||
{% link_in_list /working-with-ssh-key-passphrases %}
|
||||
{% topic_link_in_list /troubleshooting-ssh %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /using-ssh-over-the-https-port %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /recovering-your-ssh-key-passphrase %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /deleted-or-missing-ssh-keys %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /error-permission-denied-publickey %}
|
||||
{% link_in_list /error-bad-file-number %}
|
||||
{% link_in_list /error-key-already-in-use %}
|
||||
@@ -82,9 +72,7 @@ versions:
|
||||
{% link_in_list /error-permission-to-userrepo-denied-to-userother-repo %}
|
||||
{% link_in_list /error-agent-admitted-failure-to-sign %}
|
||||
{% link_in_list /error-ssh-add-illegal-option----k %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /error-were-doing-an-ssh-key-audit %}
|
||||
{% topic_link_in_list /managing-commit-signature-verification %}
|
||||
{% link_in_list /about-commit-signature-verification %}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
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.
|
||||
miniTocMaxHeadingLevel: 4
|
||||
redirect_from:
|
||||
- /articles/reviewing-your-security-log
|
||||
versions:
|
||||
@@ -33,212 +34,26 @@ The security log lists all actions performed within the last 90 days{% if curren
|
||||
#### Search based on the action performed
|
||||
{% else %}
|
||||
### Understanding events in your security log
|
||||
|
||||
Actions listed in your security log are grouped within the following categories:
|
||||
{% endif %}
|
||||
|
||||
| Category Name | Description
|
||||
The events listed in your security log are triggered by your actions. Actions are grouped into the following categories:
|
||||
|
||||
| Category name | Description
|
||||
|------------------|-------------------{% if currentVersion == "free-pro-team@latest" %}
|
||||
| `account_recovery_token` | Contains all activities related to [adding a recovery token](/articles/configuring-two-factor-authentication-recovery-methods).
|
||||
| `billing` | Contains all activities related to your billing information.
|
||||
| `marketplace_agreement_signature` | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement.
|
||||
| `marketplace_listing` | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %}
|
||||
| `oauth_access` | Contains all activities related to [{% data variables.product.prodname_oauth_app %}s](/articles/authorizing-oauth-apps) you've connected with.{% if currentVersion == "free-pro-team@latest" %}
|
||||
| `payment_method` | Contains all activities related to paying for your {% data variables.product.prodname_dotcom %} subscription.{% endif %}
|
||||
| `profile_picture` | Contains all activities related to your profile picture.
|
||||
| `project` | Contains all activities related to project boards.
|
||||
| `public_key` | Contains all activities related to [your public SSH keys](/articles/adding-a-new-ssh-key-to-your-github-account).
|
||||
| `repo` | Contains all activities related to the repositories you own.{% if currentVersion == "free-pro-team@latest" %}
|
||||
| `sponsors` | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
|
||||
| `team` | Contains all activities related to teams you are a part of.{% endif %}{% if currentVersion != "github-ae@latest" %}
|
||||
| `two_factor_authentication` | Contains all activities related to [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa).{% endif %}
|
||||
| `user` | Contains all activities related to your account.
|
||||
|
||||
A description of the events within these categories is listed below.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
#### The `account_recovery_token` category
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| confirm | Triggered when you successfully [store a new token with a recovery provider](/articles/configuring-two-factor-authentication-recovery-methods).
|
||||
| recover | Triggered when you successfully [redeem an account recovery token](/articles/recovering-your-account-if-you-lose-your-2fa-credentials).
|
||||
| recover_error | Triggered when a token is used but {% data variables.product.prodname_dotcom %} is not able to validate it.
|
||||
|
||||
#### The `billing` category
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| change_billing_type | Triggered when you [change how you pay](/articles/adding-or-editing-a-payment-method) for {% data variables.product.prodname_dotcom %}.
|
||||
| change_email | Triggered when you [change your email address](/articles/changing-your-primary-email-address).
|
||||
|
||||
#### The `marketplace_agreement_signature` category
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| create | Triggered when you sign the {% data variables.product.prodname_marketplace %} Developer Agreement.
|
||||
|
||||
#### The `marketplace_listing` category
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| approve | Triggered when your listing is approved for inclusion in {% data variables.product.prodname_marketplace %}.
|
||||
| create | Triggered when you create a listing for your app in {% data variables.product.prodname_marketplace %}.
|
||||
| delist | Triggered when your listing is removed from {% data variables.product.prodname_marketplace %}.
|
||||
| redraft | Triggered when your listing is sent back to draft state.
|
||||
| reject | Triggered when your listing is not accepted for inclusion in {% data variables.product.prodname_marketplace %}.
|
||||
|
||||
{% endif %}
|
||||
|
||||
#### The `oauth_access` category
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| create | Triggered when you [grant access to an {% data variables.product.prodname_oauth_app %}](/articles/authorizing-oauth-apps).
|
||||
| destroy | Triggered when you [revoke an {% data variables.product.prodname_oauth_app %}'s access to your account](/articles/reviewing-your-authorized-integrations).
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
#### The `payment_method` category
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| clear | Triggered when [a payment method](/articles/removing-a-payment-method) on file is removed.
|
||||
| create | Triggered when a new payment method is added, such as a new credit card or PayPal account.
|
||||
| update | Triggered when an existing payment method is updated.
|
||||
|
||||
{% endif %}
|
||||
|
||||
#### The `profile_picture` category
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| update | Triggered when you [set or update your profile picture](/articles/setting-your-profile-picture/).
|
||||
|
||||
#### The `project` category
|
||||
|
||||
| Action | Description
|
||||
|--------------------|---------------------
|
||||
| `create` | Triggered when a project board is created.
|
||||
| `rename` | Triggered when a project board is renamed.
|
||||
| `update` | Triggered when a project board is updated.
|
||||
| `delete` | Triggered when a project board is deleted.
|
||||
| `link` | Triggered when a repository is linked to a project board.
|
||||
| `unlink` | Triggered when a repository is unlinked from a project board.
|
||||
| `project.access` | Triggered when a project board's visibility is changed.
|
||||
| `update_user_permission` | Triggered when an outside collaborator is added to or removed from a project board or has their permission level changed.
|
||||
|
||||
#### The `public_key` category
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| create | Triggered when you [add a new public SSH key to your {% data variables.product.product_name %} account](/articles/adding-a-new-ssh-key-to-your-github-account).
|
||||
| delete | Triggered when you [remove a public SSH key to your {% data variables.product.product_name %} account](/articles/reviewing-your-ssh-keys).
|
||||
|
||||
#### The `repo` category
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| access | Triggered when you a repository you own is [switched from "private" to "public"](/articles/making-a-private-repository-public) (or vice versa).
|
||||
| add_member | Triggered when a {% data variables.product.product_name %} user is {% if currentVersion == "free-pro-team@latest" %}[invited to have collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% else %}[given collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% endif %} to a repository.
|
||||
| add_topic | Triggered when a repository owner [adds a topic](/articles/classifying-your-repository-with-topics) to a repository.
|
||||
| archived | Triggered when a repository owner [archives a repository](/articles/about-archiving-repositories).{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
|
||||
| config.disable_anonymous_git_access | Triggered when [anonymous Git read access is disabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
|
||||
| config.enable_anonymous_git_access | Triggered when [anonymous Git read access is enabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
|
||||
| config.lock_anonymous_git_access | Triggered when a repository's [anonymous Git read access setting is locked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).
|
||||
| config.unlock_anonymous_git_access | Triggered when a repository's [anonymous Git read access setting is unlocked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).{% endif %}
|
||||
| create | Triggered when [a new repository is created](/articles/creating-a-new-repository).
|
||||
| destroy | Triggered when [a repository is deleted](/articles/deleting-a-repository).{% if currentVersion == "free-pro-team@latest" %}
|
||||
| disable | Triggered when a repository is disabled (e.g., for [insufficient funds](/articles/unlocking-a-locked-account)).{% endif %}{% if currentVersion == "free-pro-team@latest" %}
|
||||
| enable | Triggered when a repository is re-enabled.{% endif %}
|
||||
| remove_member | Triggered when a {% data variables.product.product_name %} user is [removed from a repository as a collaborator](/articles/removing-a-collaborator-from-a-personal-repository).
|
||||
| remove_topic | Triggered when a repository owner removes a topic from a repository.
|
||||
| rename | Triggered when [a repository is renamed](/articles/renaming-a-repository).
|
||||
| transfer | Triggered when [a repository is transferred](/articles/how-to-transfer-a-repository).
|
||||
| transfer_start | Triggered when a repository transfer is about to occur.
|
||||
| unarchived | Triggered when a repository owner unarchives a repository.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
#### The `sponsors` category
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| repo_funding_link_button_toggle | Triggered when you enable or disable a sponsor button in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
|
||||
| repo_funding_links_file_action | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
|
||||
| sponsor_sponsorship_cancel | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
|
||||
| sponsor_sponsorship_create | Triggered when you sponsor a developer (see "[Sponsoring an open source contributor](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor#sponsoring-a-developer)")
|
||||
| sponsor_sponsorship_preference_change | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/articles/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](/github/supporting-the-open-source-community-with-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](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| sponsored_developer_profile_update | Triggered when you edit your sponsored developer profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-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](/github/supporting-the-open-source-community-with-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 "[Changing your sponsorship tiers](/articles/changing-your-sponsorship-tiers)")
|
||||
| sponsored_developer_update_newsletter_send | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/articles/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](/github/supporting-the-open-source-community-with-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](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
#### The `successor_invitation` category
|
||||
|
||||
| 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)")
|
||||
{% endif %}
|
||||
|
||||
{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
|
||||
|
||||
#### The `team` category
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| add_member | Triggered when a member of an organization you belong to [adds you to a team](/articles/adding-organization-members-to-a-team).
|
||||
| add_repository | Triggered when a team you are a member of is given control of a repository.
|
||||
| create | Triggered when a new team in an organization you belong to is created.
|
||||
| destroy | Triggered when a team you are a member of is deleted from the organization.
|
||||
| remove_member | Triggered when a member of an organization is [removed from a team](/articles/removing-organization-members-from-a-team) you are a member of.
|
||||
| remove_repository | Triggered when a repository is no longer under a team's control.
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion != "github-ae@latest" %}
|
||||
#### The `two_factor_authentication` category
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| enabled | Triggered when [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) is enabled.
|
||||
| disabled | Triggered when two-factor authentication is disabled.
|
||||
{% endif %}
|
||||
|
||||
#### The `user` category
|
||||
|
||||
| Action | Description
|
||||
|--------------------|---------------------
|
||||
| add_email | Triggered when you {% if currentVersion != "github-ae@latest" %}[add a new email address](/articles/changing-your-primary-email-address){% else %}add a new email address{% endif %}.
|
||||
| create | Triggered when you create a new user account.
|
||||
| remove_email | Triggered when you remove an email address.
|
||||
| rename | Triggered when you rename your account.{% if currentVersion != "github-ae@latest" %}
|
||||
| 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 %}
|
||||
| login | Triggered when you log in to {% data variables.product.product_location %}.
|
||||
| failed_login | Triggered when you failed to log in successfully.{% if currentVersion != "github-ae@latest" %}
|
||||
| two_factor_requested | Triggered when {% data variables.product.product_name %} asks you for [your two-factor authentication code](/articles/accessing-github-using-two-factor-authentication).{% endif %}
|
||||
| show_private_contributions_count | Triggered when you [publicize private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).
|
||||
| hide_private_contributions_count | Triggered when you [hide private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).{% if currentVersion == "free-pro-team@latest" %}
|
||||
| report_content | Triggered when you [report an issue or pull request, or a comment on an issue, pull request, or commit](/articles/reporting-abuse-or-spam).{% endif %}
|
||||
|
||||
#### The `user_status` category
|
||||
|
||||
| Action | Description
|
||||
|--------------------|---------------------
|
||||
| update | Triggered when you set or change the status on your profile. For more information, see "[Setting a status](/articles/personalizing-your-profile/#setting-a-status)."
|
||||
| destroy | Triggered when you clear the status on your profile.
|
||||
| [`account_recovery_token`](#account_recovery_token-category-actions) | Contains all activities related to [adding a recovery token](/articles/configuring-two-factor-authentication-recovery-methods).
|
||||
| [`billing`](#billing-category-actions) | Contains all activities related to your billing information.
|
||||
| [`marketplace_agreement_signature`](#marketplace_agreement_signature-category-actions) | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement.
|
||||
| [`marketplace_listing`](#marketplace_listing-category-actions) | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %}
|
||||
| [`oauth_access`](#oauth_access-category-actions) | Contains all activities related to [{% data variables.product.prodname_oauth_app %}s](/articles/authorizing-oauth-apps) you've connected with.{% if currentVersion == "free-pro-team@latest" %}
|
||||
| [`payment_method`](#payment_method-category-actions) | Contains all activities related to paying for your {% data variables.product.prodname_dotcom %} subscription.{% endif %}
|
||||
| [`profile_picture`](#profile_picture-category-actions) | Contains all activities related to your profile picture.
|
||||
| [`project`](#project-category-actions) | Contains all activities related to project boards.
|
||||
| [`public_key`](#public_key-category-actions) | Contains all activities related to [your public SSH keys](/articles/adding-a-new-ssh-key-to-your-github-account).
|
||||
| [`repo`](#repo-category-actions) | Contains all activities related to the repositories you own.{% if currentVersion == "free-pro-team@latest" %}
|
||||
| [`sponsors`](#sponsors-category-actions) | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
|
||||
| [`team`](#team-category-actions) | Contains all activities related to teams you are a part of.{% endif %}{% if currentVersion != "github-ae@latest" %}
|
||||
| [`two_factor_authentication`](#two_factor_authentication-category-actions) | Contains all activities related to [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa).{% endif %}
|
||||
| [`user`](#user-category-actions) | Contains all activities related to your account.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
@@ -248,3 +63,193 @@ A description of the events within these categories is listed below.
|
||||
{% data reusables.audit_log.exported-log-keys-and-values %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
### Security log actions
|
||||
|
||||
An overview of some of the most common actions that are recorded as events in the security log.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
#### `account_recovery_token` category actions
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `confirm` | Triggered when you successfully [store a new token with a recovery provider](/articles/configuring-two-factor-authentication-recovery-methods).
|
||||
| `recover` | Triggered when you successfully [redeem an account recovery token](/articles/recovering-your-account-if-you-lose-your-2fa-credentials).
|
||||
| `recover_error` | Triggered when a token is used but {% data variables.product.prodname_dotcom %} is not able to validate it.
|
||||
|
||||
#### `billing` category actions
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `change_billing_type` | Triggered when you [change how you pay](/articles/adding-or-editing-a-payment-method) for {% data variables.product.prodname_dotcom %}.
|
||||
| `change_email` | Triggered when you [change your email address](/articles/changing-your-primary-email-address).
|
||||
|
||||
#### `marketplace_agreement_signature` category actions
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `create` | Triggered when you sign the {% data variables.product.prodname_marketplace %} Developer Agreement.
|
||||
|
||||
#### `marketplace_listing` category actions
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `approve` | Triggered when your listing is approved for inclusion in {% data variables.product.prodname_marketplace %}.
|
||||
| `create` | Triggered when you create a listing for your app in {% data variables.product.prodname_marketplace %}.
|
||||
| `delist` | Triggered when your listing is removed from {% data variables.product.prodname_marketplace %}.
|
||||
| `redraft` | Triggered when your listing is sent back to draft state.
|
||||
| `reject` | Triggered when your listing is not accepted for inclusion in {% data variables.product.prodname_marketplace %}.
|
||||
|
||||
{% endif %}
|
||||
|
||||
#### `oauth_access` category actions
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `create` | Triggered when you [grant access to an {% data variables.product.prodname_oauth_app %}](/articles/authorizing-oauth-apps).
|
||||
| `destroy` | Triggered when you [revoke an {% data variables.product.prodname_oauth_app %}'s access to your account](/articles/reviewing-your-authorized-integrations).
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
#### `payment_method` category actions
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `clear` | Triggered when [a payment method](/articles/removing-a-payment-method) on file is removed.
|
||||
| `create` | Triggered when a new payment method is added, such as a new credit card or PayPal account.
|
||||
| `update` | Triggered when an existing payment method is updated.
|
||||
|
||||
{% endif %}
|
||||
|
||||
#### `profile_picture` category actions
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `update` | Triggered when you [set or update your profile picture](/articles/setting-your-profile-picture/).
|
||||
|
||||
#### `project` category actions
|
||||
|
||||
| Action | Description
|
||||
|--------------------|---------------------
|
||||
| `access` | Triggered when a project board's visibility is changed.
|
||||
| `create` | Triggered when a project board is created.
|
||||
| `rename` | Triggered when a project board is renamed.
|
||||
| `update` | Triggered when a project board is updated.
|
||||
| `delete` | Triggered when a project board is deleted.
|
||||
| `link` | Triggered when a repository is linked to a project board.
|
||||
| `unlink` | Triggered when a repository is unlinked from a project board.
|
||||
| `update_user_permission` | Triggered when an outside collaborator is added to or removed from a project board or has their permission level changed.
|
||||
|
||||
#### `public_key` category actions
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `create` | Triggered when you [add a new public SSH key to your {% data variables.product.product_name %} account](/articles/adding-a-new-ssh-key-to-your-github-account).
|
||||
| `delete` | Triggered when you [remove a public SSH key to your {% data variables.product.product_name %} account](/articles/reviewing-your-ssh-keys).
|
||||
|
||||
#### `repo` category actions
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `access` | Triggered when you a repository you own is [switched from "private" to "public"](/articles/making-a-private-repository-public) (or vice versa).
|
||||
| `add_member` | Triggered when a {% data variables.product.product_name %} user is {% if currentVersion == "free-pro-team@latest" %}[invited to have collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% else %}[given collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% endif %} to a repository.
|
||||
| `add_topic` | Triggered when a repository owner [adds a topic](/articles/classifying-your-repository-with-topics) to a repository.
|
||||
| `archived` | Triggered when a repository owner [archives a repository](/articles/about-archiving-repositories).{% if enterpriseServerVersions contains currentVersion %}
|
||||
| `config.disable_anonymous_git_access` | Triggered when [anonymous Git read access is disabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
|
||||
| `config.enable_anonymous_git_access` | Triggered when [anonymous Git read access is enabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
|
||||
| `config.lock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is locked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).
|
||||
| `config.unlock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is unlocked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).{% endif %}
|
||||
| `create` | Triggered when [a new repository is created](/articles/creating-a-new-repository).
|
||||
| `destroy` | Triggered when [a repository is deleted](/articles/deleting-a-repository).{% if currentVersion == "free-pro-team@latest" %}
|
||||
| `disable` | Triggered when a repository is disabled (e.g., for [insufficient funds](/articles/unlocking-a-locked-account)).{% endif %}{% if currentVersion == "free-pro-team@latest" %}
|
||||
| `enable` | Triggered when a repository is re-enabled.{% endif %}
|
||||
| `remove_member` | Triggered when a {% data variables.product.product_name %} user is [removed from a repository as a collaborator](/articles/removing-a-collaborator-from-a-personal-repository).
|
||||
| `remove_topic` | Triggered when a repository owner removes a topic from a repository.
|
||||
| `rename` | Triggered when [a repository is renamed](/articles/renaming-a-repository).
|
||||
| `transfer` | Triggered when [a repository is transferred](/articles/how-to-transfer-a-repository).
|
||||
| `transfer_start` | Triggered when a repository transfer is about to occur.
|
||||
| `unarchived` | Triggered when a repository owner unarchives a repository.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
#### `sponsors` category actions
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `repo_funding_link_button_toggle` | Triggered when you enable or disable a sponsor button in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
|
||||
| `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
|
||||
| `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
|
||||
| `sponsor_sponsorship_create` | Triggered when you sponsor a developer (see "[Sponsoring an open source contributor](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor#sponsoring-a-developer)")
|
||||
| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/articles/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](/github/supporting-the-open-source-community-with-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](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `sponsored_developer_profile_update` | Triggered when you edit your sponsored developer profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-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](/github/supporting-the-open-source-community-with-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 "[Changing your sponsorship tiers](/articles/changing-your-sponsorship-tiers)")
|
||||
| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/articles/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](/github/supporting-the-open-source-community-with-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](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
#### `successor_invitation` category actions
|
||||
|
||||
| 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)")
|
||||
{% endif %}
|
||||
|
||||
{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
|
||||
|
||||
#### `team` category actions
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `add_member` | Triggered when a member of an organization you belong to [adds you to a team](/articles/adding-organization-members-to-a-team).
|
||||
| `add_repository` | Triggered when a team you are a member of is given control of a repository.
|
||||
| `create` | Triggered when a new team in an organization you belong to is created.
|
||||
| `destroy` | Triggered when a team you are a member of is deleted from the organization.
|
||||
| `remove_member` | Triggered when a member of an organization is [removed from a team](/articles/removing-organization-members-from-a-team) you are a member of.
|
||||
| `remove_repository` | Triggered when a repository is no longer under a team's control.
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion != "github-ae@latest" %}
|
||||
#### `two_factor_authentication` category actions
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `enabled` | Triggered when [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) is enabled.
|
||||
| `disabled` | Triggered when two-factor authentication is disabled.
|
||||
{% endif %}
|
||||
|
||||
#### `user` category actions
|
||||
|
||||
| Action | Description
|
||||
|--------------------|---------------------
|
||||
| `add_email` | Triggered when you {% if currentVersion != "github-ae@latest" %}[add a new email address](/articles/changing-your-primary-email-address){% else %}add a new email address{% endif %}.
|
||||
| `create` | Triggered when you create a new user account.{% if currentVersion != "github-ae@latest" %}
|
||||
| `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).
|
||||
| `login` | Triggered when you log in to {% data variables.product.product_location %}.
|
||||
| `failed_login` | Triggered when you failed to log in successfully.
|
||||
| `remove_email` | Triggered when you remove an email address.
|
||||
| `rename` | Triggered when you rename your account.{% if currentVersion == "free-pro-team@latest" %}
|
||||
| `report_content` | Triggered when you [report an issue or pull request, or a comment on an issue, pull request, or commit](/articles/reporting-abuse-or-spam).{% endif %}
|
||||
| `show_private_contributions_count` | Triggered when you [publicize private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).{% if currentVersion != "github-ae@latest" %}
|
||||
| `two_factor_requested` | Triggered when {% data variables.product.product_name %} asks you for [your two-factor authentication code](/articles/accessing-github-using-two-factor-authentication).{% endif %}
|
||||
|
||||
#### `user_status` category actions
|
||||
|
||||
| Action | Description
|
||||
|--------------------|---------------------
|
||||
| `update` | Triggered when you set or change the status on your profile. For more information, see "[Setting a status](/articles/personalizing-your-profile/#setting-a-status)."
|
||||
| `destroy` | Triggered when you clear the status on your profile.
|
||||
|
||||
|
||||
|
||||
@@ -11,7 +11,11 @@ versions:
|
||||
|
||||
After you create issue and pull request templates in your repository, contributors can use the templates to open issues or describe the proposed changes in their pull requests according to the repository's contributing guidelines. For more information about adding contributing guidelines to a repository, see "[Setting guidelines for repository contributors](/articles/setting-guidelines-for-repository-contributors)."
|
||||
|
||||
You can create default issue and pull request templates for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
You can create default issue and pull request templates for your organization or user account. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
### Issue templates
|
||||
|
||||
|
||||
@@ -15,9 +15,9 @@ Every {% data variables.product.product_name %} repository comes equipped with a
|
||||
|
||||
With wikis, you can write content just like everywhere else on {% data variables.product.product_name %}. For more information, see "[Getting started with writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/getting-started-with-writing-and-formatting-on-github)." We use [our open-source Markup library](https://github.com/github/markup) to convert different formats into HTML, so you can choose to write in Markdown or any other supported format.
|
||||
|
||||
Wikis are available to the public in public repositories, and limited to people with access to the repository in private repositories. For more information, see "[Setting repository visibility](/articles/setting-repository-visibility)."
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}If you create a wiki in a public repository, the wiki is available to {% if enterpriseServerVersions contains currentVersion %}anyone with access to {% data variables.product.product_location %}{% else %}the public{% endif %}. {% endif %}If you create a wiki in an internal or private repository, {% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}people{% elsif currentVersion == "github-ae@latest" %}enterprise members{% endif %} with access to the repository can also access the wiki. For more information, see "[Setting repository visibility](/articles/setting-repository-visibility)."
|
||||
|
||||
You can edit wikis directly on {% data variables.product.product_name %}, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on {% data variables.product.product_name %} to contribute to a wiki in a public repository. For more information, see "[Changing access permissions for wikis](/articles/changing-access-permissions-for-wikis)".
|
||||
You can edit wikis directly on {% data variables.product.product_name %}, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on {% data variables.product.product_location %} to contribute to a wiki in {% if currentVersion == "github-ae@latest" %}an internal{% else %}a public{% endif %} repository. For more information, see "[Changing access permissions for wikis](/articles/changing-access-permissions-for-wikis)".
|
||||
|
||||
### Further reading
|
||||
|
||||
|
||||
@@ -6,7 +6,6 @@ redirect_from:
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
---
|
||||
If you include a detectable license in your repository, people who visit your repository will see it at the top of the repository page. To read the entire license file, click the license name.
|
||||
|
||||
|
||||
@@ -12,7 +12,11 @@ To direct people to specific support resources, you can add a SUPPORT file to yo
|
||||
|
||||
|
||||
|
||||
You can create default support resources for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
You can create default support resources for your organization or user account. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% tip %}
|
||||
|
||||
|
||||
@@ -10,10 +10,16 @@ versions:
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
{% data reusables.repositories.default-issue-templates %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
|
||||
|
||||
### Creating issue templates
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
|
||||
@@ -7,7 +7,6 @@ redirect_from:
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
### About default community health files
|
||||
|
||||
@@ -13,7 +13,11 @@ For more information, see "[About issue and pull request templates](/articles/ab
|
||||
|
||||
You can create a *PULL_REQUEST_TEMPLATE/* subdirectory in any of the supported folders to contain multiple pull request templates, and use the `template` query parameter to specify the template that will fill the pull request body. For more information, see "[About automation for issues and pull requests with query parameters](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)."
|
||||
|
||||
You can create default pull request templates for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
You can create default pull request templates for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
### Adding a pull request template
|
||||
|
||||
|
||||
@@ -13,21 +13,15 @@ versions:
|
||||
### Table of Contents
|
||||
|
||||
{% topic_link_in_list /setting-up-your-project-for-healthy-contributions %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /about-community-management-and-moderation %}
|
||||
{% link_in_list /about-community-profiles-for-public-repositories %}
|
||||
{% link_in_list /accessing-a-projects-community-profile %}
|
||||
{% link_in_list /adding-a-code-of-conduct-to-your-project %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /setting-guidelines-for-repository-contributors %}
|
||||
{% link_in_list /adding-a-license-to-a-repository %}
|
||||
{% link_in_list /adding-support-resources-to-your-project %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.16" -->
|
||||
{% link_in_list /creating-a-default-community-health-file %}
|
||||
<!-- endif -->
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /encouraging-helpful-contributions-to-your-project-with-labels %}
|
||||
<!-- endif -->
|
||||
{% topic_link_in_list /using-templates-to-encourage-useful-issues-and-pull-requests %}
|
||||
{% link_in_list /about-issue-and-pull-request-templates %}
|
||||
{% link_in_list /configuring-issue-templates-for-your-repository %}
|
||||
@@ -42,7 +36,6 @@ versions:
|
||||
{% link_in_list /tracking-changes-in-a-comment %}
|
||||
{% link_in_list /managing-how-contributors-report-abuse-in-your-organizations-repository %}
|
||||
{% link_in_list /managing-reported-content-in-your-organizations-repository %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% topic_link_in_list /maintaining-your-safety-on-github %}
|
||||
{% link_in_list /blocking-a-user-from-your-personal-account %}
|
||||
{% link_in_list /viewing-users-youve-blocked-from-your-personal-account %}
|
||||
@@ -51,7 +44,6 @@ versions:
|
||||
{% link_in_list /viewing-users-who-are-blocked-from-your-organization %}
|
||||
{% link_in_list /unblocking-a-user-from-your-organization %}
|
||||
{% link_in_list /reporting-abuse-or-spam %}
|
||||
<!-- endif -->
|
||||
{% topic_link_in_list /documenting-your-project-with-wikis %}
|
||||
{% link_in_list /about-wikis %}
|
||||
{% link_in_list /adding-or-editing-wiki-pages %}
|
||||
@@ -60,10 +52,8 @@ versions:
|
||||
{% link_in_list /viewing-a-wikis-history-of-changes %}
|
||||
{% link_in_list /changing-access-permissions-for-wikis %}
|
||||
{% link_in_list /disabling-wikis %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% topic_link_in_list /collaborating-with-your-team %}
|
||||
{% link_in_list /about-team-discussions %}
|
||||
{% link_in_list /creating-a-team-discussion %}
|
||||
{% link_in_list /editing-or-deleting-a-team-discussion %}
|
||||
{% link_in_list /pinning-a-team-discussion %}
|
||||
<!-- endif -->
|
||||
|
||||
@@ -15,7 +15,7 @@ Locking a conversation creates a timeline event that is visible to anyone with r
|
||||
|
||||
|
||||
|
||||
While a conversation is locked, only [people with write access](/articles/repository-permission-levels-for-an-organization/) and [repository owners and collaborators](/articles/permission-levels-for-a-user-account-repository/#collaborator-access-on-a-repository-owned-by-a-user-account) can add, hide, and delete comments.
|
||||
While a conversation is locked, only [people with write access](/articles/repository-permission-levels-for-an-organization/) and [repository owners and collaborators](/articles/permission-levels-for-a-user-account-repository/#collaborator-access-for-a-repository-owned-by-a-user-account) can add, hide, and delete comments.
|
||||
|
||||
To search for locked conversations in a repository that is not archived, you can use the search qualifiers `is:locked` and `archived:false`. Conversations are automatically locked in archived repositories. For more information, see "[Searching issues and pull requests](/articles/searching-issues-and-pull-requests#search-based-on-whether-a-conversation-is-locked)."
|
||||
|
||||
|
||||
@@ -39,8 +39,12 @@ assignees: octocat
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
{% data reusables.repositories.default-issue-templates %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
### Adding an issue template
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
|
||||
@@ -20,7 +20,11 @@ For contributors, the guidelines help them verify that they're submitting well-f
|
||||
|
||||
For both owners and contributors, contribution guidelines save time and hassle caused by improperly created pull requests or issues that have to be rejected and re-submitted.
|
||||
|
||||
You can create default contribution guidelines for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
You can create default contribution guidelines for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% tip %}
|
||||
|
||||
@@ -54,5 +58,5 @@ If you're stumped, here are some good examples of contribution guidelines:
|
||||
|
||||
### Further reading
|
||||
- The Open Source Guides' section "[Starting an Open Source Project](https://opensource.guide/starting-a-project/)"{% if currentVersion == "free-pro-team@latest" %}
|
||||
- [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %}
|
||||
- "[Adding a license to a repository](/articles/adding-a-license-to-a-repository)"
|
||||
- [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %}{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
- "[Adding a license to a repository](/articles/adding-a-license-to-a-repository)"{% endif %}
|
||||
|
||||
@@ -23,7 +23,7 @@ You must have write access to a repository to create a branch, open a pull reque
|
||||
|
||||
### About the default branch
|
||||
|
||||
{% data reusables.branches.new-repo-default-branch %} The default branch is the branch that {% data variables.product.prodname_dotcom %} displays when anyone visits your repository. The default branch is also the initial branch that Git checks out locally out when someone clones the repository. {% data reusables.branches.default-branch-automatically-base-branch %}
|
||||
{% data reusables.branches.new-repo-default-branch %} The default branch is the branch that {% data variables.product.prodname_dotcom %} displays when anyone visits your repository. The default branch is also the initial branch that Git checks out locally when someone clones the repository. {% data reusables.branches.default-branch-automatically-base-branch %}
|
||||
|
||||
By default, {% data variables.product.product_name %} names the default branch {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}`main`{% else %}`master`{% endif %} in any new repository.
|
||||
|
||||
@@ -75,7 +75,7 @@ When a branch is protected:
|
||||
- If required pull request reviews are enabled on the branch, you won't be able to merge changes into the branch until all requirements in the pull request review policy have been met. For more information, see "[Merging a pull request](/articles/merging-a-pull-request)."
|
||||
- If required review from a code owner is enabled on a branch, and a pull request modifies code that has an owner, a code owner must approve the pull request before it can be merged. For more information, see "[About code owners](/articles/about-code-owners)."
|
||||
- If required commit signing is enabled on a branch, you won't be able to push any commits to the branch that are not signed and verified. For more information, see "[About commit signature verification](/articles/about-commit-signature-verification)" and "[About required commit signing](/articles/about-required-commit-signing)."{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
|
||||
- If you use {% data variables.product.prodname_dotcom %} 's conflict editor to fix conflicts for a pull request that you created from a protected branch, {% data variables.product.prodname_dotcom %} helps you to create an alternative branch for the pull request, so that your resolution of the conflicts can be merged. For more information, see "[Resolving a merge conflict on {% data variables.product.prodname_dotcom %}](/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)."{% endif %}
|
||||
- If you use {% data variables.product.prodname_dotcom %}'s conflict editor to fix conflicts for a pull request that you created from a protected branch, {% data variables.product.prodname_dotcom %} helps you to create an alternative branch for the pull request, so that your resolution of the conflicts can be merged. For more information, see "[Resolving a merge conflict on {% data variables.product.prodname_dotcom %}](/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)."{% endif %}
|
||||
|
||||
### Further reading
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ There are two types of status checks on {% data variables.product.product_name %
|
||||
|
||||
_Checks_ are different from _statuses_ in that they provide line annotations, more detailed messaging, and are only available for use with {% data variables.product.prodname_github_app %}s.
|
||||
|
||||
Organization owners and users with push access to a repository can create checks and statuses with {% data variables.product.product_name %}'s API. For more information, see "[Checks](/v3/checks/)" and "[Statuses](/v3/repos/statuses/)."
|
||||
Organization owners and users with push access to a repository can create checks and statuses with {% data variables.product.product_name %}'s API. For more information, see "[Checks](/rest/reference/checks)" and "[Statuses](/rest/reference/repos#statuses)."
|
||||
|
||||
### Checks
|
||||
|
||||
|
||||
@@ -25,7 +25,11 @@ versions:
|
||||
|
||||
{% data reusables.pull_requests.automatically-delete-branches %}
|
||||
|
||||
If the branch you want to delete is the repository's default branch, you must choose a new default branch before deleting the branch. For more information, see "[Changing the default branch](/github/administering-a-repository/changing-the-default-branch)."
|
||||
{% note %}
|
||||
|
||||
**Note:** If the branch you want to delete is the repository's default branch, you must choose a new default branch before deleting the branch. For more information, see "[Changing the default branch](/github/administering-a-repository/changing-the-default-branch)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
If the branch you want to delete is associated with an open pull request, you must merge or close the pull request before deleting the branch. For more information, see "[Merging a pull request](/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request)" or "[Closing a pull request](/github/collaborating-with-issues-and-pull-requests/closing-a-pull-request)."
|
||||
|
||||
|
||||
@@ -29,9 +29,7 @@ versions:
|
||||
{% link_in_list /what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility %}
|
||||
{% topic_link_in_list /collaborating-on-repositories-with-code-quality-features %}
|
||||
{% link_in_list /about-status-checks %}
|
||||
<!-- if enterpriseServerVersions contains currentVersion -->
|
||||
{% link_in_list /working-with-pre-receive-hooks %}
|
||||
<!-- endif -->
|
||||
{% topic_link_in_list /proposing-changes-to-your-work-with-pull-requests %}
|
||||
{% link_in_list /about-branches %}
|
||||
{% link_in_list /creating-and-deleting-branches-within-your-repository %}
|
||||
@@ -39,9 +37,7 @@ versions:
|
||||
{% link_in_list /about-comparing-branches-in-pull-requests %}
|
||||
{% link_in_list /creating-a-pull-request %}
|
||||
{% link_in_list /creating-a-pull-request-from-a-fork %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.16" -->
|
||||
{% link_in_list /changing-the-stage-of-a-pull-request %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /requesting-a-pull-request-review %}
|
||||
{% link_in_list /changing-the-base-branch-of-a-pull-request %}
|
||||
{% link_in_list /committing-changes-to-a-pull-request-branch-created-from-a-fork %}
|
||||
@@ -52,15 +48,11 @@ versions:
|
||||
{% topic_link_in_list /reviewing-changes-in-pull-requests %}
|
||||
{% link_in_list /about-pull-request-reviews %}
|
||||
{% link_in_list /reviewing-proposed-changes-in-a-pull-request %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.15" -->
|
||||
{% link_in_list /filtering-files-in-a-pull-request %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /finding-changed-methods-and-functions-in-a-pull-request %}
|
||||
{% link_in_list /commenting-on-a-pull-request %}
|
||||
{% link_in_list /viewing-a-pull-request-review %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.16" -->
|
||||
{% link_in_list /incorporating-feedback-in-your-pull-request %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /approving-a-pull-request-with-required-reviews %}
|
||||
{% link_in_list /dismissing-a-pull-request-review %}
|
||||
{% link_in_list /checking-out-pull-requests-locally %}
|
||||
|
||||
@@ -16,14 +16,20 @@ versions:
|
||||
|
||||
When you delete a private repository, all of its private forks are also deleted.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
#### Deleting a public repository
|
||||
|
||||
When you delete a public repository, one of the existing public forks is chosen to be the new parent repository. All other repositories are forked off of this new parent and subsequent pull requests go to this new parent.
|
||||
|
||||
{% endif %}
|
||||
|
||||
#### Private forks and permissions
|
||||
|
||||
{% data reusables.repositories.private_forks_inherit_permissions %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
#### Changing a public repository to a private repository
|
||||
|
||||
If a public repository is made private, its public forks are split off into a new network. As with deleting a public repository, one of the existing public forks is chosen to be the new parent repository and all other repositories are forked off of this new parent. Subsequent pull requests go to this new parent.
|
||||
@@ -46,9 +52,30 @@ If a private repository is made public, each of its private forks is turned into
|
||||
|
||||
If a private repository is made public and then deleted, its private forks will continue to exist as standalone private repositories in separate networks.
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
|
||||
|
||||
#### Changing the visibility of an internal repository
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** {% data reusables.gated-features.internal-repos %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
If the policy for your enterprise permits forking, any fork of an internal repository will be private. If you change the visibility of an internal repository, any fork owned by an organization or user account will remain private.
|
||||
|
||||
##### Deleting the internal repository
|
||||
|
||||
If you change the visibility of an internal repository and then delete the repository, the forks will continue to exist in a separate network.
|
||||
|
||||
{% endif %}
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Setting repository visibility](/articles/setting-repository-visibility)"
|
||||
- "[About forks](/articles/about-forks)"
|
||||
- "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)"
|
||||
- "[Managing the forking policy for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization)"
|
||||
- "{% if currentVersion == "free-pro-team@latest" %}[Enforcing repository management policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account#enforcing-a-policy-on-forking-private-or-internal-repositories){% else %}[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-forking-private-or-internal-repositories){% endif %}"
|
||||
|
||||
@@ -31,7 +31,7 @@ For more information, see "[Setting your commit email address](/articles/setting
|
||||
|
||||
### Creating co-authored commits using {% data variables.product.prodname_desktop %}
|
||||
|
||||
You can use {% data variables.product.prodname_desktop %} to create a commit with a co-author. For more information, see "[Write a commit message and push your changes](/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project#3-write-a-commit-message-and-push-your-changes)" and [{% data variables.product.prodname_desktop %}](https://desktop.github.com).
|
||||
You can use {% data variables.product.prodname_desktop %} to create a commit with a co-author. For more information, see "[Write a commit message and push your changes](/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project#4-write-a-commit-message-and-push-your-changes)" and [{% data variables.product.prodname_desktop %}](https://desktop.github.com).
|
||||
|
||||
|
||||
|
||||
@@ -75,4 +75,4 @@ The new commit and message will appear on {% data variables.product.product_loca
|
||||
- "[Viewing a summary of repository activity](/articles/viewing-a-summary-of-repository-activity)"
|
||||
- "[Viewing a project's contributors](/articles/viewing-a-projects-contributors)"
|
||||
- "[Changing a commit message](/articles/changing-a-commit-message)"
|
||||
- "[Committing and reviewing changes to your project](/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project#3-write-a-commit-message-and-push-your-changes)" in the {% data variables.product.prodname_desktop %} documentation
|
||||
- "[Committing and reviewing changes to your project](/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project#4-write-a-commit-message-and-push-your-changes)" in the {% data variables.product.prodname_desktop %} documentation
|
||||
|
||||
@@ -16,9 +16,7 @@ versions:
|
||||
{% topic_link_in_list /creating-and-editing-commits %}
|
||||
{% link_in_list /about-commits %}
|
||||
{% link_in_list /creating-a-commit-with-multiple-authors %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /creating-a-commit-on-behalf-of-an-organization %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /changing-a-commit-message %}
|
||||
{% topic_link_in_list /viewing-and-comparing-commits %}
|
||||
{% link_in_list /commit-branch-and-tag-labels %}
|
||||
|
||||
@@ -11,7 +11,11 @@ versions:
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
A README file, along with {% if currentVersion == "free-pro-team@latest" %}a [repository license](/articles/licensing-a-repository), [contribution guidelines](/articles/setting-guidelines-for-repository-contributors), and a [code of conduct](/articles/adding-a-code-of-conduct-to-your-project){% else %}a [repository license](/articles/licensing-a-repository) and [contribution guidelines](/articles/setting-guidelines-for-repository-contributors){% endif %}, helps you communicate expectations for and manage contributions to your project.
|
||||
### About READMEs
|
||||
|
||||
You can add a README file to a repository to communicate important information about your project. A README, along with a repository license{% if currentVersion == "free-pro-team@latest" %}, contribution guidelines, and a code of conduct{% elsif enterpriseServerVersions contains currentVersion %} and contribution guidelines{% endif %}, communicates expectations for your project and helps you manage contributions.
|
||||
|
||||
For more information about providing guidelines for your project, see {% if currentVersion == "free-pro-team@latest" %}"[Adding a code of conduct to your project](/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project)" and {% endif %}"[Setting up your project for healthy contributions](/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions)."
|
||||
|
||||
A README is often the first item a visitor will see when visiting your repository. README files typically include information on:
|
||||
- What the project does
|
||||
@@ -26,8 +30,12 @@ If you put your README file in your repository's root, `docs`, or hidden `.githu
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21"%}
|
||||
|
||||
{% data reusables.profile.profile-readme %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -10,7 +10,7 @@ versions:
|
||||
---
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
To download an archive of your repository, you can use the API for user or organization migrations. For more information, see "[Migrations](/v3/migrations/)."
|
||||
To download an archive of your repository, you can use the API for user or organization migrations. For more information, see "[Migrations](/rest/reference/migrations)."
|
||||
{% else %}
|
||||
|
||||
You can download and back up your repositories manually:
|
||||
@@ -20,15 +20,15 @@ You can download and back up your repositories manually:
|
||||
|
||||
When you clone a repository or wiki, only Git data, such as project files and commit history, is downloaded. You can use our API to export other elements of your {% data variables.product.product_name %} repository to your local machine:
|
||||
|
||||
- [Issues](/v3/issues/#list-issues-for-a-repository)
|
||||
- [Pull requests](/v3/pulls/#list-pull-requests)
|
||||
- [Issues](/rest/reference/issues#list-issues-for-a-repository)
|
||||
- [Pull requests](/rest/reference/pulls#list-pull-requests)
|
||||
- [Forks](/rest/reference/repos#list-forks)
|
||||
- [Comments](/rest/reference/issues#list-issue-comments-for-a-repository)
|
||||
- [Milestones](/rest/reference/issues#list-milestones)
|
||||
- [Labels](/rest/reference/issues#list-labels-for-a-repository)
|
||||
- [Watchers](/rest/reference/activity#list-watchers)
|
||||
- [Stargazers](/rest/reference/activity#list-stargazers)
|
||||
- [Projects](/v3/projects/#list-repository-projects)
|
||||
- [Projects](/rest/reference/projects#list-repository-projects)
|
||||
{% endif %}
|
||||
|
||||
Once you have {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}a local version of all the content you want to back up, you can create a zip archive and {% else %}downloaded your archive, you can {% endif %}copy it to an external hard drive and/or upload it to a cloud-based backup service such as [Google Drive](https://www.google.com/drive/) or [Dropbox](https://www.dropbox.com/).
|
||||
|
||||
@@ -18,16 +18,12 @@ versions:
|
||||
{% link_in_list /about-repositories %}
|
||||
{% link_in_list /about-repository-visibility %}
|
||||
{% link_in_list /creating-a-new-repository %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.17" -->
|
||||
{% link_in_list /creating-a-repository-from-a-template %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /about-readmes %}
|
||||
{% link_in_list /about-code-owners %}
|
||||
{% link_in_list /about-repository-languages %}
|
||||
{% link_in_list /licensing-a-repository %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.17" -->
|
||||
{% link_in_list /creating-a-template-repository %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /creating-an-issues-only-repository %}
|
||||
{% link_in_list /limits-for-viewing-content-and-diffs-in-a-repository %}
|
||||
{% link_in_list /duplicating-a-repository %}
|
||||
@@ -39,8 +35,6 @@ versions:
|
||||
{% topic_link_in_list /archiving-a-github-repository %}
|
||||
{% link_in_list /about-archiving-repositories %}
|
||||
{% link_in_list /archiving-repositories %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /about-archiving-content-and-data-on-github %}
|
||||
{% link_in_list /referencing-and-citing-content %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /backing-up-a-repository %}
|
||||
|
||||
@@ -7,7 +7,6 @@ redirect_from:
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
### Choosing the right license
|
||||
@@ -18,7 +17,7 @@ You're under no obligation to choose a license. However, without a license, the
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** If you publish your source code in a public repository on GitHub, {% if currentVersion == "free-pro-team@latest" %}according to the [Terms of Service](/articles/github-terms-of-service), {% endif %}other GitHub users have the right to view and fork your repository within the GitHub site. If you have already created a public repository and no longer want users to have access to it, you can make your repository private. When you convert a public repository to a private repository, existing forks or local copies created by other users will still exist. For more information, see "[Making a public repository private](/articles/making-a-public-repository-private)."
|
||||
**Note:** If you publish your source code in a public repository on {% data variables.product.product_name %}, {% if currentVersion == "free-pro-team@latest" %}according to the [Terms of Service](/articles/github-terms-of-service), {% endif %}other users of {% data variables.product.product_location %} have the right to view and fork your repository. If you have already created a repository and no longer want users to have access to the repository, you can make the repository private. When you change the visibility of a repository to private, existing forks or local copies created by other users will still exist. For more information, see "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
@@ -75,7 +74,7 @@ When you search by a family license, your results will include all licenses in t
|
||||
|
||||
### Detecting a license
|
||||
|
||||
[The open source Ruby gem Licensee](https://github.com/benbalter/licensee) compares the repository's *LICENSE* file to a short list of known licenses. Licensee also provides the [Licenses API](/v3/licenses/) and [gives us insight into how repositories on {% data variables.product.product_name %} are licensed](https://github.com/blog/1964-open-source-license-usage-on-github-com). If your repository is using a license that isn't listed on the [Choose a License website](http://choosealicense.com/appendix/), you can [request including the license](https://github.com/github/choosealicense.com/blob/gh-pages/CONTRIBUTING.md#adding-a-license).
|
||||
[The open source Ruby gem Licensee](https://github.com/benbalter/licensee) compares the repository's *LICENSE* file to a short list of known licenses. Licensee also provides the [Licenses API](/rest/reference/licenses) and [gives us insight into how repositories on {% data variables.product.product_name %} are licensed](https://github.com/blog/1964-open-source-license-usage-on-github-com). If your repository is using a license that isn't listed on the [Choose a License website](http://choosealicense.com/appendix/), you can [request including the license](https://github.com/github/choosealicense.com/blob/gh-pages/CONTRIBUTING.md#adding-a-license).
|
||||
|
||||
If your repository is using a license that is listed on the Choose a License website and it's not displaying clearly at the top of the repository page, it may contain multiple licenses or other complexity. To have your license detected, simplify your *LICENSE* file and note the complexity somewhere else, such as your repository's *README* file.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Using Codespaces in Visual Studio Code
|
||||
intro: 'You can develop in your codespace directly in {% data variables.product.prodname_vscode %} by connecting the {% data variables.product.prodname_vs_codespaces %} extension with your account on {% data variables.product.product_name %}.'
|
||||
intro: 'You can develop in your codespace directly in {% data variables.product.prodname_vscode %} by connecting the {% data variables.product.prodname_github_codespaces %} extension with your account on {% data variables.product.product_name %}.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
redirect_from:
|
||||
- /github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code
|
||||
@@ -12,22 +12,16 @@ versions:
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before you can develop in a codespace directly in {% data variables.product.prodname_vscode %}, you must configure the {% data variables.product.prodname_vs_codespaces %} extension to connect to your {% data variables.product.product_name %} account.
|
||||
To develop in a codespace directly in {% data variables.product.prodname_vscode %}, you must sign into the {% data variables.product.prodname_github_codespaces %} extension. The {% data variables.product.prodname_github_codespaces %} extension requires {% data variables.product.prodname_vscode %} October 2020 Release 1.51 or later.
|
||||
|
||||
1. Use the {% data variables.product.prodname_vs %} Marketplace to install the [{% data variables.product.prodname_vs_codespaces %}](https://marketplace.visualstudio.com/items?itemName=ms-vsonline.vsonline) extension. For more information, see [Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery) in the {% data variables.product.prodname_vscode %} documentation.
|
||||
2. In {% data variables.product.prodname_vscode %}, in the left sidebar, click the Extensions icon.
|
||||
|
||||
3. Below {% data variables.product.prodname_vs_codespaces %}, click the Manage icon, then click **Extension Settings**.
|
||||
|
||||
4. Use the Codespaces: Account Provider drop-down menu, and click **{% data variables.product.prodname_dotcom %}**.
|
||||
|
||||
1. Use the {% data variables.product.prodname_vs %} Marketplace to install the [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension. For more information, see [Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery) in the {% data variables.product.prodname_vscode %} documentation.
|
||||
{% data reusables.codespaces.click-remote-explorer-icon-vscode %}
|
||||
6. If {% data variables.product.prodname_codespaces %} is not already selected in the header, click **{% data variables.product.prodname_codespaces %}**.
|
||||
2. Use the "REMOTE EXPLORER" drop-down, then click **{% data variables.product.prodname_github_codespaces %}**.
|
||||
|
||||
7. Click **Sign in to view {% data variables.product.prodname_codespaces %}...**.
|
||||
3. Click **Sign in to view {% data variables.product.prodname_codespaces %}...**.
|
||||
|
||||
8. To authorize {% data variables.product.prodname_vscode %} to access your account on {% data variables.product.product_name %}, click **Allow**.
|
||||
9. Sign in to {% data variables.product.product_name %} to approve the extension.
|
||||
4. To authorize {% data variables.product.prodname_vscode %} to access your account on {% data variables.product.product_name %}, click **Allow**.
|
||||
5. Sign in to {% data variables.product.product_name %} to approve the extension.
|
||||
|
||||
### Creating a codespace in {% data variables.product.prodname_vscode %}
|
||||
|
||||
@@ -38,9 +32,10 @@ After you connect your {% data variables.product.product_name %} account to the
|
||||
|
||||
3. Type, then click the repository's name you want to develop in.
|
||||
|
||||
4. Click the branch you want to develop in.
|
||||
4. Click the branch you want to develop on.
|
||||
|
||||
|
||||
5. Click the instance type you want to develop in.
|
||||
|
||||
### Opening a codespace in {% data variables.product.prodname_vscode %}
|
||||
|
||||
{% data reusables.codespaces.click-remote-explorer-icon-vscode %}
|
||||
|
||||
@@ -53,8 +53,12 @@ Connecting to {% data variables.product.prodname_github_codespaces %} with the
|
||||
|
||||
### Configuring a codespace for {% data variables.product.prodname_vs %}
|
||||
|
||||
The default codespace environment created by {% data variables.product.prodname_vs %} includes popular frameworks and tools such as .NET Core, Microsoft SQL Server, Python, and the Windows SDK. {% data variables.product.prodname_github_codespaces %} created with {% data variables.product.prodname_vs %} can be customized through a subset of `devcontainers.json` properties and a new tool called devinit, included with {% data variables.product.prodname_vs %}.
|
||||
A codespace, created with {% data variables.product.prodname_vs %}, can be customized through a new tool called devinit, a command line tool included with {% data variables.product.prodname_vs %}.
|
||||
|
||||
#### devinit
|
||||
|
||||
The [devinit](https://docs.microsoft.com/visualstudio/devinit/getting-started-with-devinit) command-line tool lets you install additional frameworks and tools into your Windows development codespaces, as well as run PowerShell scripts or modify environment variables. devinit supports a configuration file called [devinit.json](https://docs.microsoft.com/visualstudio/devinit/devinit-json), which can be added to your project for creating customized and repeatable development environments. For more information about Windows codespace configuration and devinit, see [Customize a codespace](https://docs.microsoft.com/visualstudio/ide/codespaces/customize-codespaces) in the {% data variables.product.prodname_vs %} documentation.
|
||||
[devinit](https://docs.microsoft.com/visualstudio/devinit/getting-started-with-devinit) lets you install additional frameworks and tools into your Windows development codespaces, modify environment variables, and more.
|
||||
|
||||
devinit supports a configuration file called [devinit.json](https://docs.microsoft.com/visualstudio/devinit/devinit-json). You can add this file to your project if you want to create a customized and repeatable development environment. When you use devinit with a [devcontainer.json](https://docs.microsoft.com/visualstudio/ide/codespaces/customize-codespaces#running-devinit-when-creating-a-codespace) file, your codespaces will be automatically configured on creation.
|
||||
|
||||
For more information about Windows codespace configuration and devinit, see [Customize a codespace](https://docs.microsoft.com/visualstudio/ide/codespaces/customize-codespaces) in the {% data variables.product.prodname_vs %} documentation. For more information about devinit, see [Getting started with devinit](https://docs.microsoft.com/visualstudio/devinit/getting-started-with-devinit).
|
||||
|
||||
@@ -43,4 +43,4 @@ To avoid these prompts, you can use Git password caching. For information, see "
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Authorizing OAuth Apps](/v3/oauth/)"
|
||||
- "[Authorizing OAuth Apps](/developers/apps/authorizing-oauth-apps)"
|
||||
|
||||
@@ -21,7 +21,7 @@ You can use {% data variables.product.prodname_code_scanning %} to find, triage,
|
||||
If {% data variables.product.prodname_code_scanning %} finds a potential vulnerability or error in your code, {% data variables.product.prodname_dotcom %} displays an alert in the repository. After you fix the code that triggered the alert, {% data variables.product.prodname_dotcom %} closes the alert. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository)."
|
||||
|
||||
To monitor results from {% data variables.product.prodname_code_scanning %} across your repositories or your organization, you can use the {% data variables.product.prodname_code_scanning %} API.
|
||||
For more information about API endpoints, see "[{% data variables.product.prodname_code_scanning_capc %}](/v3/code-scanning)."
|
||||
For more information about API endpoints, see "[{% data variables.product.prodname_code_scanning_capc %}](/rest/reference/code-scanning)."
|
||||
|
||||
To get started with {% data variables.product.prodname_code_scanning %}, see "[Enabling {% data variables.product.prodname_code_scanning %} for a repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/enabling-code-scanning-for-a-repository)."
|
||||
|
||||
|
||||
@@ -52,6 +52,32 @@ The default {% data variables.product.prodname_codeql_workflow %} uses the `pull
|
||||
|
||||
For more information about the `pull_request` event, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestbranchestags)."
|
||||
|
||||
#### Avoiding unnecessary scans of pull requests
|
||||
|
||||
You might want to avoid a code scan being triggered on specific pull requests targeted against the default branch, irrespective of which files have been changed. You can configure this by specifying `on:pull_request:paths-ignore` or `on:pull_request:paths` in the {% data variables.product.prodname_code_scanning %} workflow. For example, if the only changes in a pull request are to files with the file extensions `.md` or `.txt` you can use the following `paths-ignore` array.
|
||||
|
||||
``` yaml
|
||||
on:
|
||||
push:
|
||||
branches: [main, protected]
|
||||
pull_request:
|
||||
branches: [main]
|
||||
paths-ignore:
|
||||
- '**/*.md'
|
||||
- '**/*.txt'
|
||||
```
|
||||
|
||||
{% note %}
|
||||
|
||||
**Notes**
|
||||
|
||||
* `on:pull_request:paths-ignore` and `on:pull_request:paths` set conditions that determine whether the actions in the workflow will run on a pull request. They don't determine what files will be analyzed when the actions _are_ run. When a pull request contains any files that are not matched by `on:pull_request:paths-ignore` or `on:pull_request:paths`, the workflow runs the actions and scans all of the files changed in the pull request, including those matched by `on:pull_request:paths-ignore` or `on:pull_request:paths`, unless the files have been excluded. For information on how to exclude files from analysis, see "[Specifying directories to scan](#specifying-directories-to-scan)."
|
||||
* For {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} workflow files, don't use the `paths-ignore` or `paths` keywords with the `on:push` event as this is likely to cause missing analyses. For accurate results, {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} needs to be able to compare new changes with the analysis of the previous commit.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
For more information about using `on:pull_request:paths-ignore` and `on:pull_request:paths` to determine when a workflow will run for a pull request, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)."
|
||||
|
||||
#### Scanning on a schedule
|
||||
|
||||
If you use the default {% data variables.product.prodname_codeql_workflow %}, the workflow will scan the code in your repository once a week, in addition to the scans triggered by events. To adjust this schedule, edit the `cron` value in the workflow. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onschedule)."
|
||||
@@ -162,7 +188,7 @@ jobs:
|
||||
fi
|
||||
# Set the `CODEQL-PYTHON` environment variable to the Python executable
|
||||
# that includes the dependencies
|
||||
echo "::set-env name=CODEQL_PYTHON::$(which python)"
|
||||
echo "CODEQL_PYTHON=$(which python)" >> $GITHUB_ENV
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@v1
|
||||
with:
|
||||
@@ -235,13 +261,13 @@ If you only want to run custom queries, you can disable the default security que
|
||||
|
||||
#### Specifying directories to scan
|
||||
|
||||
For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python and JavaScript/TypeScript), you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. You can exclude the files in specific directories from scans by adding a `paths-ignore` array.
|
||||
For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python and JavaScript/TypeScript), you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. You can exclude the files in specific directories from analysis by adding a `paths-ignore` array.
|
||||
|
||||
``` yaml
|
||||
paths:
|
||||
paths:
|
||||
- src
|
||||
paths-ignore:
|
||||
- node_modules
|
||||
- src/node_modules
|
||||
- '**/*.test.js'
|
||||
```
|
||||
|
||||
@@ -254,7 +280,7 @@ paths-ignore:
|
||||
|
||||
{% endnote %}
|
||||
|
||||
For C/C++, C#, and Java, if you want to limit {% data variables.product.prodname_code_scanning %} to specific directories in your project, you must specify appropriate build steps in the workflow. The commands you need to use to exclude a directory from the build will depend on your build system. For more information, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)."
|
||||
For compiled languages, if you want to limit {% data variables.product.prodname_code_scanning %} to specific directories in your project, you must specify appropriate build steps in the workflow. The commands you need to use to exclude a directory from the build will depend on your build system. For more information, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)."
|
||||
|
||||
You can quickly analyze small portions of a monorepo when you modify code in specific directories. You'll need to both exclude directories in your build steps and use the `paths-ignore` and `paths` keywords for [`on.<push|pull_request>`](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths) in your workflow.
|
||||
|
||||
|
||||
@@ -97,7 +97,7 @@ If the `autobuild` command can't build your code, you can run the build steps yo
|
||||
|
||||
By default, the {% data variables.product.prodname_codeql_runner %} uploads results from {% data variables.product.prodname_code_scanning %} when you run the `analyze` command. You can also upload SARIF files separately, by using the `upload` command.
|
||||
|
||||
Once you've uploaded the data, {% data variables.product.prodname_dotcom %} displays the alerts in your repository. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-an-alert)."
|
||||
Once you've uploaded the data, {% data variables.product.prodname_dotcom %} displays the alerts in your repository. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)."
|
||||
|
||||
### {% data variables.product.prodname_codeql_runner %} command reference
|
||||
|
||||
|
||||
@@ -62,7 +62,7 @@ After enabling {% data variables.product.prodname_code_scanning %} for your repo
|
||||
|
||||
1. Review the logging output from the actions in this workflow as they run.
|
||||
|
||||
1. Once all jobs are complete, you can view the details of any {% data variables.product.prodname_code_scanning %} alerts that were identified. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-an-alert)."
|
||||
1. Once all jobs are complete, you can view the details of any {% data variables.product.prodname_code_scanning %} alerts that were identified. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)."
|
||||
|
||||
{% note %}
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Managing code scanning alerts for your repository
|
||||
shortTitle: Managing alerts
|
||||
intro: 'You can view, fix, {% if currentVersion == "enterprise-server@2.22" %}or close{% else %}dismiss, or delete{% endif %} alerts for potential vulnerabilities or errors in your project''s code.'
|
||||
intro: 'From the security view, you can view, fix, {% if currentVersion == "enterprise-server@2.22" %}or close{% else %}dismiss, or delete{% endif %} alerts for potential vulnerabilities or errors in your project''s code.'
|
||||
product: '{% data reusables.gated-features.code-scanning %}'
|
||||
permissions: 'If you have write permission to a repository you can manage {% data variables.product.prodname_code_scanning %} alerts for that repository.'
|
||||
versions:
|
||||
@@ -30,9 +30,11 @@ If you enable {% data variables.product.prodname_code_scanning %} using {% data
|
||||
|
||||
When {% data variables.product.prodname_code_scanning %} reports data-flow alerts, {% data variables.product.prodname_dotcom %} shows you how data moves through the code. {% data variables.product.prodname_code_scanning_capc %} allows you to identify the areas of your code that leak sensitive information, and that could be the entry point for attacks by malicious users.
|
||||
|
||||
### Viewing an alert
|
||||
### Viewing the alerts for a repository
|
||||
|
||||
Anyone with read permission for a repository can see {% data variables.product.prodname_code_scanning %} alerts on pull requests. However, you need write permission to view a summary of alerts for repository on the **Security** tab. By default, alerts are shown for the default branch.
|
||||
Anyone with read permission for a repository can see {% data variables.product.prodname_code_scanning %} annotations on pull requests. For more information, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)."
|
||||
|
||||
You need write permission to view a summary of all the alerts for a repository on the **Security** tab. By default, alerts are shown for the default branch.
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-security %}
|
||||
@@ -48,7 +50,7 @@ Anyone with read permission for a repository can see {% data variables.product.p
|
||||
|
||||
Anyone with write permission for a repository can fix an alert by committing a correction to the code. If the repository has {% data variables.product.prodname_code_scanning %} scheduled to run on pull requests, it's best to raise a pull request with your correction. This will trigger {% data variables.product.prodname_code_scanning %} analysis of the changes and test that your fix doesn't introduce any new problems. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning)" and "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)."
|
||||
|
||||
If you have write permission for a repository, you can view fixed alerts by viewing the summary of alerts and clicking **Closed**. For more information, see "[Viewing an alert](#viewing-an-alert)." The "Closed" list shows fixed alerts and alerts that users have {% if currentVersion == "enterprise-server@2.22" %}closed{% else %}dismissed{% endif %}.
|
||||
If you have write permission for a repository, you can view fixed alerts by viewing the summary of alerts and clicking **Closed**. For more information, see "[Viewing the alerts for a repository](#viewing-the-alerts-for-a-repository)." The "Closed" list shows fixed alerts and alerts that users have {% if currentVersion == "enterprise-server@2.22" %}closed{% else %}dismissed{% endif %}.
|
||||
|
||||
Alerts may be fixed in one branch but not in another. You can use the "Branch" drop-down menu, on the summary of alerts, to check whether an alert is fixed in a particular branch.
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ You must run {% data variables.product.prodname_codeql %} in the same container
|
||||
You may have difficulty running {% data variables.product.prodname_code_scanning %} if the container you're using is missing certain dependencies (for example, Git must be installed and added to the PATH variable). If you encounter dependency issues, review the list of software typically included on {% data variables.product.prodname_dotcom %}'s virtual environments. For more information, see the version-specific `readme` files in these locations:
|
||||
|
||||
* Linux: https://github.com/actions/virtual-environments/tree/main/images/linux
|
||||
* MacOS: https://github.com/actions/virtual-environments/tree/main/images/macos
|
||||
* macOS: https://github.com/actions/virtual-environments/tree/main/images/macos
|
||||
* Windows: https://github.com/actions/virtual-environments/tree/main/images/win
|
||||
|
||||
### Example workflow
|
||||
|
||||
@@ -39,7 +39,7 @@ On Linux:
|
||||
chmod +x codeql-runner-linux
|
||||
```
|
||||
|
||||
On MacOS:
|
||||
On macOS:
|
||||
|
||||
```shell
|
||||
chmod +x codeql-runner-macos
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Triaging code scanning alerts in pull requests
|
||||
shortTitle: Triaging alerts in pull requests
|
||||
intro: 'When {% data variables.product.prodname_code_scanning %} identifies a problem in a pull request, you can review the highlighted code and resolve the alert.'
|
||||
product: '{% data reusables.gated-features.code-scanning %}'
|
||||
permissions: 'If you have write permission to a repository, you can resolve {% data variables.product.prodname_code_scanning %} alerts for that repository.'
|
||||
permissions: 'If you have read permission for a repository, you can see annotations on pull requests. With write permission, you can see detailed information and resolve {% data variables.product.prodname_code_scanning %} alerts for that repository.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=2.22'
|
||||
@@ -31,9 +31,9 @@ When you look at the **Files changed** tab for a pull request, you see annotatio
|
||||
|
||||
|
||||
|
||||
Some annotations contain links with extra context for the alert. In the example above, from {% data variables.product.prodname_codeql %} analysis, you can click **user-provided value** to see where the untrusted data enters the data flow (this is referred to as the source). In this case you can view the full path from the source to the code that uses the data (the sink) by clicking **Show paths**. This makes it easy to check whether the data is untrusted or if the analysis failed to recognize a data sanitization step between the source and the sink. For information about analyzing data flow using {% data variables.product.prodname_codeql %}, see "[About data flow analysis](https://help.semmle.com/QL/learn-ql/intro-to-data-flow.html)."
|
||||
If you have write permission for the repository, some annotations contain links with extra context for the alert. In the example above, from {% data variables.product.prodname_codeql %} analysis, you can click **user-provided value** to see where the untrusted data enters the data flow (this is referred to as the source). In this case you can also view the full path from the source to the code that uses the data (the sink) by clicking **Show paths**. This makes it easy to check whether the data is untrusted or if the analysis failed to recognize a data sanitization step between the source and the sink. For information about analyzing data flow using {% data variables.product.prodname_codeql %}, see "[About data flow analysis](https://help.semmle.com/QL/learn-ql/intro-to-data-flow.html)."
|
||||
|
||||
For more information about an alert, click **Show more details** on the annotation. This allows you to see all of the context and metadata provided by the tool in an alert view. In the example below, you can see tags showing the severity, type, and relevant common weakness enumerations (CWEs) for the problem. The view also shows which commit introduced the problem.
|
||||
To see more information about an alert, users with write permission can click the **Show more details** link shown in the annotation. This allows you to see all of the context and metadata provided by the tool in an alert view. In the example below, you can see tags showing the severity, type, and relevant common weakness enumerations (CWEs) for the problem. The view also shows which commit introduced the problem.
|
||||
|
||||
In the detailed view for an alert, some {% data variables.product.prodname_code_scanning %} tools, like {% data variables.product.prodname_codeql %} analysis, also include a description of the problem and a **Show more** link for guidance on how to fix your code.
|
||||
|
||||
@@ -41,11 +41,11 @@ In the detailed view for an alert, some {% data variables.product.prodname_code_
|
||||
|
||||
### {% if currentVersion == "enterprise-server@2.22" %}Resolving{% else %}Fixing{% endif %} an alert on your pull request
|
||||
|
||||
Anyone with write permission for a repository can fix a {% data variables.product.prodname_code_scanning %} alert that's identified on a pull request. If you commit changes to the pull request this triggers a new run of the pull request checks. If your changes fix the problem, the alert is closed and the annotation removed.
|
||||
Anyone with push access to a pull request can fix a {% data variables.product.prodname_code_scanning %} alert that's identified on that pull request. If you commit changes to the pull request this triggers a new run of the pull request checks. If your changes fix the problem, the alert is closed and the annotation removed.
|
||||
|
||||
{% if currentVersion == "enterprise-server@2.22" %}
|
||||
|
||||
If you don't think that an alert needs to be fixed, you can close the alert manually. {% data reusables.code-scanning.close-alert-examples %} The **Close** button is available in annotations and in the alerts view if you have write permission for the repository.
|
||||
If you don't think that an alert needs to be fixed, users with write permission can close the alert manually. {% data reusables.code-scanning.close-alert-examples %} The **Close** button is available in annotations and in the alerts view if you have write permission for the repository.
|
||||
|
||||
{% data reusables.code-scanning.false-positive-fix-codeql %}
|
||||
|
||||
@@ -63,4 +63,4 @@ An alternative way of closing an alert is to dismiss it. You can dismiss an aler
|
||||
|
||||
For more information about dismissing alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#dismissing-or-deleting-alerts)."
|
||||
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
@@ -66,7 +66,7 @@ For more information, see the workflow extract in "[Automatic build for a compil
|
||||
* Building using a distributed build system external to GitHub Actions, using a daemon process.
|
||||
* {% data variables.product.prodname_codeql %} isn't aware of the specific compiler you are using.
|
||||
|
||||
For C# projects using either `dotnet build` or `msbuild` which target .NET Core 2, you should specify `/p:UseSharedCompilation=false` in your workflow's `run` step, when you build your code. The `UseSharedCompilation` flag isn't necessary for .NET Core 3.0 and later.
|
||||
For .NET Framework projects, and for C# projects using either `dotnet build` or `msbuild` that target .NET Core 2, you should specify `/p:UseSharedCompilation=false` in your workflow's `run` step, when you build your code. The `UseSharedCompilation` flag isn't necessary for .NET Core 3.0 and later.
|
||||
|
||||
For example, the following configuration for C# will pass the flag during the first build step.
|
||||
|
||||
|
||||
@@ -10,14 +10,26 @@ versions:
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
You can store a variety of projects in {% data variables.product.product_name %} repositories, including open source projects. With [open source projects](http://opensource.org/about), you can share code to make better, more reliable software.
|
||||
|
||||
{% elsif enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
|
||||
|
||||
You can store a variety of projects in {% data variables.product.product_name %} repositories, including innersource projects. With innersource, you can share code to make better, more reliable software. For more information on innersource, see {% data variables.product.company_short %}'s whitepaper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** You can create public repositories for an open source project. When creating your public repository, make sure to include a [license file](http://choosealicense.com/) that determines how you want your project to be shared with others. {% data reusables.open-source.open-source-guide-repositories %} {% data reusables.open-source.open-source-learning-lab %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.repositories.create_new %}
|
||||
2. Type a short, memorable name for your repository. For example, "hello-world".
|
||||
|
||||
|
||||
@@ -21,7 +21,6 @@ versions:
|
||||
|
||||
You can see a list of features that are available in beta and a brief description for each feature. Each feature includes a link to give feedback.
|
||||
|
||||
1. In the upper-right corner of any page, click your profile photo, then click **Feature preview**.
|
||||
|
||||
{% data reusables.feature-preview.feature-preview-setting %}
|
||||
2. Optionally, to the right of a feature, click **Enable** or **Disable**.
|
||||
|
||||
|
||||
@@ -25,10 +25,16 @@ For example, you can use forks to propose changes related to fixing a bug. Rathe
|
||||
|
||||
Open source software is based on the idea that by sharing code, we can make better, more reliable software. For more information, see the "[About the Open Source Initiative](http://opensource.org/about)" on the Open Source Initiative.
|
||||
|
||||
For more information about applying open source principles to your organization's development work on {% data variables.product.product_location %}, see {% data variables.product.prodname_dotcom %}'s whitepaper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)."
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
When creating your public repository from a fork of someone's project, make sure to include a license file that determines how you want your project to be shared with others. For more information, see "[Choose an open source license](http://choosealicense.com/)" at choosealicense.
|
||||
|
||||
{% data reusables.open-source.open-source-guide-repositories %} {% data reusables.open-source.open-source-learning-lab %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: {% data reusables.repositories.desktop-fork %}
|
||||
|
||||
@@ -27,37 +27,27 @@ versions:
|
||||
{% link_in_list /fork-a-repo %}
|
||||
{% link_in_list /be-social %}
|
||||
{% topic_link_in_list /learning-about-github %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /githubs-products %}
|
||||
{% link_in_list /exploring-early-access-releases-with-feature-preview %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /types-of-github-accounts %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /faq-about-changes-to-githubs-plans %}
|
||||
{% link_in_list /github-cli %}
|
||||
{% link_in_list /github-desktop %}
|
||||
{% link_in_list /github-for-mobile %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /access-permissions-on-github %}
|
||||
{% link_in_list /github-glossary %}
|
||||
{% link_in_list /git-cheatsheet %}
|
||||
{% link_in_list /git-and-github-learning-resources %}
|
||||
{% topic_link_in_list /signing-up-for-github %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /signing-up-for-a-new-github-account %}
|
||||
{% link_in_list /verifying-your-email-address %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /setting-up-a-trial-of-github-enterprise-cloud %}
|
||||
{% link_in_list /setting-up-a-trial-of-github-enterprise-server %}
|
||||
{% topic_link_in_list /exploring-projects-on-github %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /finding-ways-to-contribute-to-open-source-on-github %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /saving-repositories-with-stars %}
|
||||
{% link_in_list /following-people %}
|
||||
{% topic_link_in_list /using-github %}
|
||||
{% link_in_list /supported-browsers %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /troubleshooting-connectivity-problems %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /keyboard-shortcuts %}
|
||||
|
||||
@@ -123,9 +123,9 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|
||||
|<kbd>escape</kbd> | Cancel the move in progress
|
||||
|<kbd>enter</kbd> | Complete the move in progress
|
||||
|<kbd>←</kbd> or <kbd>h</kbd> | Move column to the left
|
||||
|<kbd>command ←</kbd> or <kbd>command h</kbd> or <kbd>control ←</kbd> or <kbd>control h</kbd> | Move column to the leftmost position
|
||||
|<kbd>command + ←</kbd> or <kbd>command + h</kbd> or <kbd>control + ←</kbd> or <kbd>control + h</kbd> | Move column to the leftmost position
|
||||
|<kbd>→</kbd> or <kbd>l</kbd> | Move column to the right
|
||||
|<kbd>command →</kbd> or <kbd>command l</kbd> or <kbd>control →</kbd> or <kbd>control l</kbd> | Move column to the rightmost position
|
||||
|<kbd>command + →</kbd> or <kbd>command + l</kbd> or <kbd>control + →</kbd> or <kbd>control + l</kbd> | Move column to the rightmost position
|
||||
|
||||
#### Moving a card
|
||||
|
||||
@@ -135,17 +135,17 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|
||||
|<kbd>escape</kbd> | Cancel the move in progress
|
||||
|<kbd>enter</kbd> | Complete the move in progress
|
||||
|<kbd>↓</kbd> or <kbd>j</kbd> | Move card down
|
||||
|<kbd>command ↓</kbd> or <kbd>command j</kbd> or <kbd>control ↓</kbd> or <kbd>control j</kbd> | Move card to the bottom of the column
|
||||
|<kbd>command + ↓</kbd> or <kbd>command + j</kbd> or <kbd>control + ↓</kbd> or <kbd>control + j</kbd> | Move card to the bottom of the column
|
||||
|<kbd>↑</kbd> or <kbd>k</kbd> | Move card up
|
||||
|<kbd>command ↑</kbd> or <kbd>command k</kbd> or <kbd>control ↑</kbd> or <kbd>control k</kbd> | Move card to the top of the column
|
||||
|<kbd>command + ↑</kbd> or <kbd>command + k</kbd> or <kbd>control + ↑</kbd> or <kbd>control + k</kbd> | Move card to the top of the column
|
||||
|<kbd>←</kbd> or <kbd>h</kbd> | Move card to the bottom of the column on the left
|
||||
|<kbd>shift ←</kbd> or <kbd>shift h</kbd> | Move card to the top of the column on the left
|
||||
|<kbd>command ←</kbd> or <kbd>command h</kbd> or <kbd>control ←</kbd> or <kbd>control h</kbd> | Move card to the bottom of the leftmost column
|
||||
|<kbd>command shift ←</kbd> or <kbd>command shift h</kbd> or <kbd>control shift ←</kbd> or <kbd>control shift h</kbd> | Move card to the top of the leftmost column
|
||||
|<kbd>shift + ←</kbd> or <kbd>shift + h</kbd> | Move card to the top of the column on the left
|
||||
|<kbd>command + ←</kbd> or <kbd>command + h</kbd> or <kbd>control + ←</kbd> or <kbd>control + h</kbd> | Move card to the bottom of the leftmost column
|
||||
|<kbd>command + shift + ←</kbd> or <kbd>command + shift + h</kbd> or <kbd>control + shift + ←</kbd> or <kbd>control + shift + h</kbd> | Move card to the top of the leftmost column
|
||||
|<kbd>→</kbd> | Move card to the bottom of the column on the right
|
||||
|<kbd>shift →</kbd> or <kbd>shift l</kbd> | Move card to the top of the column on the right
|
||||
|<kbd>command →</kbd> or <kbd>command l</kbd> or <kbd>control →</kbd> or <kbd>control l</kbd> | Move card to the bottom of the rightmost column
|
||||
|<kbd>command shift →</kbd> or <kbd>command shift l</kbd> or <kbd>control shift →</kbd> or <kbd>control shift l</kbd> | Move card to the bottom of the rightmost column
|
||||
|<kbd>shift + →</kbd> or <kbd>shift + l</kbd> | Move card to the top of the column on the right
|
||||
|<kbd>command + →</kbd> or <kbd>command + l</kbd> or <kbd>control + →</kbd> or <kbd>control + l</kbd> | Move card to the bottom of the rightmost column
|
||||
|<kbd>command + shift + →</kbd> or <kbd>command + shift + l</kbd> or <kbd>control + shift + →</kbd> or <kbd>control + shift + l</kbd> | Move card to the bottom of the rightmost column
|
||||
|
||||
#### Previewing a card
|
||||
|
||||
@@ -158,7 +158,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>command space </kbd> or <kbd>control space</kbd> | In the workflow editor, get suggestions for your workflow file.
|
||||
|<kbd>command + space </kbd> or <kbd>control + space</kbd> | In the workflow editor, get suggestions for your workflow file.
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -168,16 +168,16 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>e</kbd> | Mark as done
|
||||
| <kbd>shift u</kbd>| Mark as unread
|
||||
| <kbd>shift i</kbd>| Mark as read
|
||||
| <kbd>shift m</kbd> | Unsubscribe
|
||||
| <kbd>shift + u</kbd>| Mark as unread
|
||||
| <kbd>shift + i</kbd>| Mark as read
|
||||
| <kbd>shift + m</kbd> | Unsubscribe
|
||||
|
||||
{% else %}
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>e</kbd> or <kbd>I</kbd> or <kbd>y</kbd> | Mark as read
|
||||
|<kbd>shift m</kbd> | Mute thread
|
||||
|<kbd>shift + m</kbd> | Mute thread
|
||||
{% endif %}
|
||||
|
||||
### Network graph
|
||||
@@ -188,7 +188,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|
||||
|<kbd>→</kbd> or <kbd>l</kbd> | Scroll right
|
||||
|<kbd>↑</kbd> or <kbd>k</kbd> | Scroll up
|
||||
|<kbd>↓</kbd> or <kbd>j</kbd> | Scroll down
|
||||
|<kbd>shift ←</kbd> or <kbd>shift h</kbd> | Scroll all the way left
|
||||
|<kbd>shift →</kbd> or <kbd>shift l</kbd> | Scroll all the way right
|
||||
|<kbd>shift ↑</kbd> or <kbd>shift k</kbd> | Scroll all the way up
|
||||
|<kbd>shift ↓</kbd> or <kbd>shift j</kbd> | Scroll all the way down
|
||||
|<kbd>shift + ←</kbd> or <kbd>shift + h</kbd> | Scroll all the way left
|
||||
|<kbd>shift + →</kbd> or <kbd>shift + l</kbd> | Scroll all the way right
|
||||
|<kbd>shift + ↑</kbd> or <kbd>shift + k</kbd> | Scroll all the way up
|
||||
|<kbd>shift + ↓</kbd> or <kbd>shift + j</kbd> | Scroll all the way down
|
||||
|
||||
@@ -36,7 +36,7 @@ To get the most out of your trial, follow these steps:
|
||||
- [Quick start guide to {% data variables.product.prodname_dotcom %}](https://resources.github.com/webcasts/Quick-start-guide-to-GitHub/) webcast
|
||||
- [Understanding the {% data variables.product.prodname_dotcom %} flow](https://guides.github.com/introduction/flow/) in {% data variables.product.prodname_dotcom %} Guides
|
||||
- [Hello World](https://guides.github.com/activities/hello-world/) in {% data variables.product.prodname_dotcom %} Guides
|
||||
3. To configure your instance to meet your organization's needs, see "[Configuring your enterprise](/admin/configuration/configuring-your-enterprise)."
|
||||
3. To configure your instance to meet your organization's needs, see "[Configuring your enterprise](/enterprise/admin/configuration/configuring-your-enterprise)."
|
||||
4. To integrate {% data variables.product.prodname_ghe_server %} with your identity provider, see "[Using SAML](/enterprise/admin/user-management/using-saml)" and "[Using LDAP](/enterprise/admin/authentication/using-ldap)."
|
||||
5. Invite an unlimited number of people to join your trial.
|
||||
- Add users to your {% data variables.product.prodname_ghe_server %} instance using built-in authentication or your configured identity provider. For more information, see "[Using built in authentication](/enterprise/admin/user-management/using-built-in-authentication)."
|
||||
|
||||
@@ -15,11 +15,9 @@ versions:
|
||||
### Table of Contents
|
||||
|
||||
{% topic_link_in_list /importing-source-code-to-github %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /about-github-importer %}
|
||||
{% link_in_list /importing-a-repository-with-github-importer %}
|
||||
{% link_in_list /updating-commit-author-attribution-with-github-importer %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /importing-a-git-repository-using-the-command-line %}
|
||||
{% link_in_list /adding-an-existing-project-to-github-using-the-command-line %}
|
||||
{% link_in_list /source-code-migration-tools %}
|
||||
|
||||
@@ -20,24 +20,14 @@ versions:
|
||||
{% link_in_list /authenticating-to-github %}
|
||||
|
||||
<!-- Notifications v2 beta -->
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /managing-subscriptions-and-notifications-on-github %}
|
||||
<!-- endif -->
|
||||
|
||||
<!-- Notifications v1 -->
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.15" -->
|
||||
{% link_in_list /receiving-notifications-about-activity-on-github %}
|
||||
<!-- endif -->
|
||||
|
||||
{% link_in_list /setting-up-and-managing-organizations-and-teams %}
|
||||
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /setting-up-and-managing-your-enterprise %}
|
||||
<!-- endif -->
|
||||
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /setting-up-and-managing-billing-and-payments-on-github %}
|
||||
<!-- endif -->
|
||||
|
||||
{% link_in_list /writing-on-github %}
|
||||
|
||||
@@ -50,10 +40,7 @@ versions:
|
||||
{% link_in_list /collaborating-with-issues-and-pull-requests %}
|
||||
|
||||
{% link_in_list /managing-your-work-on-github %}
|
||||
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /developing-online-with-codespaces %}
|
||||
<!-- endif -->
|
||||
|
||||
{% link_in_list /building-a-strong-community %}
|
||||
|
||||
@@ -64,45 +51,21 @@ versions:
|
||||
{% link_in_list /administering-a-repository %}
|
||||
|
||||
{% link_in_list /visualizing-repository-data-with-graphs %}
|
||||
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.16" -->
|
||||
{% link_in_list /managing-security-vulnerabilities %}
|
||||
<!-- endif -->
|
||||
|
||||
{% link_in_list /finding-security-vulnerabilities-and-errors-in-your-code %}
|
||||
|
||||
{% link_in_list /managing-files-in-a-repository %}
|
||||
|
||||
{% link_in_list /managing-large-files %}
|
||||
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /customizing-your-github-workflow %}
|
||||
<!-- endif -->
|
||||
|
||||
{% link_in_list /extending-github %}
|
||||
|
||||
{% link_in_list /working-with-github-pages %}
|
||||
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /supporting-the-open-source-community-with-github-sponsors %}
|
||||
<!-- endif -->
|
||||
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /teaching-and-learning-with-github-education %}
|
||||
<!-- endif -->
|
||||
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /finding-talent-with-github-jobs %}
|
||||
<!-- endif -->
|
||||
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /working-with-github-support %}
|
||||
<!-- endif -->
|
||||
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /understanding-how-github-uses-and-protects-your-data %}
|
||||
<!-- endif -->
|
||||
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /site-policy %}
|
||||
<!-- endif -->
|
||||
|
||||
@@ -14,9 +14,7 @@ versions:
|
||||
### Table of Contents
|
||||
|
||||
{% topic_link_in_list /managing-files-on-github %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /navigating-code-on-github %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /creating-new-files %}
|
||||
{% link_in_list /adding-a-file-to-a-repository %}
|
||||
{% link_in_list /moving-a-file-to-a-new-location %}
|
||||
|
||||
@@ -15,16 +15,12 @@ versions:
|
||||
{% link_in_list /conditions-for-large-files %}
|
||||
{% link_in_list /removing-files-from-a-repositorys-history %}
|
||||
{% link_in_list /distributing-large-binaries %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /what-is-my-disk-quota %}
|
||||
<!-- endif -->
|
||||
{% topic_link_in_list /versioning-large-files %}
|
||||
{% link_in_list /about-git-large-file-storage %}
|
||||
{% link_in_list /installing-git-large-file-storage %}
|
||||
{% link_in_list /configuring-git-large-file-storage %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /about-storage-and-bandwidth-usage %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /collaboration-with-git-large-file-storage %}
|
||||
{% link_in_list /moving-a-file-in-your-repository-to-git-large-file-storage %}
|
||||
{% link_in_list /removing-files-from-git-large-file-storage %}
|
||||
|
||||
@@ -71,7 +71,7 @@ When {% data variables.product.product_name %} identifies a vulnerable dependenc
|
||||
You can see all of the alerts that affect a particular project{% if currentVersion == "free-pro-team@latest" %} on the repository's Security tab or{% endif %} in the repository's dependency graph.{% if currentVersion == "free-pro-team@latest" %} For more information, see "[Viewing and updating vulnerable dependencies in your repository](/articles/viewing-and-updating-vulnerable-dependencies-in-your-repository)."{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
|
||||
By default, we notify people with admin permissions in the affected repositories about new {% data variables.product.prodname_dependabot_alerts %}.{% endif %} {% if currentVersion == "free-pro-team@latest" %}{% 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. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-dependabot-alerts)."
|
||||
By default, we notify people with admin permissions in the affected repositories about new {% data variables.product.prodname_dependabot_alerts %}.{% endif %} {% if currentVersion == "free-pro-team@latest" %}{% 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. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."
|
||||
{% endif %}
|
||||
|
||||
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
|
||||
@@ -12,7 +12,7 @@ versions:
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% else %}When {% data variables.product.product_name %} detects vulnerable dependencies in your repositories, it sends security alerts.{% endif %}{% if currentVersion == "free-pro-team@latest" %} {% data variables.product.prodname_dependabot %} is enabled by default on all public repositories. For {% data variables.product.prodname_dependabot_alerts %}, by default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability.
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether the detection of vulnerable dependencies will be enabled or disabled for newly-created repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-features-for-new-repositories)."
|
||||
{% if currentVersion == "free-pro-team@latest" %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether the detection of vulnerable dependencies will be enabled or disabled for newly-created repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)."
|
||||
{% endif %}
|
||||
|
||||
{% if enterpriseServerVersions contains currentVersion and currentVersion == "enterprise-server@2.21" %}
|
||||
|
||||
@@ -9,8 +9,6 @@ versions:
|
||||
|
||||
|
||||
### Table of Contents
|
||||
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% topic_link_in_list /managing-security-vulnerabilities-in-your-project %}
|
||||
{% link_in_list /adding-a-security-policy-to-your-repository %}
|
||||
{% link_in_list /about-github-security-advisories %}
|
||||
@@ -22,17 +20,12 @@ versions:
|
||||
{% link_in_list /publishing-a-security-advisory %}
|
||||
{% link_in_list /editing-a-security-advisory %}
|
||||
{% link_in_list /withdrawing-a-security-advisory %}
|
||||
<!-- endif -->
|
||||
{% topic_link_in_list /managing-vulnerabilities-in-your-projects-dependencies %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /browsing-security-vulnerabilities-in-the-github-advisory-database %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /about-alerts-for-vulnerable-dependencies %}
|
||||
{% link_in_list /configuring-notifications-for-vulnerable-dependencies %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /about-dependabot-security-updates %}
|
||||
{% link_in_list /configuring-dependabot-security-updates %}
|
||||
{% link_in_list /viewing-and-updating-vulnerable-dependencies-in-your-repository %}
|
||||
{% link_in_list /troubleshooting-the-detection-of-vulnerable-dependencies %}
|
||||
{% link_in_list /troubleshooting-dependabot-errors %}
|
||||
<!-- endif -->
|
||||
|
||||
@@ -76,6 +76,12 @@ There are separate limits for security and version update pull requests, so that
|
||||
|
||||
The best way to resolve this error is to merge or close some of the existing pull requests and trigger a new pull request manually. For more information, see "[Triggering a {% data variables.product.prodname_dependabot %} pull request manually](#triggering-a-dependabot-pull-request-manually)."
|
||||
|
||||
#### {% data variables.product.prodname_dependabot %} can't resolve your dependency files
|
||||
|
||||
**Version updates only.** If {% data variables.product.prodname_dependabot %} attempts to check whether dependency references need to be updated in a repository, but can't access one or more of the referenced files, you will see the error message "{% data variables.product.prodname_dependabot %} can't resolve your LANGUAGE dependency files".
|
||||
|
||||
{% data reusables.dependabot.private-dependencies-note %} Additionally, {% data variables.product.prodname_dependabot %} doesn't support private {% data variables.product.prodname_dotcom %} dependencies for all package managers. For more information, see "[About Dependabot version updates](/github/administering-a-repository/about-dependabot-version-updates#supported-repositories-and-ecosystems)."
|
||||
|
||||
### Triggering a {% data variables.product.prodname_dependabot %} pull request manually
|
||||
|
||||
If you unblock {% data variables.product.prodname_dependabot %}, you can manually trigger a fresh attempt to create a pull request.
|
||||
|
||||
@@ -21,7 +21,12 @@ You can choose to subscribe to notifications for:
|
||||
- A conversation in a specific issue, pull request, or gist.
|
||||
- All activity in a repository or team discussion.
|
||||
- CI activity, such as the status of workflows in repositories set up with {% data variables.product.prodname_actions %}.
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
- Issues, pulls requests, releases and discussions (if enabled) in a repository.
|
||||
{% endif %}
|
||||
{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
|
||||
- Releases in a repository.
|
||||
{% endif %}
|
||||
|
||||
You can also choose to automatically watch all repositories that you have push access to, except forks. You can watch any other repository you have access to manually by clicking **Watch**.
|
||||
|
||||
|
||||
@@ -21,16 +21,17 @@ versions:
|
||||
|
||||
### Notification delivery options
|
||||
|
||||
You have three basic options for notification delivery:
|
||||
- the notifications inbox on {% data variables.product.product_name %}{% if currentVersion == "free-pro-team@latest" %}
|
||||
- the notifications inbox on {% data variables.product.prodname_mobile %}, which syncs with the inbox on {% data variables.product.product_name %}{% endif %}
|
||||
- an email client that uses a verified email address, which can also sync with the notifications inbox on {% data variables.product.product_name %}{% if currentVersion == "free-pro-team@latest" %} and {% data variables.product.prodname_mobile %}{% endif %}
|
||||
You can receive notifications for activity on {% data variables.product.product_name %} in the following locations.
|
||||
|
||||
- The notifications inbox in the {% data variables.product.product_name %} web interface{% if currentVersion == "free-pro-team@latest" %}
|
||||
- The notifications inbox on {% data variables.product.prodname_mobile %}, which syncs with the inbox on {% data variables.product.product_name %}{% endif %}
|
||||
- An email client that uses a verified email address, which can also sync with the notifications inbox on {% data variables.product.product_name %}{% if currentVersion == "free-pro-team@latest" %} and {% data variables.product.prodname_mobile %}{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
{% data reusables.notifications-v2.notifications-inbox-required-setting %} For more information, see "[Choosing your notification settings](#choosing-your-notification-settings)."
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.notifications-v2.tip-for-syncing-email-and-your-inbox-on-github %}
|
||||
{% data reusables.notifications.shared_state %}
|
||||
|
||||
#### Benefits of the notifications inbox
|
||||
|
||||
@@ -58,8 +59,20 @@ Email notifications also allow flexibility with the types of notifications you r
|
||||
|
||||
### About participating and watching notifications
|
||||
|
||||
When you watch a repository, you're subscribing to updates for activity in that repository. Similarly, when you watch a specific team's discussions, you're subscribing to all conversation updates on that team's page. To see repositories that you're watching, see [https://github.com/watching](https://github.com/watching). For more information, see "[Managing subscriptions and notifications on GitHub](/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github)."
|
||||
When you watch a repository, you're subscribing to updates for activity in that repository. Similarly, when you watch a specific team's discussions, you're subscribing to all conversation updates on that team's page. For more information, see "[About team discussions](/github/building-a-strong-community/about-team-discussions)."
|
||||
|
||||
To see repositories that you're watching, go to your [watching page](https://github.com/watching). For more information, see "[Managing subscriptions and notifications on GitHub](/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github)."
|
||||
{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
|
||||
#### Configuring notifications
|
||||
{% endif %}
|
||||
You can configure notifications for a repository on the repository page, or on your watching page.{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %} You can choose to only receive notifications for releases in a repository, or ignore all notifications for a repository.{% endif %}{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
#### About custom notifications
|
||||
{% data reusables.notifications-v2.custom-notifications-beta %}
|
||||
You can customize notifications for a repository, for example, you can choose to only be notified when updates to one or more types of events (issues, pull request, releases, discussions) happen within a repository, or ignore all notifications for a repository.
|
||||
{% endif %} For more information, see "[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions#configuring-your-watch-settings-for-an-individual-repository)."
|
||||
|
||||
#### Participating in conversations
|
||||
Anytime you comment in a conversation or when someone @mentions your username, you are _participating_ in a conversation. By default, you are automatically subscribed to a conversation when you participate in it. You can unsubscribe from a conversation you've participated in manually by clicking **Unsubscribe** on the issue or pull request or through the **Unsubscribe** option in the notifications inbox.
|
||||
|
||||
For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_name %}{% if currentVersion == "free-pro-team@latest" %} and {% data variables.product.prodname_mobile %}{% endif %}.
|
||||
@@ -94,7 +107,9 @@ Choose a default email address where you want to send updates for conversations
|
||||
- Pull request pushes.
|
||||
- Your own updates, such as when you open, comment on, or close an issue or pull request.
|
||||
|
||||
Depending on the organization that owns the repository, you can also send notifications to different email addresses for specific repositories. For example, you can send notifications for a specific public repository to a verified personal email address. Your organization may require the email address to be verified for a specific domain. For more information, see “[Choosing where your organization’s email notifications are sent](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-where-your-organizations-email-notifications-are-sent)."
|
||||
Depending on the organization that owns the repository, you can also send notifications to different email addresses. Your organization may require the email address to be verified for a specific domain. For more information, see "[Choosing where your organization’s email notifications are sent](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-where-your-organizations-email-notifications-are-sent)."
|
||||
|
||||
You can also send notifications for a specific repository to an email address. For more information, see "[About email notifications for pushes to your repository](/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository)."
|
||||
|
||||
{% data reusables.notifications-v2.email-notification-caveats %}
|
||||
|
||||
|
||||
@@ -59,6 +59,13 @@ When you unwatch a repository, you unsubscribe from future updates from that rep
|
||||
1. In the left sidebar, under the list of repositories, use the "Manage notifications" drop-down to click **Watched repositories**.
|
||||
|
||||
2. On the watched repositories page, after you've evaluated the repositories you're watching, choose whether to:
|
||||
{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
|
||||
- unwatch a repository
|
||||
- only watch releases for a repository
|
||||
- ignore all notifications for a repository
|
||||
{% endif %}
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
- unwatch a repository
|
||||
- ignore all notifications for a repository
|
||||
- customize the types of event you receive notifications for (issues, pull requests, releases or discussions, if enabled)
|
||||
{% endif %}
|
||||
@@ -32,7 +32,16 @@ When your inbox has too many notifications to manage, consider whether you have
|
||||
|
||||
For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#automatic-watching)."
|
||||
|
||||
To see an overview of your repository subscriptions, see "[Reviewing repositories that you're watching](#reviewing-repositories-that-youre-watching)." Many people forget about repositories that they've chosen to watch in the past. From the "Watched repositories" page you can quickly unwatch repositories. For more information on ways to unsubscribe, see "[Managing subscriptions](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)."
|
||||
To see an overview of your repository subscriptions, see "[Reviewing repositories that you're watching](#reviewing-repositories-that-youre-watching)."
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
{% tip %}
|
||||
|
||||
**Tip:** You can select the types of event to be notified of by using the **Custom** option of the **Watch/Unwatch** dropdown list in your [watching page](https://github.com/watching) or on any repository page on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Configuring your watch settings for an individual repository](#configuring-your-watch-settings-for-an-individual-repository)" below.
|
||||
|
||||
{% endtip %}
|
||||
{% endif %}
|
||||
|
||||
Many people forget about repositories that they've chosen to watch in the past. From the "Watched repositories" page you can quickly unwatch repositories. For more information on ways to unsubscribe, see "[Unwatch recommendations](https://github.blog/changelog/2020-11-10-unwatch-recommendations/)" on {% data variables.product.prodname_blog %} and "[Managing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)." You can also create a triage workflow to help with the notifications you receive. For guidance on triage workflows, see "[Customizing a workflow for triaging your notifications](/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications)."
|
||||
|
||||
### Reviewing all of your subscriptions
|
||||
|
||||
@@ -57,21 +66,38 @@ To see an overview of your repository subscriptions, see "[Reviewing repositorie
|
||||
|
||||
1. In the left sidebar, under the list of repositories, use the "Manage notifications" drop-down menu and click **Watched repositories**.
|
||||
|
||||
|
||||
3. Evaluate the repositories that you are watching and decide if their updates are still relevant and helpful. When you watch a repository, you will be notified of all conversations for that repository.
|
||||
|
||||
2. Evaluate the repositories that you are watching and decide if their updates are still relevant and helpful. When you watch a repository, you will be notified of all conversations for that repository.
|
||||
{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
|
||||
|
||||
{% endif %}
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** Instead of watching a repository, consider only watching releases for a repository or completely unwatching a repository. When you unwatch a repository, you can still be notified when you're @mentioned or participating in a thread. When you only watch releases for a repository, you're only notified when there's a new release, you're participating in a thread, or you or a team you're on is @mentioned.
|
||||
**Tip:** Instead of watching a repository, consider only receiving notifications {% if currentVersion == "free-pro-team@latest" %}when there are updates to issues, pull requests, releases or discussions (if enabled for the repository), or any combination of these options,{% else %}for releases in a repository,{% endif %} or completely unwatching a repository.
|
||||
|
||||
When you unwatch a repository, you can still be notified when you're @mentioned or participating in a thread. When you configure to receive notifications for certain event types, you're only notified when there are updates to these event types in the repository, you're participating in a thread, or you or a team you're on is @mentioned.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
### Configuring your watch settings for an individual repository
|
||||
|
||||
You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of new releases or ignore an individual repository.
|
||||
You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% if currentVersion == "free-pro-team@latest" %}certain event types such as issues, pull requests, discussions (if enabled for the repository) and {% endif %}new releases, or completely ignore an individual repository.
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
2. In the upper-right corner, click the "Watch" drop-down menu to select a watch option.
|
||||
{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
|
||||
|
||||
{% endif %}
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
{% data reusables.notifications-v2.custom-notifications-beta %}
|
||||
The **Custom** option allows you to further customize notifications so that you're only notified when specific events happen in the repository, in addition to participating and @mentions.
|
||||
|
||||
|
||||
|
||||
If you select "Issues", you will be notified about, and subscribed to, updates on every issue (including those that existed prior to you selecting this option) in the repository. If you're @mentioned in a pull request in this repository, you'll receive notifications for that too, and you'll be subscribed to updates on that specific pull request, in addition to being notified about issues.
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
---
|
||||
title: About labels
|
||||
intro: 'Labels on {% data variables.product.product_name %} help you organize and prioritize your work. You can apply labels to issues and pull requests to signify priority, category, or any other information you find useful.'
|
||||
redirect_from:
|
||||
- /articles/about-labels
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
Labels are tied to the repository they are created in. Once a label exists, you can use it on any issue or pull request within that repository. For more information, see "[Creating a label](/articles/creating-a-label/)."
|
||||
|
||||
Anyone with read access to a repository can view and search the repository’s labels. To create, edit, apply, or delete a label, you must have write access to the repository.
|
||||
|
||||
### Using default labels
|
||||
|
||||
{% data variables.product.product_name %} provides default labels in every new repository. You can use these default labels to help create a standard workflow in a repository:
|
||||
|
||||
Label | Description
|
||||
--- | ---
|
||||
`bug` | Indicates an unexpected problem or unintended behavior
|
||||
`documentation` | Indicates a need for improvements or additions to documentation
|
||||
`duplicate` | Indicates similar issues or pull requests
|
||||
`enhancement` | Indicates new feature requests
|
||||
`good first issue` | Indicates a good issue for first-time contributors
|
||||
`help wanted` | Indicates that a maintainer wants help on an issue or pull request
|
||||
`invalid` | Indicates that an issue or pull request is no longer relevant
|
||||
`question` | Indicates that an issue or pull request needs more information
|
||||
`wontfix` | Indicates that work won't continue on an issue or pull request
|
||||
|
||||
Default labels are included in every new repository when the repository is created, but you can edit or delete the labels later. For more information, see "[Deleting a label](/articles/deleting-a-label/)."
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
|
||||
Organization owners can customize the default labels for repositories in their organization. For more information, see "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)."
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
### Further reading
|
||||
|
||||
- "[Encouraging helpful contributions to your project with labels](/github/building-a-strong-community/encouraging-helpful-contributions-to-your-project-with-labels)"
|
||||
{% endif %}
|
||||
@@ -1,29 +0,0 @@
|
||||
---
|
||||
title: Applying labels to issues and pull requests
|
||||
intro: 'In repositories where you have write access, you can assign labels to issues and pull requests to help organize your projects.'
|
||||
redirect_from:
|
||||
- /articles/customizing-issue-labels/
|
||||
- /articles/applying-labels-to-issues-and-pull-requests
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** You can apply up to a maximum of 100 labels to issues and pull requests.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-issue-pr %}
|
||||
{% data reusables.repositories.select-items-in-issue-or-pr-list %}
|
||||
4. In the upper-right corner, click **Label**, then start typing the name of an existing label. Click the label's name to associate it with the selected items. You can also apply a label in the Labels drop-down menu within an issue or pull request.
|
||||
|
||||
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[About labels](/articles/about-labels)"
|
||||
- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)"
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
title: Creating a label
|
||||
intro: 'In repositories where you have write access, you can create labels to organize issues and pull requests.'
|
||||
redirect_from:
|
||||
- /articles/creating-and-editing-labels-for-issues-and-pull-requests/
|
||||
- /articles/creating-a-label
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** You can also create a label in the Labels drop-down menu within an issue or pull request.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-issue-pr %}
|
||||
{% data reusables.project-management.labels %}
|
||||
4. To the right of the search field, click **New label**.
|
||||
{% data reusables.project-management.name-label %}
|
||||
{% data reusables.project-management.label-description %}
|
||||
{% data reusables.project-management.label-color-randomizer %}
|
||||
{% data reusables.project-management.create-label %}
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[About labels](/articles/about-labels)"
|
||||
- "[Applying labels to issues and pull requests](/articles/applying-labels-to-issues-and-pull-requests)"
|
||||
- "[Editing a label](/articles/editing-a-label)"
|
||||
- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)"{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
|
||||
- "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)"
|
||||
{% endif %}
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Creating an issue
|
||||
intro: 'Issues can be used to keep track of bugs, enhancements, or other requests.'
|
||||
permissions: 'People with read permissions can create an issue in a repository where issues are enabled.'
|
||||
redirect_from:
|
||||
- /articles/creating-an-issue
|
||||
versions:
|
||||
@@ -8,7 +9,6 @@ versions:
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
---
|
||||
{% data reusables.repositories.create-issue-in-public-repository %}
|
||||
|
||||
You can open a new issue based on code from an existing pull request. For more information, see "[Opening an issue from code](/github/managing-your-work-on-github/opening-an-issue-from-code)."
|
||||
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
---
|
||||
title: Deleting a label
|
||||
intro: 'In repositories where you have write access, you can delete a label if you no longer need it to classify issues or pull requests.'
|
||||
redirect_from:
|
||||
- /articles/deleting-a-label
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
Deleting a label will remove the label from any issues or pull requests where it's been applied.
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-issue-pr %}
|
||||
{% data reusables.project-management.labels %}
|
||||
{% data reusables.project-management.delete-label %}
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Applying labels to issues and pull requests](/articles/applying-labels-to-issues-and-pull-requests)"
|
||||
- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)"{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
|
||||
- "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)"
|
||||
{% endif %}
|
||||
@@ -1,29 +0,0 @@
|
||||
---
|
||||
title: Editing a label
|
||||
intro: 'In repositories where you have write access, you can edit the name, color, and description of an existing label.'
|
||||
redirect_from:
|
||||
- /articles/editing-a-label
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-issue-pr %}
|
||||
{% data reusables.project-management.labels %}
|
||||
{% data reusables.project-management.edit-label %}
|
||||
{% data reusables.project-management.name-label %}
|
||||
{% data reusables.project-management.label-description %}
|
||||
{% data reusables.project-management.label-color-randomizer %}
|
||||
{% data reusables.project-management.save-label %}
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[About labels](/articles/about-labels)"
|
||||
- "[Creating a label](/articles/creating-a-label)"
|
||||
- "[Deleting a label](/articles/deleting-a-label)"
|
||||
- "[Applying labels to issues and pull requests](/articles/applying-labels-to-issues-and-pull-requests)"
|
||||
- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)"{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
|
||||
- "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)"
|
||||
{% endif %}
|
||||
@@ -14,19 +14,16 @@ versions:
|
||||
|
||||
### Table of Contents
|
||||
|
||||
{% topic_link_in_list /managing-your-work-with-issues %}
|
||||
{% topic_link_in_list /managing-your-work-with-issues-and-pull-requests %}
|
||||
{% link_in_list /about-issues %}
|
||||
{% link_in_list /creating-an-issue %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.15" -->
|
||||
{% link_in_list /deleting-an-issue %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /opening-an-issue-from-a-comment %}
|
||||
{% link_in_list /opening-an-issue-from-code %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.17" -->
|
||||
{% link_in_list /transferring-an-issue-to-another-repository %}
|
||||
{% link_in_list /pinning-an-issue-to-your-repository %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /creating-a-permanent-link-to-a-code-snippet %}
|
||||
{% link_in_list /managing-labels %}
|
||||
{% link_in_list /about-task-lists %}
|
||||
{% link_in_list /about-automation-for-issues-and-pull-requests-with-query-parameters %}
|
||||
{% link_in_list /file-attachments-on-issues-and-pull-requests %}
|
||||
@@ -35,12 +32,6 @@ versions:
|
||||
{% link_in_list /disabling-issues %}
|
||||
{% link_in_list /linking-a-pull-request-to-an-issue %}
|
||||
{% link_in_list /about-duplicate-issues-and-pull-requests %}
|
||||
{% topic_link_in_list /labeling-issues-and-pull-requests %}
|
||||
{% link_in_list /about-labels %}
|
||||
{% link_in_list /creating-a-label %}
|
||||
{% link_in_list /applying-labels-to-issues-and-pull-requests %}
|
||||
{% link_in_list /editing-a-label %}
|
||||
{% link_in_list /deleting-a-label %}
|
||||
{% topic_link_in_list /managing-project-boards %}
|
||||
{% link_in_list /about-project-boards %}
|
||||
{% link_in_list /creating-a-project-board %}
|
||||
@@ -48,9 +39,7 @@ versions:
|
||||
{% link_in_list /linking-a-repository-to-a-project-board %}
|
||||
{% link_in_list /about-automation-for-project-boards %}
|
||||
{% link_in_list /configuring-automation-for-project-boards %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||
{% link_in_list /copying-a-project-board %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /closing-a-project-board %}
|
||||
{% link_in_list /reopening-a-closed-project-board %}
|
||||
{% link_in_list /deleting-a-project-board %}
|
||||
|
||||
@@ -1,12 +0,0 @@
|
||||
---
|
||||
title: Labeling issues and pull requests
|
||||
intro: 'You can manage your work on {% data variables.product.product_name %} by creating labels to categorize issues and pull requests.'
|
||||
mapTopic: true
|
||||
redirect_from:
|
||||
- /articles/labeling-issues-and-pull-requests
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
@@ -0,0 +1,98 @@
|
||||
---
|
||||
title: Managing labels
|
||||
intro: 'You can classify issues and pull requests by creating, editing, applying, and deleting labels.'
|
||||
redirect_from:
|
||||
- /articles/managing-Labels
|
||||
- /articles/labeling-issues-and-pull-requests
|
||||
- /github/managing-your-work-on-github/labeling-issues-and-pull-requests
|
||||
- /articles/about-labels
|
||||
- /github/managing-your-work-on-github/about-labels
|
||||
- /articles/creating-and-editing-labels-for-issues-and-pull-requests
|
||||
- /articles/creating-a-label
|
||||
- /github/managing-your-work-on-github/creating-a-label
|
||||
- /articles/customizing-issue-labels/
|
||||
- /articles/applying-labels-to-issues-and-pull-requests
|
||||
- /github/managing-your-work-on-github/applying-labels-to-issues-and-pull-requests
|
||||
- /articles/editing-a-label
|
||||
- /github/managing-your-work-on-github/editing-a-label
|
||||
- /articles/deleting-a-label
|
||||
- /github/managing-your-work-on-github/deleting-a-label
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
### About labels
|
||||
|
||||
You can manage your work on {% data variables.product.product_name %} by creating labels to categorize issues and pull requests. You can apply labels in the repository the label was created in. Once a label exists, you can use the label on any issue or pull request within that repository.
|
||||
|
||||
Anyone with read access to a repository can view and search the repository’s labels. To create, edit, apply, or delete a label, you must have write access to the repository.
|
||||
|
||||
### About default labels
|
||||
|
||||
{% data variables.product.product_name %} provides default labels in every new repository. You can use these default labels to help create a standard workflow in a repository.
|
||||
|
||||
Label | Description
|
||||
--- | ---
|
||||
`bug` | Indicates an unexpected problem or unintended behavior{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.17" %}
|
||||
`documentation` | Indicates a need for improvements or additions to documentation{% endif %}
|
||||
`duplicate` | Indicates similar issues or pull requests
|
||||
`enhancement` | Indicates new feature requests
|
||||
`good first issue` | Indicates a good issue for first-time contributors
|
||||
`help wanted` | Indicates that a maintainer wants help on an issue or pull request
|
||||
`invalid` | Indicates that an issue or pull request is no longer relevant
|
||||
`question` | Indicates that an issue or pull request needs more information
|
||||
`wontfix` | Indicates that work won't continue on an issue or pull request
|
||||
|
||||
Default labels are included in every new repository when the repository is created, but you can edit or delete the labels later.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
|
||||
Organization owners can customize the default labels for repositories in their organization. For more information, see "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)."
|
||||
{% endif %}
|
||||
|
||||
### Creating a label
|
||||
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-issue-pr %}
|
||||
{% data reusables.project-management.labels %}
|
||||
4. To the right of the search field, click **New label**.
|
||||
{% data reusables.project-management.name-label %}
|
||||
{% data reusables.project-management.label-description %}
|
||||
{% data reusables.project-management.label-color-randomizer %}
|
||||
{% data reusables.project-management.create-label %}
|
||||
|
||||
### Applying labels to issues and pull requests
|
||||
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-issue-pr %}
|
||||
{% data reusables.repositories.select-items-in-issue-or-pr-list %}
|
||||
4. In the upper-right corner, click **Label**, then start typing the name of an existing label. Click the label's name to associate it with the selected items.
|
||||
|
||||
|
||||
### Editing a label
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-issue-pr %}
|
||||
{% data reusables.project-management.labels %}
|
||||
{% data reusables.project-management.edit-label %}
|
||||
{% data reusables.project-management.name-label %}
|
||||
{% data reusables.project-management.label-description %}
|
||||
{% data reusables.project-management.label-color-randomizer %}
|
||||
{% data reusables.project-management.save-label %}
|
||||
|
||||
### Deleting a label
|
||||
Deleting a label will remove the label from issues and pull requests.
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-issue-pr %}
|
||||
{% data reusables.project-management.labels %}
|
||||
{% data reusables.project-management.delete-label %}
|
||||
|
||||
### Further reading
|
||||
- "[About labels](/articles/about-labels)"
|
||||
- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)"{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
- "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)"{% endif %}{% if currentVersion == "free-pro-team@latest" %}
|
||||
- "[Encouraging helpful contributions to your project with labels](/github/building-a-strong-community/encouraging-helpful-contributions-to-your-project-with-labels)"{% endif %}
|
||||
@@ -1,8 +1,9 @@
|
||||
---
|
||||
title: Managing your work with issues
|
||||
title: Managing your work with issues and pull requests
|
||||
intro: 'You can manage your work on {% data variables.product.product_name %} by creating issues to track ideas, enhancements, tasks, or bugs.'
|
||||
mapTopic: true
|
||||
redirect_from:
|
||||
- /github/managing-your-work-on-github/managing-your-work-with-issues
|
||||
- /articles/managing-your-work-with-issues
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Opening an issue from a comment
|
||||
intro: You can open a new issue from a specific comment in an issue or pull request.
|
||||
permissions: 'People with read permissions can create an issue in a repository where issues are enabled.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -9,6 +10,8 @@ versions:
|
||||
|
||||
When you open an issue from a comment, the issue contains a snippet showing where the comment was originally posted.
|
||||
|
||||
{% data reusables.repositories.administrators-can-disable-issues %}
|
||||
|
||||
1. Navigate to the comment you'd like to open an issue from.
|
||||
|
||||
2. In that comment, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Opening an issue from code
|
||||
intro: You can open a new issue from a specific line or lines of code in a file or pull request.
|
||||
permissions: 'People with read permissions can create an issue in a repository where issues are enabled.'
|
||||
redirect_from:
|
||||
- /articles/opening-an-issue-from-code
|
||||
versions:
|
||||
@@ -13,7 +14,7 @@ When you open an issue from code, the issue contains a snippet showing the line
|
||||
|
||||
|
||||
|
||||
{% data reusables.repositories.create-issue-in-public-repository %}
|
||||
{% data reusables.repositories.administrators-can-disable-issues %}
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
2. Locate the code you want to reference in an issue:
|
||||
|
||||
@@ -11,7 +11,7 @@ versions:
|
||||
|
||||
To transfer an open issue to another repository, you must have write permissions on the repository the issue is in and the repository you're transferring the issue to. For more information, see "[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization)."
|
||||
|
||||
You can only transfer issues between repositories owned by the same user or organization account. You can't transfer an issue from a private repository to a public repository.
|
||||
You can only transfer issues between repositories owned by the same user or organization account.{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}You can't transfer an issue from a private repository to a public repository.{% endif %}
|
||||
|
||||
When you transfer an issue, comments and assignees are retained. The issue's labels and milestones are not retained. This issue will stay on any user-owned or organization-wide project boards and be removed from any repository project boards. For more information, see "[About project boards](/articles/about-project-boards)."
|
||||
|
||||
|
||||
@@ -14,16 +14,10 @@ versions:
|
||||
{% link_in_list /choosing-the-delivery-method-for-your-notifications %}
|
||||
{% topic_link_in_list /managing-your-notifications %}
|
||||
{% link_in_list /marking-notifications-as-read %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.15" -->
|
||||
{% link_in_list /saving-notifications-for-later %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /subscribing-to-and-unsubscribing-from-notifications %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.16" -->
|
||||
{% link_in_list /listing-the-issues-and-pull-requests-youre-subscribed-to %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /watching-and-unwatching-repositories %}
|
||||
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.15" -->
|
||||
{% link_in_list /watching-and-unwatching-releases-for-a-repository %}
|
||||
<!-- endif -->
|
||||
{% link_in_list /watching-and-unwatching-team-discussions %}
|
||||
{% link_in_list /listing-the-repositories-youre-watching %}
|
||||
|
||||
@@ -14,7 +14,7 @@ versions:
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
You can search globally across all of {% data variables.product.product_name %}, or scope your search to a particular repository or organization.
|
||||
{% data reusables.search.you-can-search-globally %}
|
||||
|
||||
- To search globally across all of {% data variables.product.product_name %}, type what you're looking for into the search field at the top of any page, and choose "All {% data variables.product.prodname_dotcom %}" in the search drop-down menu.
|
||||
- To search within a particular repository or organization, navigate to the repository or organization page, type what you're looking for into the search field at the top of the page, and press **Enter**.
|
||||
@@ -23,7 +23,8 @@ You can search globally across all of {% data variables.product.product_name %},
|
||||
|
||||
**Notes:**
|
||||
|
||||
- {% data reusables.search.required_login %}
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
- {% data reusables.search.required_login %}{% endif %}
|
||||
- {% data variables.product.prodname_pages %} sites are not searchable on {% data variables.product.product_name %}. However you can search the source content if it exists in the default branch of a repository, using code search. For more information, see "[Searching code](/articles/searching-code)." For more information about {% data variables.product.prodname_pages %}, see "[What is GitHub Pages?](/articles/what-is-github-pages/)"
|
||||
- Currently our search doesn't support exact matching.
|
||||
- Whenever you are searching in code files, only the first two results in each file will be returned.
|
||||
@@ -36,7 +37,7 @@ After running a search on {% data variables.product.product_name %}, you can sor
|
||||
|
||||
### Types of searches on {% data variables.product.prodname_dotcom %}
|
||||
|
||||
You can search the following types of information across all public {% data variables.product.product_name %} repositories, and all private {% data variables.product.product_name %} repositories you have access to:
|
||||
You can search for the following information across all repositories you can access on {% data variables.product.product_location %}.
|
||||
|
||||
- [Repositories](/articles/searching-for-repositories)
|
||||
- [Topics](/articles/searching-topics)
|
||||
|
||||
@@ -25,8 +25,8 @@ versions:
|
||||
{% link_in_list /searching-topics %}
|
||||
{% link_in_list /searching-code %}
|
||||
{% link_in_list /searching-commits %}
|
||||
{% link_in_list /searching-issues-and-pull-requests %}{% if currentVersion == "free-pro-team@latest" %}
|
||||
{% link_in_list /searching-github-marketplace %}{% endif %}
|
||||
{% link_in_list /searching-issues-and-pull-requests %}
|
||||
{% link_in_list /searching-github-marketplace %}
|
||||
{% link_in_list /searching-users %}
|
||||
{% link_in_list /searching-for-packages %}
|
||||
{% link_in_list /searching-wikis %}
|
||||
|
||||
@@ -11,7 +11,7 @@ versions:
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
You can search for code globally across all of {% data variables.product.product_name %}, or search for code within a particular repository or organization. To search for code across all public repositories, you must be signed in to a {% data variables.product.product_name %} account. For more information, see "[About searching on GitHub](/articles/about-searching-on-github)."
|
||||
{% data reusables.search.you-can-search-globally %} For more information, see "[About searching on GitHub](/articles/about-searching-on-github)."
|
||||
|
||||
You can only search code using these code search qualifiers. Search qualifiers specifically for repositories, users, or commits, will not work when searching for code.
|
||||
|
||||
@@ -21,13 +21,13 @@ You can only search code using these code search qualifiers. Search qualifiers s
|
||||
|
||||
Due to the complexity of searching code, there are some restrictions on how searches are performed:
|
||||
|
||||
- {% data reusables.search.required_login %}
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
- {% data reusables.search.required_login %}{% endif %}
|
||||
- Code in [forks](/articles/about-forks) is only searchable if the fork has more stars than the parent repository. Forks with fewer stars than the parent repository are **not** indexed for code search. To include forks with more stars than their parent in the search results, you will need to add `fork:true` or `fork:only` to your query. For more information, see "[Searching in forks](/articles/searching-in-forks)."
|
||||
- Only the _default branch_ is indexed for code search.{% if currentVersion == "free-pro-team@latest" %}
|
||||
- Only files smaller than 384 KB are searchable.{% else %}* Only files smaller than 5 MB are searchable.
|
||||
- Only the first 500 KB of each file is searchable.{% endif %}
|
||||
- Only repositories with fewer than 500,000 files are searchable.
|
||||
- Users who are signed in can search all public repositories.
|
||||
- Except with [`filename`](#search-by-filename) searches, you must always include at least one search term when searching source code. For example, searching for [`language:javascript`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ajavascript&type=Code&ref=searchresults) is not valid, while [`amazing language:javascript`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ajavascript&type=Code&ref=searchresults) is.
|
||||
- At most, search results can show two fragments from the same file, but there may be more results within the file.
|
||||
- You can't use the following wildcard characters as part of your search query: <code>. , : ; / \ ` ' " = * ! ? # $ & + ^ | ~ < > ( ) { } [ ]</code>. The search will simply ignore these symbols.
|
||||
|
||||
@@ -96,14 +96,15 @@ To search commits in all repositories owned by a certain user or organization, u
|
||||
| <code>org:<em>ORGNAME</em></code> | [**test org:github**](https://github.com/search?utf8=%E2%9C%93&q=test+org%3Agithub&type=Commits) matches commit messages with the word "test" in repositories owned by @github.
|
||||
| <code>repo:<em>USERNAME/REPO</em></code> | [**language repo:defunkt/gibberish**](https://github.com/search?utf8=%E2%9C%93&q=language+repo%3Adefunkt%2Fgibberish&type=Commits) matches commit messages with the word "language" in @defunkt's "gibberish" repository.
|
||||
|
||||
### Filter public or private repositories
|
||||
### Filter by repository visibility
|
||||
|
||||
The `is` qualifier matches public or private commits.
|
||||
The `is` qualifier matches commits from repositories with the specified visibility. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility).
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Commits) matches public commits.
|
||||
| `is:private` | [**is:private**](https://github.com/search?q=is%3Aprivate&type=Commits) matches private commits.
|
||||
| ------------- | ------------- |{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Commits) matches commits to public repositories.{% endif %}
|
||||
| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Commits) matches commits to internal repositories.
|
||||
| `is:private` | [**is:private**](https://github.com/search?q=is%3Aprivate&type=Commits) matches commits to private repositories.
|
||||
|
||||
### Further reading
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ versions:
|
||||
github-ae: '*'
|
||||
---
|
||||
|
||||
You can search for repositories globally across all of {% data variables.product.product_name %}, or search for repositories within a particular organization. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/articles/about-searching-on-github)."
|
||||
You can search for repositories globally across all of {% data variables.product.product_location %}, or search for repositories within a particular organization. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/articles/about-searching-on-github)."
|
||||
|
||||
To include forks in the search results, you will need to add `fork:true` or `fork:only` to your query. For more information, see "[Searching in forks](/articles/searching-in-forks)."
|
||||
|
||||
@@ -22,20 +22,20 @@ With the `in` qualifier you can restrict your search to the repository name, rep
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
| `in:name` | [**jquery in:name**](https://github.com/search?q=jquery+in%3Aname&type=Repositories) matches repositories with "jquery" in their name.
|
||||
| `in:description` | [**jquery in:name,description**](https://github.com/search?q=jquery+in%3Aname%2Cdescription&type=Repositories) matches repositories with "jquery" in their name or description.
|
||||
| `in:readme` | [**jquery in:readme**](https://github.com/search?q=jquery+in%3Areadme&type=Repositories) matches repositories mentioning "jquery" in their README file.
|
||||
| `in:name` | [**jquery in:name**](https://github.com/search?q=jquery+in%3Aname&type=Repositories) matches repositories with "jquery" in the repository name.
|
||||
| `in:description` | [**jquery in:name,description**](https://github.com/search?q=jquery+in%3Aname%2Cdescription&type=Repositories) matches repositories with "jquery" in the repository name or description.
|
||||
| `in:readme` | [**jquery in:readme**](https://github.com/search?q=jquery+in%3Areadme&type=Repositories) matches repositories mentioning "jquery" in the repository's README file.
|
||||
| `repo:owner/name` | [**repo:octocat/hello-world**](https://github.com/search?q=repo%3Aoctocat%2Fhello-world) matches a specific repository name.
|
||||
|
||||
### Search based on the contents of a repository
|
||||
|
||||
You can find a repository by searching for content in its README file, using the `in:readme` qualifier.
|
||||
You can find a repository by searching for content in the repository's README file using the `in:readme` qualifier. For more information, see "[About READMEs](/github/creating-cloning-and-archiving-repositories/about-readmes)."
|
||||
|
||||
Besides using `in:readme`, it's not possible to find repositories by searching for specific content within the repository. To search for a specific file or content within a repository, you can use the file finder or code-specific search qualifiers. For more information, see "[Finding files on {% data variables.product.prodname_dotcom %}](/articles/finding-files-on-github)" and "[Searching code](/articles/searching-code)."
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
| `in:readme` | [**octocat in:readme**](https://github.com/search?q=octocat+in%3Areadme&type=Repositories) matches repositories mentioning "octocat" in their README file.
|
||||
| `in:readme` | [**octocat in:readme**](https://github.com/search?q=octocat+in%3Areadme&type=Repositories) matches repositories mentioning "octocat" in the repository's README file.
|
||||
|
||||
### Search within a user's or organization's repositories
|
||||
|
||||
@@ -48,7 +48,7 @@ To search in all repositories owned by a certain user or organization, you can u
|
||||
|
||||
### Search by repository size
|
||||
|
||||
The `size` qualifier finds repositories that match a certain size (in kilobytes), using [greater than, less than, and range qualifiers](/articles/understanding-the-search-syntax).
|
||||
The `size` qualifier finds repositories that match a certain size (in kilobytes), using greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)."
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
@@ -59,7 +59,7 @@ The `size` qualifier finds repositories that match a certain size (in kilobytes)
|
||||
|
||||
### Search by number of followers
|
||||
|
||||
You can filter repositories based on the number of followers that they have, using the `followers` qualifier with [greater than, less than, and range qualifiers](/articles/understanding-the-search-syntax).
|
||||
You can filter repositories based on the number of users who follow the repositories, using the `followers` qualifier with greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)."
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
@@ -68,7 +68,7 @@ You can filter repositories based on the number of followers that they have, usi
|
||||
|
||||
### Search by number of forks
|
||||
|
||||
The `forks` qualifier specifies the number of forks a repository should have, using [greater than, less than, and range qualifiers](/articles/understanding-the-search-syntax).
|
||||
The `forks` qualifier specifies the number of forks a repository should have, using greater than, less than, and range qualifiers. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)."
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
@@ -79,7 +79,7 @@ The `forks` qualifier specifies the number of forks a repository should have, us
|
||||
|
||||
### Search by number of stars
|
||||
|
||||
You can search repositories based on the number of [stars](/articles/saving-repositories-with-stars) a repository has, using [greater than, less than, and range qualifiers](/articles/understanding-the-search-syntax)
|
||||
You can search repositories based on the number of stars the repositories have, using greater than, less than, and range qualifiers. For more information, see "[Saving repositories with stars](/github/getting-started-with-github/saving-repositories-with-stars)" and "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)."
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
@@ -103,7 +103,7 @@ Both take a date as a parameter. {% data reusables.time_date.date_format %} {% d
|
||||
|
||||
### Search by language
|
||||
|
||||
You can search repositories based on the main language they're written in.
|
||||
You can search repositories based on the language of the code in the repositories.
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
@@ -111,7 +111,7 @@ You can search repositories based on the main language they're written in.
|
||||
|
||||
### Search by topic
|
||||
|
||||
You can find all of the repositories that are classified with a particular [topic](/articles/classifying-your-repository-with-topics).
|
||||
You can find all of the repositories that are classified with a particular topic. For more information, see "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)."
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
@@ -119,35 +119,40 @@ You can find all of the repositories that are classified with a particular [topi
|
||||
|
||||
### Search by number of topics
|
||||
|
||||
You can search repositories by the number of [topics](/articles/classifying-your-repository-with-topics) that have been applied to them, using the `topics` qualifier along with [greater than, less than, and range qualifiers](/articles/understanding-the-search-syntax).
|
||||
You can search repositories by the number of topics that have been applied to the repositories, using the `topics` qualifier along with greater than, less than, and range qualifiers. For more information, see "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)" and "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)."
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
| <code>topics:<em>n</em></code> | [**topics:5**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A5&type=Repositories&ref=searchresults) matches repositories that have five topics.
|
||||
| | [**topics:>3**](https://github.com/search?utf8=%E2%9C%93&q=topics%3A%3E3&type=Repositories&ref=searchresults) matches repositories that have more than three topics.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
### Search by license
|
||||
|
||||
You can search repositories by their [license](/articles/licensing-a-repository). You must use a [license keyword](/articles/licensing-a-repository/#searching-github-by-license-type) to filter repositories by a particular license or license family.
|
||||
You can search repositories by the type of license in the repositories. You must use a license keyword to filter repositories by a particular license or license family. For more information, see "[Licensing a repository](/github/creating-cloning-and-archiving-repositories/licensing-a-repository)."
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
| <code>license:<em>LICENSE_KEYWORD</em></code> | [**license:apache-2.0**](https://github.com/search?utf8=%E2%9C%93&q=license%3Aapache-2.0&type=Repositories&ref=searchresults) matches repositories that are licensed under Apache License 2.0.
|
||||
|
||||
### Search by public or private repository
|
||||
{% endif %}
|
||||
|
||||
You can filter your search based on whether a repository is public or private.
|
||||
### Search by repository visibility
|
||||
|
||||
You can filter your search based on the visibility of the repositories. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)."
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
| `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories&utf8=%E2%9C%93) matches repositories owned by GitHub that are public.
|
||||
| `is:private` | [**is:private pages**](https://github.com/search?utf8=%E2%9C%93&q=pages+is%3Aprivate&type=Repositories) matches private repositories you have access to and that contain the word "pages."
|
||||
| ------------- | ------------- |{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
| `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories) matches public repositories owned by {% data variables.product.company_short %}.{% endif %}
|
||||
| `is:internal` | [**is:internal test**](https://github.com/search?q=is%3Ainternal+test&type=Repositories) matches internal repositories that you can access and contain the word "test".
|
||||
| `is:private` | [**is:private pages**](https://github.com/search?q=is%3Aprivate+pages&type=Repositories) matches private repositories that you can access and contain the word "pages."
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
### Search based on whether a repository is a mirror
|
||||
|
||||
You can search repositories based on whether or not they're a mirror and are hosted elsewhere. For more information, see "[Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)."
|
||||
You can search repositories based on whether the repositories are mirrors and hosted elsewhere. For more information, see "[Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)."
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
@@ -158,7 +163,7 @@ You can search repositories based on whether or not they're a mirror and are hos
|
||||
|
||||
### Search based on whether a repository is archived
|
||||
|
||||
You can search repositories based on whether or not they're [archived](/articles/about-archiving-repositories).
|
||||
You can search repositories based on whether or not the repositories are archived. For more information, see "[About archiving repositories](/github/creating-cloning-and-archiving-repositories/about-archiving-repositories)."
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
@@ -166,6 +171,7 @@ You can search repositories based on whether or not they're [archived](/articles
|
||||
| `archived:false` | [**archived:false GNOME**](https://github.com/search?utf8=%E2%9C%93&q=archived%3Afalse+GNOME&type=) matches repositories that are not archived and contain the word "GNOME."
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
### Search based on number of issues with `good first issue` or `help wanted` labels
|
||||
|
||||
You can search for repositories that have a minimum number of issues labeled `help-wanted` or `good-first-issue` with the qualifiers `help-wanted-issues:>n` and `good-first-issues:>n`. For more information, see "[Encouraging helpful contributions to your project with labels](/github/building-a-strong-community/encouraging-helpful-contributions-to-your-project-with-labels)."
|
||||
@@ -174,6 +180,7 @@ You can search for repositories that have a minimum number of issues labeled `he
|
||||
| ------------- | -------------
|
||||
| `good-first-issues:>n` | [**good-first-issues:>2 javascript**](https://github.com/search?utf8=%E2%9C%93&q=javascript+good-first-issues%3A%3E2&type=) matches repositories with more than two issues labeled `good-first-issue` and that contain the word "javascript."
|
||||
| `help-wanted-issues:>n`|[**help-wanted-issues:>4 react**](https://github.com/search?utf8=%E2%9C%93&q=react+help-wanted-issues%3A%3E4&type=) matches repositories with more than four issues labeled `help-wanted` and that contain the word "React."
|
||||
|
||||
{% endif %}
|
||||
|
||||
### Further reading
|
||||
|
||||
@@ -64,14 +64,15 @@ You can filter issues and pull requests based on whether they're open or closed
|
||||
| `is:open` | [**performance is:open is:issue**](https://github.com/search?q=performance+is%3Aopen+is%3Aissue&type=Issues) matches open issues with the word "performance."
|
||||
| `is:closed` | [**android is:closed**](https://github.com/search?utf8=%E2%9C%93&q=android+is%3Aclosed&type=) matches closed issues and pull requests with the word "android."
|
||||
|
||||
### Search by public or private repository
|
||||
### Filter by repository visibility
|
||||
|
||||
If you're [searching across all of {% data variables.product.product_name %}](https://github.com/search), it can be helpful to filter your results based on whether the repository is public or private. You can do this with `is:public` and `is:private`.
|
||||
You can filter by the visibility of the repository containing the issues and pull requests using the `is` qualifier. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)."
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in all public repositories.
|
||||
| `is:private` | [**is:private cupcake**](https://github.com/search?q=is%3Aprivate&type=Issues) matches issues and pull requests that contain the word "cupcake" in private repositories you have access to.
|
||||
| Qualifier | Example
|
||||
| ------------- | ------------- |{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in public repositories.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
|
||||
| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Issues) matches issues and pull requests in internal repositories.{% endif %}
|
||||
| `is:private` | [**is:private cupcake**](https://github.com/search?q=is%3Aprivate+cupcake&type=Issues) matches issues and pull requests that contain the word "cupcake" in private repositories you can access.
|
||||
|
||||
### Search by author
|
||||
|
||||
@@ -166,7 +167,7 @@ You can use the `project` qualifier to find issues that are associated with a sp
|
||||
|
||||
### Search by commit status
|
||||
|
||||
You can filter pull requests based on the status of the commits. This is especially useful if you are using [the Status API](/v3/repos/statuses/) or a CI service.
|
||||
You can filter pull requests based on the status of the commits. This is especially useful if you are using [the Status API](/rest/reference/repos#statuses) or a CI service.
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
|
||||
@@ -40,7 +40,7 @@ Some IdPs support provisioning access to a {% data variables.product.prodname_d
|
||||
|
||||
### Adding members to an organization using SAML SSO
|
||||
|
||||
After you enable SAML SSO, there are multiple ways you can add new members to your organization. Organization owners can invite new members manually on {% data variables.product.product_name %} or using the API. For more information, see "[Inviting users to join your organization](/articles/inviting-users-to-join-your-organization)" and "[Members](/v3/orgs/members/#add-or-update-organization-membership)."
|
||||
After you enable SAML SSO, there are multiple ways you can add new members to your organization. Organization owners can invite new members manually on {% data variables.product.product_name %} or using the API. For more information, see "[Inviting users to join your organization](/articles/inviting-users-to-join-your-organization)" and "[Members](/rest/reference/orgs#add-or-update-organization-membership)."
|
||||
|
||||
{% data reusables.organizations.team-synchronization %}
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ If you use [SAML SSO](/articles/about-identity-and-access-management-with-saml-s
|
||||
|
||||
If you use SAML SSO without implementing SCIM, you won't have automatic deprovisioning. When organization members' sessions expire after their access is removed from the IdP, they aren't automatically removed from the organization. Authorized tokens grant access to the organization even after their sessions expire. To remove access, organization administrators can either manually remove the authorized token from the organization or automate its removal with SCIM.
|
||||
|
||||
These identity providers are compatible with the {% data variables.product.product_name %} SCIM API for organizations. For more information, see [SCIM](/v3/scim/) in the {% data variables.product.product_name %} API documentation.
|
||||
These identity providers are compatible with the {% data variables.product.product_name %} SCIM API for organizations. For more information, see [SCIM](/rest/reference/scim) in the {% data variables.product.product_name %} API documentation.
|
||||
- Azure AD
|
||||
- Okta
|
||||
- OneLogin
|
||||
|
||||
@@ -37,8 +37,8 @@ For instance, the organization news feed shows updates when someone in the organ
|
||||
- Submits a pull request review comment.
|
||||
- Forks a repository.
|
||||
- Creates a wiki page.
|
||||
- Pushes commits.
|
||||
- Creates a public repository.
|
||||
- Pushes commits.{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
- Creates a public repository.{% endif %}
|
||||
|
||||
### Further information
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user