1
0
mirror of synced 2025-12-23 03:44:00 -05:00

Merge branch 'main' into patch-1

This commit is contained in:
Laura Coursen
2020-12-11 08:27:24 -06:00
committed by GitHub
619 changed files with 11846 additions and 2561 deletions

View File

@@ -80,6 +80,8 @@ When {% data variables.product.prodname_secret_scanning %} detects a secret in a
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)."
To monitor results from {% data variables.product.prodname_secret_scanning %} across your private repositories or your organization, you can use the {% data variables.product.prodname_secret_scanning %} API. For more information about API endpoints, see "[{% data variables.product.prodname_secret_scanning_caps %}](/rest/reference/secret-scanning)."
{% data variables.product.product_name %} currently scans private repositories for secrets issued by the following service providers.
- Adafruit

View File

@@ -0,0 +1,20 @@
---
title: Enabling or disabling GitHub Discussions for a repository
intro: 'You can use discussions in a repository as a place for your community to have conversations, ask questions, and post answers without scoping work in an issue.'
product: '{% data reusables.gated-features.discussions %}'
permissions: People with admin permissions to a repository can enable discussions for the repository.
versions:
free-pro-team: '*'
---
{% data reusables.discussions.beta %}
### Enabling or disabling discussions for your repository
{% data reusables.discussions.enabling-or-disabling-github-discussions-for-your-repository %}
1. To disable discussions, under "Features", unselect **Discussions**.
### Further reading
- "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)"
- "[Managing discussions for your community](/discussions/managing-discussions-for-your-community)"

View File

@@ -22,7 +22,8 @@ versions:
{% link_in_list /viewing-deployment-activity-for-your-repository %}
{% link_in_list /managing-the-forking-policy-for-your-repository %}
{% 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 /disabling-or-limiting-github-actions-for-a-repository %}{% if currentVersion == "free-pro-team@latest" %}
{% link_in_list /enabling-or-disabling-github-discussions-for-a-repository %}{% endif %}
{% link_in_list /managing-git-lfs-objects-in-archives-of-your-repository %}
{% link_in_list /enabling-anonymous-git-read-access-for-a-repository %}
{% link_in_list /configuring-autolinks-to-reference-external-resources %}
@@ -65,7 +66,7 @@ versions:
{% 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-alerts-from-secret-scanning %}
{% link_in_list /managing-security-and-analysis-settings-for-your-repository %}
{% topic_link_in_list /keeping-your-dependencies-updated-automatically %}
{% link_in_list /about-dependabot-version-updates %}

View File

@@ -179,7 +179,7 @@ An overview of some of the most common actions that are recorded as events in th
| `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_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor)")
| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/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)")

View File

@@ -52,6 +52,7 @@ versions:
{% 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 %}
{% link_in_list /reviewing-dependency-changes-in-a-pull-request %}
{% link_in_list /incorporating-feedback-in-your-pull-request %}
{% link_in_list /approving-a-pull-request-with-required-reviews %}
{% link_in_list /dismissing-a-pull-request-review %}

View File

@@ -0,0 +1,74 @@
---
title: Reviewing dependency changes in a pull request
intro: 'If a pull request contains changes to dependencies, you can view a summary of what has changed and whether there are known vulnerabilities in any of the dependencies.'
versions:
free-pro-team: '*'
---
{% note %}
**Note:** Dependency review is currently in beta and subject to change.
{% endnote %}
### About dependency review
If a pull request targets your repository's default branch and contains changes to package manifests or lock files, you can display a dependency review to see what has changed. The dependency review includes details of changes to indirect dependencies in lock files, and it tells you if any of the added or updated dependencies contain known vulnerabilities.
Dependency review is available in:
* All public repositories.
* Private repositories owned by organizations with an {% data variables.product.prodname_advanced_security %} license that have the dependency graph enabled. For more information, see "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)."
Sometimes you might just want to update the version of one dependency in a manifest and generate a pull request. However, if the updated version of this direct dependency also has updated dependencies, your pull request may have more changes than you expected. The dependency review for each manifest and lock file provides an easy way to see what has changed, and whether any of the new dependency versions contain known vulnerabilities.
By checking the dependency reviews in a pull request, and changing any dependencies that are flagged as vulnerable, you can avoid vulnerabilities being added to your project. {% data variables.product.prodname_dependabot_alerts %} will find vulnerabilities that are already in your dependencies, but it's much better to avoid introducing potential problems than to fix them at some later date. For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."
Dependency review supports the same languages and package management ecosystems as the dependency graph. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)."
### Reviewing dependencies in a pull request
{% data reusables.repositories.sidebar-pr %}
{% data reusables.repositories.choose-pr-review %}
{% data reusables.repositories.changed-files %}
1. If the pull request contains many files, use the **File filter** drop-down menu to collapse all files that don't record dependencies. This will make it easier to focus your review on the dependency changes.
![The file filter menu](/assets/images/help/pull_requests/file-filter-menu-json.png)
1. On the right of the header for a manifest or lock file, display the dependency review by clicking the rich diff button.
![The rich diff button](/assets/images/help/pull_requests/dependency-review-rich-diff.png)
{% note %}
**Note:** The dependency review provides a clearer view of what has changed in large lock files, where the source diff is not rendered by default.
{% endnote %}
1. Check the dependencies listed in the dependency review.
![Vulnerability warnings in a dependency review](/assets/images/help/pull_requests/dependency-review-vulnerability.png)
Any added or changed dependencies that have vulnerabilities are listed first, ordered by severity and then by dependency name. This means that the highest severity dependencies are always at the top of a dependency review. Other dependencies are listed alphabetically by dependency name.
The icon beside each dependency indicates whether the dependency has been added (<span style="color:#22863a">{% octicon "diff-added" aria-label="Dependency added icon" %}</span>), updated (<span style="color:#b08800">{% octicon "diff-modified" aria-label="Dependency modified icon" %}</span>), or removed (<span style="color:#cb2431">{% octicon "diff-removed" aria-label="Dependency removed icon" %}</span>) in this pull request.
Other information includes:
* The version, or version range, of the new, updated, or deleted dependency.
* For a specific version of a dependency:
* The age of that release of the dependency.
* The number of projects that are dependent on this software. This information is taken from the dependency graph. Checking the number of dependents can help you avoid accidentally adding the wrong dependency.
* The license used by this dependency, if this information is available. This is useful if you want to avoid code with certain licenses being used in your project.
Where a dependency has a known vulnerability, the warning message includes:
* A brief description of the vulnerability.
* A Common Vulnerabilities and Exposures (CVE) or {% data variables.product.prodname_security_advisories %} (GHSA) identification number. You can click this ID to find out more about the vulnerability.
* The severity of the vulnerability.
* The version of the dependency in which the vulnerability was fixed. If you are reviewing a pull request for someone, you might ask the contributor to update the dependency to the patched version, or a later release.
1. You can return to the original view of the file by clicking the source diff button.
![The source diff button](/assets/images/help/pull_requests/dependency-review-source-diff.png)

View File

@@ -30,6 +30,18 @@ Before you submit your review, your line comments are _pending_ and only visible
![Cancel review button](/assets/images/help/pull_requests/cancel-review-button.png)
{% if currentVersion == "free-pro-team@latest" %}
### Reviewing dependency changes
If the pull request contains changes to dependencies you can use the dependency review for a manifest or lock file to see what has changed and check whether the changes introduce security vulnerabilities. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)."
{% data reusables.repositories.changed-files %}
1. On the right of the header for a manifest or lock file, display the dependency review by clicking the rich diff button.
![The rich diff button](/assets/images/help/pull_requests/dependency-review-rich-diff.png)
{% endif %}
### Marking a file as viewed
After you finish reviewing a file, you can mark the file as viewed, and the file will collapse. If the file changes after you view the file, it will be unmarked as viewed.
@@ -56,8 +68,5 @@ After you've finished reviewing all the files you want in the pull request, subm
### Further reading
- "[About pull request reviews](/articles/about-pull-request-reviews)"
- "[About required reviews for pull requests](/articles/about-required-reviews-for-pull-requests)"
- "[Approving a pull request with required reviews](/articles/approving-a-pull-request-with-required-reviews)"
- "[Commenting on a pull request](/articles/commenting-on-a-pull-request)"
- "[Filtering pull requests by review status](/articles/filtering-pull-requests-by-review-status)"
- "[About required reviews for pull requests](/github/administering-a-repository/about-required-reviews-for-pull-requests)"
- "[Filtering pull requests by review status](/github/managing-your-work-on-github/filtering-pull-requests-by-review-status)"

View File

@@ -39,9 +39,9 @@ For code owners to receive review requests, the CODEOWNERS file must be on the b
### CODEOWNERS syntax
A CODEOWNERS file uses a pattern that follows the same rules used in [gitignore](https://git-scm.com/docs/gitignore#_pattern_format) files. The pattern is followed by one or more {% data variables.product.prodname_dotcom %} usernames or team names using the standard `@username` or `@org/team-name` format. You can also refer to a user by an email address that has been added to their {% data variables.product.product_name %} account, for example `user@example.com`.
A CODEOWNERS file uses a pattern that follows most of the same rules used in [gitignore](https://git-scm.com/docs/gitignore#_pattern_format) files, with [some exceptions](#syntax-exceptions). The pattern is followed by one or more {% data variables.product.prodname_dotcom %} usernames or team names using the standard `@username` or `@org/team-name` format. You can also refer to a user by an email address that has been added to their {% data variables.product.product_name %} account, for example `user@example.com`.
If any line in your CODEOWNERS file contains invalid syntax, the file will not be detected and will not be used to request reviews. Invalid syntax includes inline comments and user or team names that do not exist on {% data variables.product.product_name %}.
If any line in your CODEOWNERS file contains invalid syntax, the file will not be detected and will not be used to request reviews.
#### Example of a CODEOWNERS file
```
# This is a comment.
@@ -83,6 +83,13 @@ apps/ @octocat
# subdirectories.
/docs/ @doctocat
```
#### Syntax exceptions
There are some syntax rules for gitignore files that do not work in CODEOWNERS files:
- Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment
- Using `!` to negate a pattern
- Using `[ ]` to define a character range
### Further reading

View File

@@ -1,6 +1,6 @@
---
title: About repositories
intro: A repository is like a folder for your project. Your project's repository contains all of your project's files and stores each file's revision history. You can also discuss and manage your project's work within the repository.
intro: A repository contains all of your project's files and each file's revision history. You can discuss and manage your project's work within the repository.
redirect_from:
- /articles/about-repositories
versions:
@@ -21,9 +21,11 @@ With {% data variables.product.prodname_free_team %} for user accounts and organ
Each person and organization can own unlimited repositories and invite an unlimited number of collaborators to all repositories.
{% endif %}
You can collaborate on your project with others using your repository's issues, pull requests, and project boards.
![Main page of the octocat/Hello-World repository](/assets/images/help/repository/repo-main-page.png)
You can use repositories to manage your work and collaborate with others.
- You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[About issues](/github/managing-your-work-on-github/about-issues)."
- {% data reusables.discussions.you-can-use-discussions %}
- You can use pull requests to propose changes to a repository. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)."
- You can use project boards to organize and prioritize your issues and pull requests. For more information, see "[About project boards](/github/managing-your-work-on-github/about-project-boards)."
{% data reusables.repositories.repo-size-limit %}

View File

@@ -46,16 +46,16 @@ typing `git remote -v`:
```shell
$ git remote -v
# View existing remotes
> origin https://github.com/github/reactivecocoa.git (fetch)
> origin https://github.com/github/reactivecocoa.git (push)
> origin https://github.com/ghost/reactivecocoa.git (fetch)
> origin https://github.com/ghost/reactivecocoa.git (push)
$ git remote set-url origin https://github.com/github/ReactiveCocoa.git
$ git remote set-url origin https://github.com/ghost/ReactiveCocoa.git
# Change the 'origin' remote's URL
$ git remote -v
# Verify new remote URL
> origin https://github.com/github/ReactiveCocoa.git (fetch)
> origin https://github.com/github/ReactiveCocoa.git (push)
> origin https://github.com/ghost/ReactiveCocoa.git (fetch)
> origin https://github.com/ghost/ReactiveCocoa.git (push)
```
Alternatively, you can change the URL through our
@@ -73,7 +73,7 @@ When prompted for a username and password, make sure you use an account that has
{% tip %}
**Tip**: If you don't want to enter your credentials every time you interact with the remote repository, you can turn on [credential caching](/github/using-git/caching-your-github-credentials-in-git). If you are already using credential caching, please make sure that your computer has the correct credentials cached. Incorrect or out of date credentials will cause authentication to fail.
**Tip**: If you don't want to enter your credentials every time you interact with the remote repository, you can turn on [credential caching](/github/using-git/caching-your-github-credentials-in-git). If you are already using credential caching, please make sure that your computer has the correct credentials cached. Incorrect or out of date credentials will cause authentication to fail.
{% endtip %}

View File

@@ -7,26 +7,27 @@ versions:
free-pro-team: '*'
---
You can discover, browse, and install free and paid tools, including [{% data variables.product.prodname_github_app %}s, {% data variables.product.prodname_oauth_app %}s](/apps/differences-between-apps/), and {% data variables.product.prodname_actions %}, in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace).
You can discover, browse, and install free and paid tools, including {% data variables.product.prodname_github_app %}s, {% data variables.product.prodname_oauth_app %}s, and {% data variables.product.prodname_actions %}, in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace).
If you purchase a paid tool, you'll pay for your tool subscription with the same billing information you use to pay for your {% data variables.product.product_name %} subscription, and receive one bill on your regular billing date. For more information, see "[About billing for {% data variables.product.prodname_marketplace %}](/articles/about-billing-for-github-marketplace)."
You may also have the option to select a free 14-day trial on select tools. You can cancel at any time during your trial and you won't be charged, but you will automatically lose access to the tool. Your paid subscription will start at the end of the 14-day trial. For more information, see "[About billing for {% data variables.product.prodname_marketplace %}](/articles/about-billing-for-github-marketplace)."
You may also have the option to select a free 14-day trial on some tools. You can cancel at any time during your trial and you won't be charged, but you will automatically lose access to the tool. Your paid subscription will start at the end of the 14-day trial. For more information, see "[About billing for {% data variables.product.prodname_marketplace %}](/articles/about-billing-for-github-marketplace)."
{% data variables.product.prodname_github_app %}s and {% data variables.product.prodname_oauth_app %}s can be verified or unverified. Verified apps meet specific requirements set by {% data variables.product.prodname_dotcom %} and go through a security review before they are listed on {% data variables.product.prodname_marketplace %}. For more information, see "[Requirements for listing an app on GitHub Marketplace](/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace/)."
### Finding tools on {% data variables.product.prodname_marketplace %}
### {% data variables.product.prodname_actions %} on {% data variables.product.prodname_marketplace %}
You can discover, browse, and install apps and actions created by others on {% data variables.product.prodname_marketplace %}, see "[Searching {% data variables.product.prodname_marketplace %}](/github/searching-for-information-on-github/searching-github-marketplace)."
You can discover, browse, and install {% data variables.product.prodname_actions %} created by others on {% data variables.product.prodname_marketplace %}, see "[Searching {% data variables.product.prodname_marketplace %}](/github/searching-for-information-on-github/searching-github-marketplace)."
{% data reusables.actions.actions-not-verified %}
Anyone can list an action on {% data variables.product.prodname_marketplace %}. Unlike some apps, {% data variables.product.prodname_actions %} listed on {% data variables.product.prodname_marketplace %} are never verified by {% data variables.product.prodname_dotcom %}.
Anyone can list a free {% data variables.product.prodname_github_app %} or {% data variables.product.prodname_oauth_app %} on {% data variables.product.prodname_marketplace %}. Publishers of paid apps are verified by {% data variables.product.company_short %} and listings for these apps are shown with a verified creator badge {% octicon "verified" aria-label="Verified creator badge" %}. You will also see badges for unverified and verified apps. These apps were published using the previous method for verifying individual apps. For more information about the current process, see "[About verified creators](/developers/github-marketplace/about-verified-creators)" and "[Requirements for listing an app](/developers/github-marketplace/requirements-for-listing-an-app)."
### Building and listing a tool on {% data variables.product.prodname_marketplace %}
For more information on creating your own tool to list on {% data variables.product.prodname_marketplace %}, see "[Apps](/apps)" and "[{% data variables.product.prodname_actions %}](/actions)."
For more information on creating your own tool to list on {% data variables.product.prodname_marketplace %}, see "[Apps](/developers/apps)" and "[{% data variables.product.prodname_actions %}](/actions)."
### Further reading
- "[Purchasing and installing apps in {% data variables.product.prodname_marketplace %}](/articles/purchasing-and-installing-apps-in-github-marketplace)"
- "[Managing billing for {% data variables.product.prodname_marketplace %} apps](/articles/managing-billing-for-github-marketplace-apps)"
- "[{% data variables.product.prodname_marketplace %} support](/articles/github-marketplace-support)"
- "[Differences between GitHub Apps and OAuth Apps](/developers/apps/differences-between-github-apps-and-oauth-apps)"

View File

@@ -44,11 +44,11 @@ Scanning code when someone pushes a change, and whenever a pull request is creat
#### Scanning on push
By default, the {% data variables.product.prodname_codeql_workflow %} uses the `on.push` event to trigger a code scan on every push to the default branch of the repository and any protected branches. For {% data variables.product.prodname_code_scanning %} to be triggered on a specified branch, the workflow must exist in that branch. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#on)."
By default, the {% data variables.product.prodname_codeql_workflow %} uses the `on.push` event to trigger a code scan on every push to the default branch of the repository and any protected branches. For {% data variables.product.prodname_code_scanning %} to be triggered on a specified branch, the workflow must exist in that branch. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#on)."
#### Scanning pull requests
The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% if currentVersion ver_gt "enterprise-server@2.21" %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %}
The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% if currentVersion ver_gt "enterprise-server@2.21" %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %}
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)."
@@ -148,14 +148,14 @@ jobs:
matrix:
language: ['javascript', 'python']
```
If your workflow does not contain a matrix called `language`, then {% data variables.product.prodname_codeql %} is configured to run analysis sequentially. If you don't specify languages in the workflow, {% data variables.product.prodname_codeql %} automatically detects, and attempts to analyze, any supported languages in the repository. If you want to choose which languages to analyze, without using a matrix, you can use the `languages` parameter under the `init` action.
```yaml
- uses: github/codeql-action/init@v1
with:
languages: cpp, csharp, python
```
```
{% if currentVersion == "free-pro-team@latest" %}
### Analyzing Python dependencies
@@ -183,7 +183,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
if [ -f requirements.txt ];
if [ -f requirements.txt ];
then pip install -r requirements.txt;
fi
# Set the `CODEQL-PYTHON` environment variable to the Python executable
@@ -193,10 +193,10 @@ jobs:
uses: github/codeql-action/init@v1
with:
languages: python
# Override the default behavior so that the action doesn't attempt
# Override the default behavior so that the action doesn't attempt
# to auto-install Python dependencies
setup-python-dependencies: false
```
```
{% endif %}
### Running additional queries
@@ -239,7 +239,7 @@ In the workflow file, use the `config-file` parameter of the `init` action to sp
```
The configuration file can be located within the local repository, or in a public, remote repository. For remote repositories, you can use the _owner/repository/file.yml@branch_ syntax. The settings in the file are written in YAML format.
#### Specifying additional queries
You specify additional queries in a `queries` array. Each element of the array contains a `uses` parameter with a value that identifies a single query file, a directory containing query files, or a query suite definition file.
@@ -265,15 +265,15 @@ For the interpreted languages that {% data variables.product.prodname_codeql %}
``` yaml
paths:
- src
paths-ignore:
- src
paths-ignore:
- src/node_modules
- '**/*.test.js'
```
{% note %}
**Note**:
**Note**:
* The `paths` and `paths-ignore` keywords, used in the context of the {% data variables.product.prodname_code_scanning %} configuration file, should not be confused with the same keywords when used for `on.<push|pull_request>.paths` in a workflow. When they are used to modify `on.<push|pull_request>` in a workflow, they determine whether the actions will be run when someone modifies code in the specified directories. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)."
* `**` characters can only be at the start or end of a line, or surrounded by slashes, and you can't mix `**` and other characters. For example, `foo/**`, `**/foo`, and `foo/**/bar` are all allowed syntax, but `**foo` isn't. However you can use single stars along with other characters, as shown in the example. You'll need to quote anything that contains a `*` character.
@@ -298,7 +298,7 @@ You can quickly analyze small portions of a monorepo when you modify code in spe
If your workflow for {% data variables.product.prodname_code_scanning %} accesses a private repository, other than the repository that contains the workflow, you'll need to configure Git to authenticate with a personal access token. Define the secret in the runner environment by using `jobs.<job_id>.steps.env` in your workflow before any {% data variables.product.prodname_codeql %} actions. For more information, see "[Creating a personal access token for the command line](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)" and "[Creating and storing encrypted secrets](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)."
For example, the following configuration has Git replace the full URLs to the `github/foo`, `github/bar`, and `github/baz` repositories on {% data variables.product.prodname_dotcom_the_website %} with URLs that include the personal access token that you store in the `ACCESS_TOKEN` environment variable.
For example, the following configuration has Git replace the full URLs to the `ghost/foo`, `ghost/bar`, and `ghost/baz` repositories on {% data variables.product.prodname_dotcom_the_website %} with URLs that include the personal access token that you store in the `ACCESS_TOKEN` environment variable.
{% raw %}
```yaml
@@ -307,9 +307,9 @@ steps:
env:
TOKEN: ${{ secrets.ACCESS_TOKEN }}
run: |
git config --global url."https://${TOKEN}@github.com/github/foo".insteadOf "https://github.com/github/foo"
git config --global url."https://${TOKEN}@github.com/github/bar".insteadOf "https://github.com/github/bar"
git config --global url."https://${TOKEN}@github.com/github/baz".insteadOf "https://github.com/github/baz"
git config --global url."https://${TOKEN}@github.com/ghost/foo".insteadOf "https://github.com/ghost/foo"
git config --global url."https://${TOKEN}@github.com/ghost/bar".insteadOf "https://github.com/ghost/bar"
git config --global url."https://${TOKEN}@github.com/ghost/baz".insteadOf "https://github.com/ghost/baz"
```
{% endraw %}

View File

@@ -14,7 +14,7 @@ versions:
### About SARIF support
SARIF (Static Analysis Results Interchange Format) is an [OASIS Standard](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) that defines an output file format. The SARIF standard is used to streamline how static analysis tools share their results. {% data variables.product.prodname_code_scanning_capc %} supports a subset of the SARIF 2.1.0 JSON schema.
SARIF (Static Analysis Results Interchange Format) is an [OASIS Standard](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) that defines an output file format. The SARIF standard is used to streamline how static analysis tools share their results. {% data variables.product.prodname_code_scanning_capc %} supports a subset of the SARIF 2.1.0 JSON schema.
To upload a SARIF file from a third-party static code analysis engine, you'll need to ensure that uploaded files use the SARIF 2.1.0 version. {% data variables.product.prodname_dotcom %} will parse the SARIF file and show alerts using the results in your repository as a part of the {% data variables.product.prodname_code_scanning %} experience. For more information, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github)." For more information about the SARIF 2.1.0 JSON schema, see [`sarif-schema-2.1.0.json`](https://github.com/oasis-tcs/sarif-spec/blob/master/Schemata/sarif-schema-2.1.0.json).
@@ -51,7 +51,7 @@ Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.pr
| Name | Description |
|----|----|
| `$schema` | **Required.** The URI of the SARIF JSON schema for version 2.1.0. For example, `https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json`. |
| `version` | **Required.** {% data variables.product.prodname_code_scanning_capc %} only supports SARIF version `2.1.0`.
| `version` | **Required.** {% data variables.product.prodname_code_scanning_capc %} only supports SARIF version `2.1.0`.
| `runs[]` | **Required.** A SARIF file contains an array of one or more runs. Each run represents a single run of an analysis tool. For more information about a `run`, see the [`run` object](#run-object).
#### `run` object
@@ -61,7 +61,7 @@ Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.pr
| Name | Description |
|----|----|
| `tool.driver.name` | **Required.** The name of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} displays the name on {% data variables.product.prodname_dotcom %} to allow you to filter results by tool. |
| `tool.driver.version` | **Optional.** The version of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} uses the version number to track when results may have changed due to a tool version change rather than a change in the code being analyzed. If the SARIF file includes the `semanticVersion` field, `version` is not used by {% data variables.product.prodname_code_scanning %}. |
| `tool.driver.version` | **Optional.** The version of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} uses the version number to track when results may have changed due to a tool version change rather than a change in the code being analyzed. If the SARIF file includes the `semanticVersion` field, `version` is not used by {% data variables.product.prodname_code_scanning %}. |
| `tool.driver.semanticVersion` | **Optional.** The version of the analysis tool, specified by the Semantic Versioning 2.0 format. {% data variables.product.prodname_code_scanning_capc %} uses the version number to track when results may have changed due to a tool version change rather than a change in the code being analyzed. If the SARIF file includes the `semanticVersion` field, `version` is not used by {% data variables.product.prodname_code_scanning %}. For more information, see "[Semantic Versioning 2.0.0](https://semver.org/)" in the Semantic Versioning documentation. |
| `tool.driver.rules[]` | **Required.** An array of `reportingDescriptor` objects that represent rules. The analysis tool uses rules to find problems in the code being analyzed. For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). |
| `results[]` | **Required.** The results of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} displays the results on {% data variables.product.prodname_dotcom %}. For more information, see the [`result` object](#result-object).
@@ -73,12 +73,12 @@ Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.pr
| `id` | **Required.** A unique identifier for the rule. The `id` is referenced from other parts of the SARIF file and may be used by {% data variables.product.prodname_code_scanning %} to display URLs on {% data variables.product.prodname_dotcom %}. |
| `name` | **Optional.** The name of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the name to allow results to be filtered by rule on {% data variables.product.prodname_dotcom %}. |
| `shortDescription.text` | **Required.** A concise description of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the short description on {% data variables.product.prodname_dotcom %} next to the associated results.
| `fullDescription.text` | **Required.** A description of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the full description on {% data variables.product.prodname_dotcom %} next to the associated results. The max number of characters is limited to 1000.
| `fullDescription.text` | **Required.** A description of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the full description on {% data variables.product.prodname_dotcom %} next to the associated results. The max number of characters is limited to 1000.
| `defaultConfiguration.level` | **Optional.** Default severity level of the rule. {% data variables.product.prodname_code_scanning_capc %} uses severity levels to help you understand how critical the result is for a given rule. This value can be overridden by the `level` attribute in the `result` object. For more information, see the [`result` object](#result-object). Default: `warning`.
| `help.text` | **Required.** Documentation for the rule using text format. {% data variables.product.prodname_code_scanning_capc %} displays this help documentation next to the associated results.
| `help.markdown` | **Recommended.** Documentation for the rule using Markdown format. {% data variables.product.prodname_code_scanning_capc %} displays this help documentation next to the associated results. When `help.markdown` is available, it is displayed instead of `help.text`.
| `properties.tags[]` | **Optional.** An array of strings. {% data variables.product.prodname_code_scanning_capc %} uses `tags` to allow you to filter results on {% data variables.product.prodname_dotcom %}. For example, it is possible to filter to all results that have the tag `security`.
| `properties.precision` | **Recommended.** A string that indicates how often the results indicated by this rule are true. For example, if a rule has a known high false-positive rate, the precision should be `low`. {% data variables.product.prodname_code_scanning_capc %} orders results by precision on {% data variables.product.prodname_dotcom %} so that the results with the highest `level`, and highest `precision` are shown first. Can be one of: `very-high`, `high`, `medium`, or `low`.
| `properties.precision` | **Recommended.** A string that indicates how often the results indicated by this rule are true. For example, if a rule has a known high false-positive rate, the precision should be `low`. {% data variables.product.prodname_code_scanning_capc %} orders results by precision on {% data variables.product.prodname_dotcom %} so that the results with the highest `level`, and highest `precision` are shown first. Can be one of: `very-high`, `high`, `medium`, or `low`.
#### `result` object
@@ -88,7 +88,7 @@ Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.pr
| `ruleIndex`| **Optional.** The index of the associated rule (`reportingDescriptor` object) in the tool component `rules` array. For more information, see the [`run` object](#run-object).
| `rule`| **Optional.** A reference used to locate the rule (reporting descriptor) for this result. For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object).
| `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}.
| `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited.
| `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited.
| `locations[]`| **Required.** The set of locations where the result was detected. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored.
| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Preventing duplicate alerts using fingerprints](#preventing-duplicate-alerts-using-fingerprints)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`.
| `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object).
@@ -97,7 +97,7 @@ Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.pr
#### `location` object
A location within a programming artifact, such as a file in the repository or a file that was generated during a build.
A location within a programming artifact, such as a file in the repository or a file that was generated during a build.
| Name | Description |
|----|----|
@@ -109,7 +109,7 @@ A location within a programming artifact, such as a file in the repository or a
| Name | Description |
|----|----|
| `artifactLocation.uri`| **Required.** A URI indicating the location of an artifact, usually a file either in the repository or generated during a build. If the URI is relative, it should be relative to the root of the {% data variables.product.prodname_dotcom %} repository being analyzed. For example, main.js or src/script.js are relative to the root of the repository. If the URI is absolute, {% data variables.product.prodname_code_scanning %} can use the URI to checkout the artifact and match up files in the repository. For example, `https://github.com/github/example/blob/00/src/promiseUtils.js`.
| `artifactLocation.uri`| **Required.** A URI indicating the location of an artifact, usually a file either in the repository or generated during a build. If the URI is relative, it should be relative to the root of the {% data variables.product.prodname_dotcom %} repository being analyzed. For example, main.js or src/script.js are relative to the root of the repository. If the URI is absolute, {% data variables.product.prodname_code_scanning %} can use the URI to checkout the artifact and match up files in the repository. For example, `https://github.com/ghost/example/blob/00/src/promiseUtils.js`.
| `region.startLine` | **Required.** The line number of the first character in the region.
| `region.startColumn` | **Required.** The column number of the first character in the region.
| `region.endLine` | **Required.** The line number of the last character in the region.

View File

@@ -9,6 +9,8 @@ versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
authors:
- GitHub
---
### Using Git

View File

@@ -10,8 +10,8 @@ versions:
---
{% for term in site.data.glossaries.external %}
### {{term.term}}
{{term.description}}
### {% data glossaries.external[forloop.index0].term %}
{% data glossaries.external[forloop.index0].description %}
---
{% endfor %}

View File

@@ -1,5 +1,6 @@
---
title: Signing up for a new GitHub account
shortTitle: Sign up for a new GitHub account
intro: '{% data variables.product.product_name %} offers user accounts for individuals and organizations for teams of people working together.'
redirect_from:
- /articles/signing-up-for-a-new-github-account
@@ -9,9 +10,8 @@ versions:
For more information about account types and products, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/articles/types-of-github-accounts)" and "[{% data variables.product.product_name %}'s products](/articles/github-s-products)."
1. Go to {% data variables.product.product_name %}'s [Pricing]({% data variables.product.pricing_url %}) page.
2. Read the information about the different products and subscriptions that {% data variables.product.product_name %} offers, then click the upgrade button under the subscription you'd like to choose.
3. Follow the prompts to create your personal account or organization.
{% data reusables.accounts.create-account %}
1. Follow the prompts to create your personal account or organization.
### Next steps

View File

@@ -64,7 +64,6 @@ versions:
{% link_in_list /working-with-github-pages %}
{% link_in_list /supporting-the-open-source-community-with-github-sponsors %}
{% link_in_list /teaching-and-learning-with-github-education %}
{% link_in_list /finding-talent-with-github-jobs %}
{% link_in_list /working-with-github-support %}
{% link_in_list /understanding-how-github-uses-and-protects-your-data %}

View File

@@ -25,6 +25,8 @@ When your code depends on a package that has a security vulnerability, this vuln
- New advisory data is synchronized to {% data variables.product.prodname_ghe_server %} each hour from {% data variables.product.prodname_dotcom_the_website %}. For more information about advisory data, see "<a href="/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database" class="dotcom-only">Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}</a>."{% endif %}
- The dependency graph for a repository changes. For example, when a contributor pushes a commit to change the packages or versions it depends on{% if currentVersion == "free-pro-team@latest" %}, or when the code of one of the dependencies changes{% endif %}. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."
{% data reusables.repositories.dependency-review %}
For a list of the ecosystems that {% data variables.product.product_name %} can detect vulnerabilities and dependencies for, see "[Supported package ecosystems](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)."
{% note %}

View File

@@ -0,0 +1,25 @@
---
title: About managing vulnerable dependencies
intro: '{% data variables.product.prodname_dotcom %} helps you to avoid using third-party software that contains known vulnerabilities.'
versions:
free-pro-team: '*'
---
{% data variables.product.prodname_dotcom %} provides the following tools for removing and avoiding vulnerable dependencies.
#### Dependency graph
The dependency graph is a summary of the manifest and lock files stored in a repository. It shows you the ecosystems and packages your codebase depends on (its dependencies) and the repositories and packages that depend on your project (its dependents). The information in the dependency graph is used by dependency review and {% data variables.product.prodname_dependabot %}.
For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."
#### Dependency review
By checking the dependency reviews on pull requests you can avoid introducing vulnerabilities from dependencies into your codebase. If the pull requests adds a vulnerable dependency, or changes a dependency to a vulnerable version, this is highlighted in the dependency review. You can change the dependency to a patched version before merging the pull request. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)."
#### {% data variables.product.prodname_dependabot_alerts %}
{% data variables.product.prodname_dotcom %} can create {% data variables.product.prodname_dependabot_alerts %} when it detects vulnerable dependencies in your repository. The alert is displayed on the Security tab for the repository. The alert includes a link to the affected file in the project, and information about a fixed version. {% data variables.product.prodname_dotcom %} also notifies the maintainers of the repository, according to their notification preferences. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
#### {% data variables.product.prodname_dependabot_security_updates %}
When {% data variables.product.prodname_dotcom %} generates a {% data variables.product.prodname_dependabot %} alert for a vulnerable dependency in your repository, {% data variables.product.prodname_dependabot %} can automatically try to fix it for you. {% data variables.product.prodname_dependabot_security_updates %} are automatically generated pull requests that update a vulnerable dependency to a fixed version. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
#### {% data variables.product.prodname_dependabot_version_updates %}
Enabling {% data variables.product.prodname_dependabot_version_updates %} takes the effort out of maintaining your dependencies. With {% data variables.product.prodname_dependabot_version_updates %}, whenever {% data variables.product.prodname_dotcom %} identifies an outdated dependency, it raises a pull request to update the manifest to the latest version of the dependency. By contrast, {% data variables.product.prodname_dependabot_security_updates %} only raises pull requests to fix vulnerable dependencies. For more information, see "[About Dependabot version updates](/github/administering-a-repository/about-dependabot-version-updates)."

View File

@@ -21,6 +21,7 @@ versions:
{% link_in_list /editing-a-security-advisory %}
{% link_in_list /withdrawing-a-security-advisory %}
{% topic_link_in_list /managing-vulnerabilities-in-your-projects-dependencies %}
{% link_in_list /about-managing-vulnerable-dependencies %}
{% link_in_list /browsing-security-vulnerabilities-in-the-github-advisory-database %}
{% link_in_list /about-alerts-for-vulnerable-dependencies %}
{% link_in_list /configuring-notifications-for-vulnerable-dependencies %}

View File

@@ -12,9 +12,11 @@ Your repository's {% data variables.product.prodname_dependabot %} alerts tab li
You can enable automatic security updates for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
{% data reusables.repositories.dependency-review %}
### About updates for vulnerable dependencies in your repository
{% data variables.product.product_name %} generates {% data variables.product.prodname_dependabot_alerts %} when we detect vulnerabilities affecting your repository. For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, when {% data variables.product.product_name %} detects a vulnerable dependency {% data variables.product.prodname_dependabot %} creates a pull request to fix it. The pull request will upgrade the dependency to the minimum possible secure version needed to avoid the vulnerability.
{% data variables.product.product_name %} generates {% data variables.product.prodname_dependabot_alerts %} when we detect that your codebase is using dependencies with known vulnerabilities. For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, when {% data variables.product.product_name %} detects a vulnerable dependency in the default branch, {% data variables.product.prodname_dependabot %} creates a pull request to fix it. The pull request will upgrade the dependency to the minimum possible secure version needed to avoid the vulnerability.
### Viewing and updating vulnerable dependencies

View File

@@ -124,7 +124,8 @@ To filter notifications for specific activity on {% data variables.product.produ
- `is:repository-invitation`{% if currentVersion != "github-ae@latest" %}
- `is:repository-vulnerability-alert`
- `is:repository-advisory`{% endif %}
- `is:team-discussion`
- `is:team-discussion`{% if currentVersion == "free-pro-team@latest" %}
- `is:discussions`{% endif %}
{% if currentVersion != "github-ae@latest" %}
For information about reducing noise from notifications for {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)."

View File

@@ -10,8 +10,14 @@ versions:
github-ae: '*'
---
### About issues
You can collect user feedback, report software bugs, and organize tasks you'd like to accomplish with issues in a repository. Issues can act as more than just a place to report software bugs.
Other conversations are more suitable for discussions. {% data reusables.discussions.you-can-use-discussions %}
{% data reusables.discussions.you-cannot-convert-a-discussion %}
{% data reusables.pull_requests.close-issues-using-keywords %}
To stay updated on the most recent comments in an issue, you can watch an issue to receive notifications about the latest comments. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}."

View File

@@ -25,6 +25,7 @@ With issue and pull request search terms, you can:
- Filter issues and pull requests that involve, but don't necessarily [**@mention**](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams), certain people: `state:open type:issue involves:octocat`
- Filter issues and pull requests by assignee: `state:open type:issue assignee:octocat`
- Filter issues and pull requests by label: `state:open type:issue label:"bug"`
- Filter out search terms by using `-` before the term: `state:open type:issue -author:octocat`
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
For issues, you can also use search to:

View File

@@ -41,7 +41,8 @@ You can search for the following information across all repositories you can acc
- [Repositories](/articles/searching-for-repositories)
- [Topics](/articles/searching-topics)
- [Issues and pull requests](/articles/searching-issues-and-pull-requests)
- [Issues and pull requests](/articles/searching-issues-and-pull-requests){% if currentVersion == "free-pro-team@latest" %}
- [Discussions](/github/searching-for-information-on-github/searching-discussions){% endif %}
- [Code](/articles/searching-code)
- [Commits](/articles/searching-commits)
- [Users](/articles/searching-users){% if currentVersion == "free-pro-team@latest" %}

View File

@@ -25,8 +25,9 @@ versions:
{% link_in_list /searching-topics %}
{% link_in_list /searching-code %}
{% link_in_list /searching-commits %}
{% link_in_list /searching-issues-and-pull-requests %}
{% link_in_list /searching-github-marketplace %}
{% link_in_list /searching-issues-and-pull-requests %}{% if currentVersion == "free-pro-team@latest" %}
{% link_in_list /searching-discussions %}
{% link_in_list /searching-github-marketplace %}{% endif %}
{% link_in_list /searching-users %}
{% link_in_list /searching-for-packages %}
{% link_in_list /searching-wikis %}

View File

@@ -0,0 +1,114 @@
---
title: Searching discussions
intro: You can search for discussions on {% data variables.product.product_name %} and narrow the results using search qualifiers.
versions:
free-pro-team: '*'
---
{% data reusables.discussions.beta %}
### About searching for discussions
You can search for discussions globally across all of {% data variables.product.product_name %}, or search for discussions within a particular organization or repository. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/about-searching-on-github)."
{% data reusables.search.syntax_tips %}
### Search by the title, body, or comments
With the `in` qualifier you can restrict your search for discussions to the title, body, or comments. You can also combine qualifiers to search a combination of title, body, or comments. When you omit the `in` qualifier, {% data variables.product.product_name %} searches the title, body, and comments.
| Qualifier | Example |
| :- | :- |
| `in:title` | [**welcome in:title**](https://github.com/search?q=welcome+in%3Atitle&type=Discussions) matches discussions with "welcome" in the title. |
| `in:body` | [**onboard in:title,body**](https://github.com/search?q=onboard+in%3Atitle%2Cbody&type=Discussions) matches discussions with "onboard" in the title or body. |
| `in:comments` | [**thanks in:comments**](https://github.com/search?q=thanks+in%3Acomment&type=Discussions) matches discussions with "thanks" in the comments for the discussion. |
### Search within a user's or organization's repositories
To search discussions in all repositories owned by a certain user or organization, you can use the `user` or `org` qualifier. To search discussions in a specific repository, you can use the `repo` qualifier.
| Qualifier | Example |
| :- | :- |
| <code>user:<em>USERNAME</em></code> | [**user:octocat feedback**](https://github.com/search?q=user%3Aoctocat+feedback&type=Discussions) matches discussions with the word "feedback" from repositories owned by @octocat. |
| <code>org:<em>ORGNAME</em></code> | [**org:github**](https://github.com/search?q=org%3Agithub&type=Discussions&utf8=%E2%9C%93) matches discussions in repositories owned by the GitHub organization. |
| <code>repo:<em>USERNAME/REPOSITORY</em></code> | [**repo:nodejs/node created:<2021-01-01**](https://github.com/search?q=repo%3Anodejs%2Fnode+created%3A%3C2020-01-01&type=Discussions) matches discussions from @nodejs' Node.js runtime project that were created before January 2021. |
### Filter by repository visibility
You can filter by the visibility of the repository containing the discussions using the `is` qualifier. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)."
| Qualifier | Example
| :- | :- |{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Discussions) matches discussions in public repositories.{% endif %}
| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Discussions) matches discussions in internal repositories.
| `is:private` | [**is:private tiramisu**](https://github.com/search?q=is%3Aprivate+tiramisu&type=Discussions) matches discussions that contain the word "tiramisu" in private repositories you can access.
### Search by author
The `author` qualifier finds discussions created by a certain user.
| Qualifier | Example |
| :- | :- |
| <code>author:<em>USERNAME</em></code> | [**cool author:octocat**](https://github.com/search?q=cool+author%3Aoctocat&type=Discussions) matches discussions with the word "cool" that were created by @octocat. |
| | [**bootstrap in:body author:octocat**](https://github.com/search?q=bootstrap+in%3Abody+author%3Aoctocat&type=Discussions) matches discussions created by @octocat that contain the word "bootstrap" in the body. |
### Search by commenter
The `commenter` qualifier finds discussions that contain a comment from a certain user.
| Qualifier | Example |
| :- | :- |
| <code>commenter:<em>USERNAME</em></code> | [**github commenter:becca org:github**](https://github.com/search?utf8=%E2%9C%93&q=github+commenter%3Abecca+org%3Agithub&type=Discussions) matches discussions in repositories owned by GitHub, that contain the word "github," and have a comment by @becca.
### Search by a user that's involved in a discussion
You can use the `involves` qualifier to find discussions that involve a certain user. The qualifier returns discussions that were either created by a certain user, mention the user, or contain comments by the user. The `involves` qualifier is a logical OR between the `author`, `mentions`, and `commenter` qualifiers for a single user.
| Qualifier | Example |
| :- | :- |
| <code>involves:<em>USERNAME</em></code> | **[involves:becca involves:octocat](https://github.com/search?q=involves%3Abecca+involves%3Aoctocat&type=Discussions)** matches discussions either @becca or @octocat are involved in.
| | [**NOT beta in:body involves:becca**](https://github.com/search?q=NOT+beta+in%3Abody+involves%3Abecca&type=Discussions) matches discussions @becca is involved in that do not contain the word "beta" in the body.
### Search by number of comments
You can use the `comments` qualifier along with greater than, less than, and range qualifiers to search by the number of comments. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)."
| Qualifier | Example |
| :- | :- |
| <code>comments:<em>n</em></code> | [**comments:&gt;100**](https://github.com/search?q=comments%3A%3E100&type=Discussions) matches discussions with more than 100 comments.
| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Discussions) matches discussions with comments ranging from 500 to 1,000.
### Search by number of interactions
You can filter discussions by the number of interactions with the `interactions` qualifier along with greater than, less than, and range qualifiers. The interactions count is the number of reactions and comments on a discussion. For more information, see "[Understanding the search syntax](/github/searching-for-information-on-github/understanding-the-search-syntax)."
| Qualifier | Example |
| :- | :- |
| <code>interactions:<em>n</em></code> | [** interactions:&gt;2000**](https://github.com/search?q=interactions%3A%3E2000) matches discussions with more than 2,000 interactions.
| | [**interactions:500..1000**](https://github.com/search?q=interactions%3A500..1000) matches discussions with interactions ranging from 500 to 1,000.
### Search by number of reactions
You can filter discussions by the number of reactions using the `reactions` qualifier along 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 |
| :- | :- |
| <code>reactions:<em>n</em></code> | [** reactions:&gt;1000**](https://github.com/search?q=reactions%3A%3E500) matches discussions with more than 500 reactions.
| | [**reactions:500..1000**](https://github.com/search?q=reactions%3A500..1000) matches discussions with reactions ranging from 500 to 1,000.
### Search by when a discussion was created or last updated
You can filter discussions based on times of creation, or when the discussion was last updated. For discussion creation, you can use the `created` qualifier; to find out when an discussion was last updated, use the `updated` qualifier.
Both qualifiers take a date as a parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %}
{% data reusables.search.date_gt_lt %}
| Qualifier | Example |
| :- | :- |
| <code>created:<em>YYYY-MM-DD</em></code> | [**created:>2020-11-15**](https://github.com/search?q=created%3A%3E%3D2020-11-15&type=discussions) matches discussions that were created after November 15, 2020.
| <code>updated:<em>YYYY-MM-DD</em></code> | [**weird in:body updated:>=2020-02-01**](https://github.com/search?q=weird+in%3Abody+updated%3A%3E%3D2020-12-01&type=Discussions) matches discussions with the word "weird" in the body that were updated after December 2020.
### Further reading
- "[Sorting search results](/articles/sorting-search-results/)"

View File

@@ -207,7 +207,7 @@ You can use the `comments` qualifier along with [greater than, less than, and ra
| Qualifier | Example
| ------------- | -------------
| <code>comments:<em>n</em></code> | [**state:closed comments:&gt;100**](https://github.com/search?q=state%3Aclosed+comments%3A%3C100&type=Issues) matches closed issues with more than 100 comments.
| <code>comments:<em>n</em></code> | [**state:closed comments:&gt;100**](https://github.com/search?q=state%3Aclosed+comments%3A%3E100&type=Issues) matches closed issues with more than 100 comments.
| | [**comments:500..1000**](https://github.com/search?q=comments%3A500..1000&type=Issues) matches issues with comments ranging from 500 to 1,000.
### Search by number of interactions

View File

@@ -27,7 +27,7 @@ If you want to explore repositories about a certain topic, find projects to cont
The `is:featured` search qualifier will narrow search results to the topics with the most repositories on {% data variables.product.product_name %}. These topics are also featured at https://github.com/topics/.
The `is:curated` search qualifier will narrow search results to topics that community members have added extra information to. For more information, see the explore repository at https://github.com/github/explore.
The `is:curated` search qualifier will narrow search results to topics that community members have added extra information to. For more information, see the [explore repository](https://github.com/github/explore).
You can filter topics based when they were created using the date parameter and `created:` or based on how many repositories are associated with this topic using `repositories:n`. Both of these qualifiers can use the [greater than and less than range qualifiers](/articles/understanding-the-search-syntax).

View File

@@ -9,6 +9,8 @@ versions:
{% data reusables.sponsors.sponsorship-details %}
{% data reusables.sponsors.no-fees %}
{% data reusables.dotcom_billing.view-all-subscriptions %}
### Further reading

View File

@@ -18,11 +18,11 @@ versions:
### Discounts for personal accounts
In addition to the unlimited public and private repositories for students and faculty with {% data variables.product.prodname_free_user %}, verified students can apply for the {% data variables.product.prodname_student_pack %} to receive additional benefits from {% data variables.product.prodname_dotcom %} partners. For more information, see "[Applying for a student developer pack](/articles/applying-for-a-student-developer-pack)."
In addition to the unlimited public and private repositories for students and faculty with {% data variables.product.prodname_free_user %}, verified students can apply for the {% data variables.product.prodname_student_pack %} to receive additional benefits from {% data variables.product.prodname_dotcom %} partners. For more information, see "[Apply for a student developer pack](/education/teach-and-learn-with-github-education/apply-for-a-student-developer-pack)."
### Discounts for schools and universities
Verified academic faculty can apply for {% data variables.product.prodname_team %} for teaching or academic research. For more information, see "[Using {% data variables.product.prodname_dotcom %} in your classroom and research](/articles/using-github-in-your-classroom-and-research)." You can also request educational materials goodies for your students. For more information, visit [{% data variables.product.prodname_education %}](https://education.github.com/).
Verified academic faculty can apply for {% data variables.product.prodname_team %} for teaching or academic research. For more information, see "[Use {% data variables.product.prodname_dotcom %} in your classroom and research](/education/teach-and-learn-with-github-education/use-github-in-your-classroom-and-research)." You can also request educational materials goodies for your students. For more information, visit [{% data variables.product.prodname_education %}](https://education.github.com/).
### Discounts for nonprofits and libraries

View File

@@ -7,25 +7,24 @@ versions:
free-pro-team: '*'
---
{% data reusables.sponsors.org-sponsors-release-phase %}
### About sponsorship downgrades
When you downgrade or cancel a sponsorship, the change will become effective on your next billing date. {% data reusables.sponsors.no-refunds %}
### Downgrading a sponsorship
When you downgrade a sponsorship, the change will become effective on your next billing date. {% data reusables.sponsors.no-refunds %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing %}
{% data reusables.user_settings.subscriptions-tab %}
{% data reusables.sponsors.change-tier %}
4. On the right side of the page, next to your selected tier, click **Edit**.
![Edit tier button](/assets/images/help/billing/edit-tier-button.png)
{% data reusables.sponsors.navigate-to-sponsored-account %}
{% data reusables.sponsors.sponsorship-dashboard %}
{% data reusables.sponsors.select-a-tier %}
{% data reusables.sponsors.update-sponsorship %}
### Canceling a sponsorship
When you cancel a sponsorship, the change will become effective on your next billing date. {% data reusables.sponsors.no-refunds %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing %}
{% data reusables.sponsors.billing-switcher %}
{% data reusables.user_settings.subscriptions-tab %}
3. Under "{% data variables.product.prodname_sponsors %}", to the right of the sponsored open source contributor, click {% octicon "triangle-down" aria-label="The down triangle octicon" %} next to your sponsored amount, then click **Cancel sponsorship**.
![Cancel sponsorship button](/assets/images/help/billing/edit-sponsor-billing.png)

View File

@@ -7,13 +7,15 @@ versions:
free-pro-team: '*'
---
{% data reusables.sponsors.org-sponsors-release-phase %}
### About sponsorship upgrades
When you upgrade your sponsorship tier, the change will become effective immediately. {% data reusables.sponsors.prorated-sponsorship %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing %}
{% data reusables.user_settings.subscriptions-tab %}
{% data reusables.sponsors.change-tier %}
4. On the right side of the page, next to your selected tier, click **Edit**.
![Edit tier button](/assets/images/help/billing/edit-tier-button.png)
### Upgrading a sponsorship
{% data reusables.sponsors.navigate-to-sponsored-account %}
{% data reusables.sponsors.sponsorship-dashboard %}
{% data reusables.sponsors.select-a-tier %}
{% data reusables.sponsors.update-sponsorship %}
{% data reusables.sponsors.update-sponsorship %}

View File

@@ -84,13 +84,15 @@ versions:
{% link_in_list /disabling-or-limiting-github-actions-for-your-organization %}
{% link_in_list /configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization %}
{% link_in_list /setting-permissions-for-adding-outside-collaborators %}
{% link_in_list /allowing-people-to-delete-issues-in-your-organization %}
{% link_in_list /allowing-people-to-delete-issues-in-your-organization %}{% if currentVersion == "free-pro-team@latest" %}
{% link_in_list /managing-discussion-creation-for-repositories-in-your-organization %}{% endif %}
{% link_in_list /setting-team-creation-permissions-in-your-organization %}
{% link_in_list /managing-scheduled-reminders-for-your-organization %}
{% link_in_list /managing-the-default-branch-name-for-repositories-in-your-organization %}
{% link_in_list /managing-default-labels-for-repositories-in-your-organization %}
{% link_in_list /changing-the-visibility-of-your-organizations-dependency-insights %}
{% link_in_list /managing-the-display-of-member-names-in-your-organization %}
{% link_in_list /managing-updates-from-accounts-your-organization-sponsors %}
{% link_in_list /disabling-publication-of-github-pages-sites-for-your-organization %}
{% link_in_list /deleting-an-organization-account %}
{% link_in_list /converting-an-organization-into-a-user %}

View File

@@ -0,0 +1,27 @@
---
title: Managing discussion creation for repositories in your organization
intro: You can choose the permission levels that members require to create discussions in repositories owned by your organization.
permissions: Organization owners can manage discussion creation for repositories owned by the organization.
versions:
free-pro-team: '*'
---
{% data reusables.discussions.beta %}
### Allowing or disallowing users with read access to create discussions
By default, organization members with read access can create discussions if a repository administrator or organization owner enables discussions for a repository owned by the organization.
{% data reusables.profile.access_profile %}
{% data reusables.profile.access_org %}
{% data reusables.organizations.org_settings %}
{% data reusables.organizations.member-privileges %}
5. Under "Repository discussions", select or deselect **Allow users with read access to create discussions**.
![Checkbox to allow people with read access to create discussions](/assets/images/help/discussions/toggle-allow-users-with-read-access-checkbox.png)
6. Click **Save**.
!["Save" button for discussions settings](/assets/images/help/discussions/click-save.png)
### Further reading
- "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)"
- "[Managing discussions for your community](/discussions/managing-discussions-for-your-community)"

View File

@@ -0,0 +1,25 @@
---
title: Managing updates from accounts your organization sponsors
intro: You can manage the email address that receives updates from accounts your organization sponsors.
versions:
free-pro-team: '*'
permissions: Organization owners can manage updates from accounts the organization sponsors.
---
{% data reusables.sponsors.org-sponsors-release-phase %}
The developers and organizations that your organization sponsors can send you updates about their work. You can manage the email address that receives these updates.
You can also disable updates from accounts your organization sponsors. For more information, see "[Managing your sponsorship](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship#managing-email-updates-for-your-sponsorship)."
{% data reusables.profile.access_profile %}
{% data reusables.profile.access_org %}
{% data reusables.organizations.org_settings %}
1. Under "Sponsors update email (Private)", type the email address you want to receive updates from accounts your organization sponsors.
![Textbox to enter the email address to receive updates from sponsored accounts](/assets/images/help/sponsors/organization-update-email-textbox.png)
1. Click **Update profile**.
![Update profile button](/assets/images/help/organizations/update-profile-button.png)
### Further reading
- "[Supporting the open source community with {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors)"

View File

@@ -55,6 +55,9 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late
| Disable team discussions for an organization (see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)" for details) | **X** | | |{% if currentVersion == "free-pro-team@latest" %}
| Manage viewing of organization dependency insights (see "[Changing the visibility of your organization's dependency insights](/articles/changing-the-visibility-of-your-organizations-dependency-insights)" for details) | **X** | | |{% endif %}
| Set a team profile picture in **all teams** (see "[Setting your team's profile picture](/articles/setting-your-team-s-profile-picture)" for details) | **X** | | |
| Sponsor accounts and manage the organization's sponsorships (see "[Sponsoring open-source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)" for details) | **X** | **X** | |
| Manage email updates from sponsored accounts (see "[Managing updates from accounts your organization's sponsors](/github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors)" for details) | **X** | | |
| Attribute your sponsorships to another organization (see "[Attributing sponsorships to your organization](/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization)" for details ) | **X** | | |
| Disable publication of {% data variables.product.prodname_pages %} sites from repositories in the organization (see "[Disabling publication of {% data variables.product.prodname_pages %} sites for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-publication-of-github-pages-sites-for-your-organization)" for details) | **X** | | |
| Manage security and analysis settings (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)" for details) | **X** | | |
| Enable and enforce [SAML single sign-on](/articles/about-identity-and-access-management-with-saml-single-sign-on) | **X** | | |

View File

@@ -114,7 +114,19 @@ In addition to managing organization-level settings, organization owners have ad
| [Delete or transfer repositories out of the organization](/articles/setting-permissions-for-deleting-or-transferring-repositories) | | | | | **X** |
| [Archive repositories](/articles/about-archiving-repositories) | | | | | **X** |{% if currentVersion == "free-pro-team@latest" %}
| Display a sponsor button (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") | | | | | **X** |{% endif %}
| Create autolink references to external resources, like JIRA or Zendesk (see "[Configuring autolinks to reference external resources](/articles/configuring-autolinks-to-reference-external-resources)") | | | | | **X** |
| Create autolink references to external resources, like JIRA or Zendesk (see "[Configuring autolinks to reference external resources](/articles/configuring-autolinks-to-reference-external-resources)") | | | | | **X** |{% if currentVersion == "free-pro-team@latest" %}
| Create [security advisories](/github/managing-security-vulnerabilities/about-github-security-advisories) | | | | | **X** | {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
| [View {% data variables.product.prodname_code_scanning %} alerts on pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests) | **X** | **X** | **X** | **X** | **X** |
| [List, dismiss, and delete {% data variables.product.prodname_code_scanning %} alerts](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository) | | | **X** | **X** | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" %}
| [Enable {% data variables.product.prodname_discussions %}](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository) in a repository | | | | **X** | **X** |
| [Create and edit categories](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository) for {% data variables.product.prodname_discussions %} | | | | **X** | **X** |
| [Move a discussion to a different category](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository) | | | **X** | **X** | **X** |
| [Transfer a discussion](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository) to a new repository| | | **X** | **X** | **X** |
| [Manage pinned discussions](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository) | | | **X** | **X** | **X** |
| [Convert issues to discussions in bulk](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository) | | | **X** | **X** | **X** |
| [Lock and unlock discussions](/discussions/managing-discussions-for-your-community/moderating-discussions) | | **X** | **X** | **X** | **X** |
| [Individually convert issues to discussions](/discussions/managing-discussions-for-your-community/moderating-discussions) | | **X** | **X** | **X** | **X** |
| [Create new discussions and comment on existing discussions](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion) | **X** | **X** | **X** | **X** | **X** |{% endif %}
### Further reading

View File

@@ -81,7 +81,9 @@ Each category has a set of associated actions that you can filter on. For exampl
Use the `created` qualifier to filter events in the audit log based on when they occurred. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %}
{% data reusables.search.date_gt_lt %} For example:
{% data reusables.search.date_gt_lt %}
For example:
* `created:2014-07-08` finds all events that occurred on July 8th, 2014.
* `created:>=2014-07-08` finds all events that occurred on or after July 8th, 2014.
@@ -105,25 +107,53 @@ Using the qualifier `country`, you can filter events in the audit log based on t
{% data reusables.audit_log.exported-log-keys-and-values %}
{% endif %}
### Using the Audit log API
### Using the audit log API
You can interact with the audit log using the GraphQL API{% if currentVersion == "free-pro-team@latest" %} or the REST API{% endif %}.
{% if currentVersion == "free-pro-team@latest" %}
#### Using the GraphQL API
{% endif %}
{% note %}
**Note**: The Audit log API is available for organizations using {% data variables.product.prodname_enterprise %}. {% data reusables.gated-features.more-info-org-products %}
**Note**: The audit log GraphQL API is available for organizations using {% data variables.product.prodname_enterprise %}. {% data reusables.gated-features.more-info-org-products %}
{% endnote %}
To ensure a secure IP and maintain compliance for your organization, you can use the Audit log API to keep copies of your audit log data and monitor:
* Access to your organization or repository settings.
* Changes in permissions.
* Added or removed users in an organization, repository, or team.
* Users being promoted to admin.
* Changes to permissions of a GitHub App.
To ensure a secure IP and maintain compliance for your organization, you can use the audit log GraphQL API to keep copies of your audit log data and monitor:
{% data reusables.audit_log.audit-log-api-info %}
{% if currentVersion == "free-pro-team@latest" %}
Note that you can't retrieve Git events using the GraphQL API.
{% endif %}
The GraphQL response can include data for up to 90 to 120 days.
For example, you can make a GraphQL request to see all the new organization members added to your organization. For more information, see the "[GraphQL API Audit Log](/graphql/reference/interfaces#auditentry/)."
{% if currentVersion == "free-pro-team@latest" %}
#### Using the REST API
{% note %}
**Note**: The audit log REST API is available as a limited beta for users of {% data variables.product.prodname_ghe_cloud %} only. To join the beta, talk to your services or sales contact at {% data variables.product.company_short %}.
{% endnote %}
To ensure a secure IP and maintain compliance for your organization, you can use the audit log REST API to keep copies of your audit log data and monitor:
{% data reusables.audit_log.audit-log-api-info %}
* Git events, such as cloning, fetching, and pushing
{% data reusables.audit_log.audit-log-git-events-retention %}
For more information about the audit log REST API, see "[Organizations](/rest/reference/orgs#get-the-audit-log-for-an-organization)" in the REST API documentation.
{% endif %}
### Audit log actions
An overview of some of the most common actions that are recorded as events in the audit log.
@@ -213,6 +243,28 @@ An overview of some of the most common actions that are recorded as events in th
| `update` | Triggered when [a reply to a team discussion post is edited](/articles/managing-disruptive-comments/#editing-a-comment).
| `destroy` | Triggered when [a reply to a team discussion post is deleted](/articles/managing-disruptive-comments/#deleting-a-comment).
{% if currentVersion == "free-pro-team@latest" %}
#### `git` category actions
{% note %}
**Note:** To access Git events in the audit log, you must use the audit log REST API. This functionality is available as a limited beta for users of {% data variables.product.prodname_ghe_cloud %} only. To join the beta, talk to your services or sales contact at {% data variables.product.company_short %}.
For more information about the audit log REST API, see "[Organizations](/rest/reference/orgs#get-the-audit-log-for-an-organization)" in the REST API documentation.
{% endnote %}
{% data reusables.audit_log.audit-log-git-events-retention %}
| Action | Description
|---------|----------------------------
| `clone` | Triggered when a repository is cloned.
| `fetch` | Triggered when changes are fetched from a repository.
| `push` | Triggered when changes are pushed to a repository.
{% endif %}
#### `hook` category actions
| Action | Description
@@ -500,8 +552,20 @@ For more information, see "[Restricting publication of {% data variables.product
| 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)")
| `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 an account (see "[Sponsoring an open source contributor](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor)")
| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored account (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 organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)")
| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your organizaion](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)")
| `sponsored_developer_profile_update` | Triggered when you edit your sponsored organization 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 organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)")
| `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 organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)")
| `waitlist_join` | Triggered when you join the waitlist to become a sponsored organization (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)")
{% endif %}
{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}

View File

@@ -14,6 +14,7 @@ versions:
{% topic_link_in_list /managing-user-account-settings %}
{% link_in_list /about-your-personal-dashboard %}
{% link_in_list /managing-your-theme-settings %}
{% link_in_list /changing-your-github-username %}
{% link_in_list /merging-multiple-user-accounts %}
{% link_in_list /converting-a-user-into-an-organization %}

View File

@@ -0,0 +1,24 @@
---
title: Managing your theme settings
intro: You can manage how {% data variables.product.product_name %} looks to you by setting a theme preference that either follows your system settings or always uses light mode or dark mode.
versions:
free-pro-team: '*'
---
{% note %}
**Note:** Theme settings is currently in beta and subject to change.
{% endnote %}
For choice and flexibility in how and when you use {% data variables.product.product_name %}, you can configure theme settings to change how {% data variables.product.product_name %} looks to you. You can choose from two themes, light and dark, or you can configure {% data variables.product.product_name %} to follow your system settings. Some developers use dark theme for personal preference, to reduce power consumption on certain devices, or to reduce eye strain in low-light conditions.
{% data reusables.user_settings.access_settings %}
1. In the user settings sidebar, click **Appearance**.
!["Apperance" tab in user settings sidebar](/assets/images/help/settings/appearance-tab.png)
1. Under "Theme", select a theme preference.
![Radio buttons for theme settings](/assets/images/help/settings/theme-settings-radio-buttons.png)
### Further reading
- "[Setting a theme for {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/setting-a-theme-for-github-desktop)"

View File

@@ -4,7 +4,7 @@ versions:
free-pro-team: '*'
---
Version Effective Date: November 13, 2020
Version Effective Date: December 7, 2020
When you create an Account, you're given access to lots of different features and products that are all a part of the Service. Because many of these features and products offer different functionality, they may require additional terms and conditions specific to that feature or product. Below, we've listed those features and products, along with the corresponding additional terms that apply to your use of them.
@@ -108,3 +108,13 @@ We need the legal right to submit your contributions to the GitHub Advisory Data
#### b. License to the GitHub Advisory Database
The GitHub Advisory Database is licensed under the [Creative Commons Attribution 4.0 license](https://creativecommons.org/licenses/by/4.0/). The attribution term may be fulfilled by linking to the GitHub Advisory Database at <https://github.com/advisories> or to individual GitHub Advisory Database records used, prefixed by <https://github.com/advisories>.
### 13. GitHub Enterprise Server
#### a. SQL Server Images
You may download Microsoft SQL Server Standard Edition container image for Linux files ("SQL Server Images"). You must uninstall the SQL Server Images when your right to use the Software ends. Microsoft Corporation may disable SQL Server Images at any time.
#### b. Third-party components
The Software includes components licensed to GitHub by third parties, including software whose licenses require GitHub to make the source code for those components available. The source code for such components will be provided upon request.

View File

@@ -7,22 +7,22 @@ redirect_from:
versions:
free-pro-team: '*'
---
**Short version:** GitHub guarantees a 99.9% quarterly uptime commitment for the GitHub Enterprise Cloud service (the “**Service Level**” or “**SLA**”). If GitHub does not meet the SLA, then Customer will be entitled to a service credit to Customers account (“**Service Credits**”).
**Short version:** GitHub guarantees a 99.9% quarterly uptime commitment for the applicable GitHub service (the “**Service Level**” or “**SLA**”). If GitHub does not meet the SLA, then Customer will be entitled to a service credit to Customers account (“**Service Credits**”).
For definitions of each Service feature (“**Service Feature**”) and to review historical and current Uptime, visit the [GitHub Status Page](https://www.githubstatus.com/). Capitalized terms used but not defined in this SLA have the meaning assigned in Customers applicable agreement.
For definitions of each Service feature (“**Service Feature**”) and to review historical and current Uptime, visit the [GitHub Status Page](https://www.githubstatus.com/). Capitalized terms used but not defined in this SLA have the meaning assigned in Customers applicable agreement.
## Uptime Guarantee
“**Uptime**” is the percentage of total possible minutes the Service was available in a given calendar quarter. GitHub commits to maintain at least 99.9% Uptime for the Service. The Uptime calculation for each Service Feature is described below (“**Uptime Calculation**”). If GitHub does not meet the SLA, Customer will be entitled to Service Credits based on the calculation below (“**Service Credits Calculation**”). Note, Downtime does not affect every customer at the same time or in the same way.
“**Uptime**” is the percentage of total possible minutes the applicable GitHub service was available in a given calendar quarter. GitHub commits to maintain at least 99.9% Uptime for the applicable GitHub service. The Uptime calculation for each Service Feature that may be included with the applicable GitHub service is described below (“**Uptime Calculation**”). If GitHub does not meet the SLA, Customer will be entitled to Service Credits based on the calculation below (“**Service Credits Calculation**”). Note, Downtime does not affect every customer at the same time or in the same way.
| **Service Feature** | **Uptime Calculation** | **Definitions** | **Service Credits Calculation** |
|---|---|---|---|
| The **Service** includes the following Service Features: <ul><li>Issues</li><li>Pull Requests</li><li>Git Operations</li><li>API Requests</li><li>Webhooks</li><li>Pages</li><li>Actions</li><li>Packages</li></ul> | (total minutes in a calendar quarter - Downtime) / total minutes in a calendar quarter | “**Downtime**” is a period of time where either (a) the error rate exceeds five percent (5%) in a given minute for any Service Feature or (b) the Service was unavailable as determined by a combination of GitHub's internal and external monitoring systems. | A Service Credits claim may be based on either (not both) of the following calculations: <ul><li>10% of the amount Customer paid for a Service Feature in a calendar quarter where the Uptime for that Service Feature was less than or equal to 99.9%, but greater than 99.0%. <BR><BR>OR <BR><BR></li><li>25% of the amount Customer paid for a Service Feature in a calendar quarter where the Uptime of that Service Feature was less than 99.0%.</li></ul> | |
| **Issues**,<br>**Pull&nbsp;Requests**,<br>**Git&nbsp;Operations**,<br>**API&nbsp;Requests**,<br>**Webhooks**,<br>**Pages** | (total minutes in a calendar quarter - Downtime) / total minutes in a calendar quarter | “**Downtime**” is a period of time where either (a) the error rate exceeds five percent (5%) in a given minute for any Service Feature or (b) the Service was unavailable as determined by a combination of GitHub's internal and external monitoring systems. | A Service Credits claim may be based on either (not both) of the following calculations: <ul><li>10% of the amount Customer paid for a Service Feature in a calendar quarter where the Uptime for that Service Feature was less than or equal to 99.9%, but greater than 99.0%. <BR><BR>OR <BR><BR></li><li>25% of the amount Customer paid for a Service Feature in a calendar quarter where the Uptime of that Service Feature was less than 99.0%.</li></ul> | |
| **Actions** | (Total Triggered Executions Unavailable Executions) / (Total Triggered Executions) x 100 | “**Total Triggered Executions**” is the total number of all Actions executions triggered by Customer in a calendar quarter. <br><br> “**Unavailable Executions**” is the total number of executions within Total Triggered Executions which failed to run in a calendar quarter. An execution failed to run when the Actions history log did not capture any output five (5) minutes after the trigger was successfully fired. | Same as above |
| **Packages** | Transfers Uptime = same as Actions <br> <br> Storage Uptime = 100% - Average Error Rate* <br> <br> *The Uptime Calculation excludes public usage and storage transactions that do not count toward either Total Storage Transactions or Failed Storage Transactions (including pre-authentication failures; authentication failures; attempted transactions for storage accounts over their prescribed quotas). | “**Error Rate**” is the total number of Failed Storage Transactions divided by the Total Storage Transactions during a set time interval (currently set at one hour). If the Total Storage Transactions in a given one-hour interval is zero, the error rate for that interval is 0%. <br><br> “**Average Error Rate**” is the sum of Error Rates for each hour in a calendar quarter divided by the total number of hours in a calendar quarter. | Same as above |
## Exclusions
Excluded from the Uptime Calculation are Service Feature failures resulting from (i) Customers acts, omissions, or misuse of the Service including violations of the Agreement; (ii) failure of Customers internet connectivity; (iii) factors outside GitHub's reasonable control, including force majeure events; or (iv) Customers equipment, services, or other technology.
Excluded from the Uptime Calculation are Service Feature failures resulting from (i) Customers acts, omissions, or misuse of the applicable GitHub service including violations of the Agreement; (ii) failure of Customers internet connectivity; (iii) factors outside GitHub's reasonable control, including force majeure events; or (iv) Customers equipment, services, or other technology.
## Service Credits Redemption
If GitHub does not meet this SLA, Customer may redeem Service Credits only upon written request to GitHub within thirty (30) days of the end of the calendar quarter. Written requests for Service Credits redemption and GitHub Enterprise Cloud custom monthly or quarterly reports should be sent to [GitHub Support](https://support.github.com/contact).

View File

@@ -9,7 +9,9 @@ versions:
### About {% data variables.product.prodname_sponsors %}
{% data reusables.sponsors.sponsorship-details %} {% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)."
{% data reusables.sponsors.sponsorship-details %}
{% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)."
{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors)" and "[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)."
@@ -25,7 +27,7 @@ When you become a sponsored developer or sponsored organization, additional term
{% endnote %}
The {% data variables.product.prodname_matching_fund %} aims to benefit members of the {% data variables.product.prodname_dotcom %} community who develop open source software that promotes the [{% data variables.product.prodname_dotcom %} Community Guidelines](/github/site-policy/github-community-guidelines). Sponsored organizations are not eligible for {% data variables.product.prodname_matching_fund %}.
The {% data variables.product.prodname_matching_fund %} aims to benefit members of the {% data variables.product.prodname_dotcom %} community who develop open source software that promotes the [{% data variables.product.prodname_dotcom %} Community Guidelines](/github/site-policy/github-community-guidelines). Payments to sponsored organizations and payments from organizations are not eligible for {% data variables.product.prodname_matching_fund %}.
To be eligible for the {% data variables.product.prodname_matching_fund %}, you must create a profile that will attract a community that will sustain you for the long term. For more information about creating a strong 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)."
@@ -35,8 +37,6 @@ To be eligible for the {% data variables.product.prodname_matching_fund %}, you
This is just the beginning — we'd love your input to make sure {% data variables.product.prodname_sponsors %} serves your needs into the future. Please send us your feedback or suggestions by contacting [{% data variables.contact.github_support %}](https://support.github.com/contact?form%5Bsubject%5D=GitHub+Sponsors).
Currently, only individual users can sponsor developers and organizations. If your organization is interested in sponsoring developers, please let us know by contacting [{% data variables.contact.github_support %}](https://support.github.com/contact?form%5Bsubject%5D=GitHub+Sponsors).
### Further reading
- "[Sponsoring open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)"
- "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors)"

View File

@@ -0,0 +1,17 @@
---
title: Attributing sponsorships to your organization
intro: 'You can attribute the sponsorships paid by one of your organizations to another organization.'
versions:
free-pro-team: '*'
permissions: People who are organization owners of both organizations can attribute one organization's sponsorships to another organization.
---
1. Navigate to the organization whose sponsorships you want to attribute to another organization.
1. Under your organization name, click {% octicon "heart" aria-label="The heart icon" %} **Sponsoring**.
!["Sponsoring" tab](/assets/images/help/sponsors/sponsoring-tab.png)
1. In the upper-right corner, click {% octicon "gear" aria-label="The gear icon" %} **Settings**.
!["Settings" button](/assets/images/help/sponsors/sponsoring-settings-button.png)
1. Under "Link sponsorships to another account", use the drop-down menu, then click the organization you want this organization's sponsorships to be attributed to.
![Drop-down menu to select account](/assets/images/help/sponsors/select-an-account-drop-down.png)
1. Click **Link account**.
!["Link account" button](/assets/images/help/sponsors/link-account-button.png)

View File

@@ -13,38 +13,20 @@ versions:
{% data reusables.sponsors.maximum-tier %}
### Adding a tier for your sponsored developer profile
### Adding a tier
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsor-tiers-tab %}
{% data reusables.sponsors.click-add-tier %}
{% data reusables.sponsors.tier-price-description %}
{% data reusables.sponsors.save-tier-draft %}
{% data reusables.sponsors.review-and-publish-tier %}
### Adding a tier for your sponsored organization profile
### Editing or retiring a tier
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsor-tiers-tab %}
{% data reusables.sponsors.click-add-tier %}
{% data reusables.sponsors.tier-price-description %}
{% data reusables.sponsors.save-tier-draft %}
{% data reusables.sponsors.review-and-publish-tier %}
### Editing or retiring a tier for your sponsored developer profile
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsor-tiers-tab %}
{% data reusables.sponsors.edit-tier %}
{% data reusables.sponsors.tier-price-description %}
{% data reusables.sponsors.tier-update %}
{% data reusables.sponsors.retire-tier %}
### Editing or retiring a tier for your sponsored organization profile
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsor-tiers-tab %}
{% data reusables.sponsors.edit-tier %}
{% data reusables.sponsors.tier-price-description %}
{% data reusables.sponsors.tier-update %}
{% data reusables.sponsors.retire-tier %}
{% data reusables.sponsors.retire-tier %}

View File

@@ -5,11 +5,13 @@ versions:
free-pro-team: '*'
---
To monitor changes to your sponsorships, such as cancellations at the end of a pay period, you can create webhooks for your sponsored user or organization account. When you set up a webhook for your sponsored user or organization account, you'll receive updates when sponsorships are created, edited, or deleted. For more information, see the [`sponsorship` webhook event](/webhooks/event-payloads/#sponsorship).
### About webhooks for events in your sponsored account
### Managing webhooks for your sponsored user account
To monitor changes to your sponsorships, such as cancellations at the end of a pay period, you can create webhooks for your sponsored user or organization account. When you set up a webhook for your sponsored account, you'll receive updates when sponsorships are created, edited, or deleted. For more information, see the [`sponsorship` webhook event](/webhooks/event-payloads/#sponsorship).
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
### Managing webhooks for events in your sponsored account
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-webhooks-tab %}
{% data reusables.sponsors.add-webhook %}
{% data reusables.sponsors.add-payload-url %}
@@ -17,18 +19,4 @@ To monitor changes to your sponsorships, such as cancellations at the end of a p
{% data reusables.sponsors.webhook-secret-token %}
{% data reusables.sponsors.add-active-triggers %}
{% data reusables.sponsors.confirm-add-webhook %}
{% data reusables.sponsors.manage-existing-webhooks %}
### Managing webhooks for your sponsored organization
Organization owners can configure webhooks for a sponsored organization.
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-webhooks-tab %}
{% data reusables.sponsors.add-webhook %}
{% data reusables.sponsors.add-payload-url %}
{% data reusables.sponsors.webhook-content-formatting %}
{% data reusables.sponsors.webhook-secret-token %}
{% data reusables.sponsors.add-active-triggers %}
{% data reusables.sponsors.confirm-add-webhook %}
{% data reusables.sponsors.manage-existing-webhooks %}
{% data reusables.sponsors.manage-existing-webhooks %}

View File

@@ -7,22 +7,15 @@ versions:
free-pro-team: '*'
---
### About sponsorship updates
Your sponsors can choose whether they receive email updates about your work. For more information, see "[Managing your sponsorship](/articles/managing-your-sponsorship)."
The update will come from your user account's primary email address or organization account's `noreply@github.com` email address. If you've enabled email address privacy on your user account, the update will come from `noreply@github.com` instead. For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)."
For sponsored developer accounts, the update will come from your user account's primary email address. If you've enabled email address privacy on your user account, the update will come from `noreply@github.com` instead. For sponsored organizations, the update will come from the organization's `noreply@github.com` email address. For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)."
### Contacting your user account's sponsors
### Contacting your sponsors
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
{% data reusables.sponsors.sponsors-updates-tab %}
{% data reusables.sponsors.draft-new-update %}
{% data reusables.sponsors.send-update-to-sponsors %}
{% data reusables.sponsors.write-sponsor-update %}
{% data reusables.sponsors.publish-sponsor-update %}
### Contacting your organization's sponsors
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.sponsors-updates-tab %}
{% data reusables.sponsors.draft-new-update %}
{% data reusables.sponsors.send-update-to-sponsors %}

View File

@@ -10,30 +10,17 @@ versions:
### About sponsor profiles
Your {% data variables.product.prodname_sponsors %} profile tells potential sponsors why they should support you. People see your sponsor profile when they click the **Sponsor** button on your personal or organization profile. We recommend including the following information.
Your {% data variables.product.prodname_sponsors %} profile tells potential sponsors why they should support you. People see your sponsor profile when they click the **Sponsor** button on your profile. We recommend including the following information.
- Open source work that you contribute to.
- Why you are committed to open source development.
- Open source work that you contribute to
- Why you are committed to open source development
You can also set goals to explain what different of levels of sponsorship will allow you to do for the community.
### Editing your profile details
### Editing your sponsored developer profile
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-profile-tab %}
{% data reusables.sponsors.short-bio %}
{% data reusables.sponsors.add-introduction %}
{% data reusables.sponsors.edit-featured-work %}
{% data reusables.sponsors.opt-in-to-being-featured %}
{% data reusables.sponsors.save-profile %}
### Editing your sponsored organization profile
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-profile-tab %}
{% data reusables.sponsors.short-bio %}
{% data reusables.sponsors.add-introduction %}
{% data reusables.sponsors.meet-the-team %}
{% data reusables.sponsors.edit-featured-work %}
{% data reusables.sponsors.opt-in-to-being-featured %}
{% data reusables.sponsors.save-profile %}
{% data reusables.sponsors.save-profile %}

View File

@@ -16,6 +16,7 @@ versions:
{% topic_link_in_list /sponsoring-open-source-contributors %}
{% link_in_list /sponsoring-an-open-source-contributor %}
{% link_in_list /managing-your-sponsorship %}
{% link_in_list /attributing-sponsorships-to-your-organization %}
{% topic_link_in_list /receiving-sponsorships-through-github-sponsors %}
{% link_in_list /about-github-sponsors-for-open-source-contributors %}
{% link_in_list /setting-up-github-sponsors-for-your-user-account %}

View File

@@ -13,14 +13,8 @@ You can only manage your payouts from {% data variables.product.prodname_sponsor
{% data reusables.sponsors.payout-info %}
### Viewing and editing payout information for your sponsored user account
### Viewing and editing payout information
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-payouts-tab %}
{% data reusables.sponsors.edit-bank-information %}
### Viewing and editing payout information for your sponsored organization
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-payouts-tab %}
{% data reusables.sponsors.edit-bank-information %}
{% data reusables.sponsors.edit-bank-information %}

View File

@@ -1,27 +1,19 @@
---
title: Managing your sponsorship goal
intro: You can set a goal for your sponsored developer or sponsored organization profile to help the community understand the impact of sponsoring you.
intro: You can set a goal for your sponsored developer or sponsored organization account to help the community understand the impact of sponsoring you.
versions:
free-pro-team: '*'
---
### About sponsorship goals
You can set a funding goal for your sponsored developer or organization profile and share the goal with your community. Goals help you understand the impact you have in the open source community and build up your presence in the {% data variables.product.prodname_sponsors %} program.
You can set a funding goal for your sponsored account and share the goal with your community. Goals help you understand the impact you have in the open source community and build up your presence in the {% data variables.product.prodname_sponsors %} program.
Your goal can set a target for the number of sponsors you want to have or the amount of money you want to earn each month. You can only set one goal up at a time. After you reach a goal, you can set another goal.
### Setting a goal for a sponsored organization
### Setting a goal
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-your-goals-tab %}
{% data reusables.sponsors.set-a-goal %}
{% data reusables.sponsors.select-goal-type %}
{% data reusables.sponsors.publish-goal %}
### Setting a goal for a sponsored developer
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-your-goals-tab %}
{% data reusables.sponsors.set-a-goal %}
{% data reusables.sponsors.select-goal-type %}
@@ -31,6 +23,7 @@ Your goal can set a target for the number of sponsors you want to have or the am
When you edit a goal, you can't choose a goal you've already achieved. For example, if you already have 5 sponsors, you can't edit your goal so that you're aiming for 4 sponsors.
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-your-goals-tab %}
{% data reusables.sponsors.edit-goal %}
{% data reusables.sponsors.select-goal-type %}
@@ -40,6 +33,7 @@ When you edit a goal, you can't choose a goal you've already achieved. For examp
After you retire a goal, you won't be able to reactivate the goal. You must create a new goal instead.
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-your-goals-tab %}
{% data reusables.sponsors.edit-goal %}
{% data reusables.sponsors.retire-goal %}

View File

@@ -1,42 +1,35 @@
---
title: Managing your sponsorship
intro: You can manage who can see your sponsorship and whether you receive email updates from the sponsored open source contributor.
intro: You can manage who can see your sponsorship and whether you receive email updates from the sponsored account.
redirect_from:
- /articles/managing-your-sponsorship
versions:
free-pro-team: '*'
---
For information about changing your sponsorship tier, see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)."
{% data reusables.sponsors.org-sponsors-release-phase %}
### Managing the privacy setting for your developer sponsorship
### Managing the privacy setting for your sponsorship
{% data reusables.sponsors.navigate-to-sponsored-developer %}
{% data reusables.sponsors.manage-developer-sponsorship %}
{% data reusables.sponsors.navigate-to-sponsored-account %}
{% data reusables.sponsors.sponsorship-dashboard %}
{% data reusables.sponsors.manage-sponsorship %}
{% data reusables.sponsors.who-can-see-your-sponsorship %}
{% data reusables.sponsors.update-sponsorship %}
### Managing the privacy setting for your organization sponsorship
### Managing email updates for your sponsorship
{% data reusables.sponsors.navigate-to-sponsored-org %}
{% data reusables.sponsors.manage-org-sponsorship %}
{% data reusables.sponsors.who-can-see-your-sponsorship %}
You can choose whether an account you sponsor can send you email updates about their work. The sponsored account will not have access to your email address.
{% data reusables.sponsors.manage-updates-for-orgs %}
{% data reusables.sponsors.navigate-to-sponsored-account %}
{% data reusables.sponsors.sponsorship-dashboard %}
{% data reusables.sponsors.manage-sponsorship %}
{% data reusables.sponsors.choose-updates %}
{% data reusables.sponsors.update-sponsorship %}
### Managing email updates from a sponsored developer
### Further reading
You can choose whether a sponsored developer can send you email updates about their work. The sponsored developer will not have access to your email address.
{% data reusables.sponsors.navigate-to-sponsored-developer %}
{% data reusables.sponsors.manage-developer-sponsorship %}
{% data reusables.sponsors.developer-sponsored-choose-updates %}
{% data reusables.sponsors.update-sponsorship %}
### Managing email updates from a sponsored organization
You can choose whether a sponsored organization can send you email updates about their work. The sponsored organization will not have access to your email address.
{% data reusables.sponsors.navigate-to-sponsored-org %}
{% data reusables.sponsors.manage-org-sponsorship %}
{% data reusables.sponsors.org-sponsored-choose-updates %}
{% data reusables.sponsors.update-sponsorship %}
- "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)"
- "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)"

View File

@@ -25,7 +25,7 @@ To join {% data variables.product.prodname_sponsors %} as an individual contribu
### Completing your sponsored organization profile
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-profile-tab %}
{% data reusables.sponsors.short-bio %}
{% data reusables.sponsors.add-introduction %}
@@ -40,7 +40,7 @@ To join {% data variables.product.prodname_sponsors %} as an individual contribu
{% data reusables.sponsors.maximum-tier %}
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsor-tiers-tab %}
{% data reusables.sponsors.click-add-tier %}
{% data reusables.sponsors.tier-price-description %}
@@ -54,7 +54,7 @@ As a sponsored organization, you must receive payouts to a dedicated bank accoun
{% data reusables.sponsors.double-check-stripe-info %}
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.create-stripe-account %}
For more information about setting up Stripe Connect using Open Collective, see [Setting up {% data variables.product.prodname_sponsors %}](https://docs.opencollective.com/help/collectives/github-sponsors) in the Open Collective Docs.
@@ -63,7 +63,7 @@ For more information about setting up Stripe Connect using Open Collective, see
{% data reusables.sponsors.tax-form-information-org %}
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.settings-tab %}
{% data reusables.sponsors.country-of-residence %}
{% data reusables.sponsors.overview-tab %}
@@ -75,7 +75,7 @@ Before your organization can become a sponsored organization, you must enable 2F
### Submitting your application to {% data variables.product.prodname_dotcom %} for approval
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.request-approval %}
{% data reusables.sponsors.github-review-app %}

View File

@@ -26,7 +26,7 @@ If you have a bank account in a supported region, {% data variables.product.prod
After {% data variables.product.prodname_dotcom %} reviews your application, you can set up your sponsored developer profile so that people can start sponsoring you.
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-profile-tab %}
{% data reusables.sponsors.short-bio %}
{% data reusables.sponsors.add-introduction %}
@@ -40,7 +40,7 @@ After {% data variables.product.prodname_dotcom %} reviews your application, you
{% data reusables.sponsors.maximum-tier %}
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsor-tiers-tab %}
{% data reusables.sponsors.click-add-tier %}
{% data reusables.sponsors.tier-price-description %}
@@ -54,14 +54,14 @@ If you live in a supported region, you can follow these instructions to submit y
{% data reusables.sponsors.double-check-stripe-info %}
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.create-stripe-account %}
### Submitting your tax information
{% data reusables.sponsors.tax-form-information-dev %}
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.settings-tab %}
{% data reusables.sponsors.country-of-residence %}
{% data reusables.sponsors.overview-tab %}
@@ -73,7 +73,7 @@ Before you can become a sponsored developer, you must enable 2FA on your {% data
### Submitting your application to {% data variables.product.prodname_dotcom %} for approval
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
4. Click **Request approval**.
![Request approval button](/assets/images/help/sponsors/request-approval-button.png)

View File

@@ -7,17 +7,32 @@ redirect_from:
- /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-a-developer
versions:
free-pro-team: '*'
permissions: Anyone can sponsor accounts on behalf of their own user account. Organization owners and billing managers can sponsor accounts on behalf of their organization.
---
### About sponsoring developers and organizations
{% data reusables.sponsors.org-sponsors-release-phase %}
{% data reusables.sponsors.sponsorship-details %} {% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)."
### About sponsorships
When you sponsor an open source contributor, the change will become effective immediately. {% data reusables.sponsors.prorated-sponsorship %}
{% data reusables.sponsors.sponsorship-details %}
If the sponsored open source contributor retires your tier, the tier will remain in place for you until you choose a different tier or cancel your subscription. For more information, see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)."
You can sponsor an account on behalf of your user account to invest in projects that you personally benefit from. You can sponsor an account on behalf of your organization for many reasons.
- Sustaining specific libraries that your organization's work depends on
- Investing in the ecosystem you rely on as a organization (such as blockchain)
- Developing brand awareness as an organization that values open source
- Thanking open source developers for building libraries that complement the product your organization offers
If the open source contributor you want to sponsor does not have a sponsored developer or organization profile, you can encourage the contributor to create a sponsored developer or organization profile. For more information, 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)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)."
You can use a credit card to sponsor an account on {% data variables.product.product_name %}. If your organization wants to be invoiced, [contact us](https://support.github.com/contact/org-sponsors-waitlist).
{% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)."
When you sponsor an account using a credit card, the change will become effective immediately. {% data reusables.sponsors.prorated-sponsorship %}
{% data reusables.sponsors.manage-updates-for-orgs %}
If the sponsored account retires your tier, the tier will remain in place for you until you choose a different tier or cancel your subscription. For more information, see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)."
If the account you want to sponsor does not have a profile on {% data variables.product.prodname_sponsors %}, you can encourage the account to join. For more information, 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)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)."
{% data reusables.sponsors.sponsorships-not-tax-deductible %}
@@ -27,34 +42,23 @@ If the open source contributor you want to sponsor does not have a sponsored dev
{% endnote %}
### Sponsoring a developer
### Sponsoring an account
Before you can sponsor a developer, you must have a verified email address. For more information, see "[Verifying your email address](/github/getting-started-with-github/verifying-your-email-address)."
Before you can sponsor an account, you must have a verified email address. For more information, see "[Verifying your email address](/github/getting-started-with-github/verifying-your-email-address)."
1. On {% data variables.product.product_name %}, navigate to the profile of the person you want to sponsor.
2. Under the developer's name, click **Sponsor**.
![Sponsor button](/assets/images/help/profile/sponsor-button.png)
1. On {% data variables.product.product_name %}, navigate to the profile of the user or organization you want to sponsor.
1. Navigate to your sponsorship dashboard for the account.
- To sponsor a developer, under the developer's name, click **Sponsor**.
![Sponsor button](/assets/images/help/profile/sponsor-button.png)
- To sponsor an organization, to the right of the the organization's name, click **Sponsor**.
![Sponsor button](/assets/images/help/sponsors/sponsor-org-button.png)
1. Optionally, on the right side of the page, to sponsor the account on behalf of your organization, use the **Sponsor as** drop-down menu, and click the organization.
![Drop-down menu to choose the account you'll sponsor as](/assets/images/help/sponsors/sponsor-as-drop-down-menu.png)
{% data reusables.sponsors.select-a-tier %}
{% data reusables.sponsors.pay-prorated-amount %}
{% data reusables.sponsors.select-sponsorship-billing %}
![Edit payment button](/assets/images/help/sponsors/edit-sponsorship-payment-button.png)
{% data reusables.sponsors.who-can-see-your-sponsorship %}
![Radio buttons to choose who can see your sponsorship](/assets/images/help/sponsors/who-can-see-sponsorship.png)
{% data reusables.sponsors.developer-sponsored-choose-updates %}
7. Click **Sponsor _DEVELOPER_**.
![Sponsor developer button](/assets/images/help/sponsors/sponsor-developer-button.png)
### Sponsoring an organization
Before you can sponsor an organization, you must have a verified email address. For more information, see "[Verifying your email address](/github/getting-started-with-github/verifying-your-email-address)."
1. On {% data variables.product.product_name %}, navigate to the page of the organization you want to sponsor.
2. Next to the organization's name, click **Sponsor**.
![Sponsor button](/assets/images/help/sponsors/sponsor-org-button.png)
{% data reusables.sponsors.select-a-tier %}
{% data reusables.sponsors.select-sponsorship-billing %}
![Edit payment button](/assets/images/help/sponsors/edit-org-sponsorship-payment-button.png)
{% data reusables.sponsors.who-can-see-your-sponsorship %}
![Radio buttons to choose who can see your sponsorship](/assets/images/help/sponsors/who-can-see-org-sponsorship.png)
{% data reusables.sponsors.org-sponsored-choose-updates %}
7. Click **Sponsor _ORGANIZATION_**.
![Sponsor organization button](/assets/images/help/sponsors/sponsor-org-confirm-button.png)
{% data reusables.sponsors.choose-updates %}
{% data reusables.sponsors.sponsor-account %}

View File

@@ -7,40 +7,29 @@ versions:
free-pro-team: '*'
---
### About sponsors and sponsorships
You can view analytics on your current and past sponsorships, the payments you've received from sponsors, and events, such as cancellations and sponsor tier changes for your sponsorships. You can also view activity such as new sponsorships, changes to sponsorships, and canceled sponsorships. You can filter the list of activities by date. You can also export sponsorship data for the account you're viewing in CSV or JSON format.
You access all of this information from your Sponsors dashboard.
### Viewing your Sponsors dashboard
1. In the upper-right corner of any page, click your profile photo, then click **{% data variables.product.prodname_sponsors %}**.
![{% data variables.product.prodname_sponsors %} button](/assets/images/help/sponsors/access-github-sponsors-dashboard.png)
2. In the list that's displayed, to the right of the account or organization whose Sponsors dashboard you want to view, click **Dashboard**.
![Developer sponsors dashboard button](/assets/images/help/sponsors/dev-sponsors-dashboard-button.png)
### Viewing your sponsors and sponsorships
1. Go to your Sponsors dashboard, see [Viewing your Sponsors dashboard](#viewing-your-sponsors-dashboard).
{% data reusables.sponsors.navigate-to-sponsors-tab %}
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
1. Optionally, to filter your sponsors by tier, use the **Filter** drop-down menu, click **Active tiers** or **Retired tiers**, and select a tier.
![Drop-down menu to filter by tier](/assets/images/help/sponsors/filter-drop-down.png)
### Viewing recent sponsorship activity
1. Go to your Sponsors dashboard, see [Viewing your Sponsors dashboard](#viewing-your-sponsors-dashboard).
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
1. In the left sidebar, click **Activity**.
![Activity tab](/assets/images/help/sponsors/activity-tab.png)
### Exporting your sponsorship data
1. Go to your Sponsors dashboard, see [Viewing your Sponsors dashboard](#viewing-your-sponsors-dashboard).
If you have sponsors, you can export your sponsorship data. {% data variables.product.prodname_dotcom %} will send you an email with export data for all of your sponsors for the month you select. After the export is complete, you can export another month of data. You can export up to 10 sets of data per hour for any of your sponsored accounts.
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.navigate-to-sponsors-tab %}
1. Click **Export all**.
![Export all button](/assets/images/help/sponsors/export-all.png)
This button is not displayed if you don't have any sponsors.
1. Choose a timeframe and a format for the data you'd like to export, then click **Start export**.
![Options for data export](/assets/images/help/sponsors/export-your-sponsors.png)
{% data variables.product.prodname_dotcom %} starts exporting data for all of your sponsors for the month you selected. You'll be emailed shortly with an attachment containing the data. After the export is complete you can export another month of data. You can export up to 10 sets of data an hour for any of your sponsored organizations or user accounts.
![Options for data export](/assets/images/help/sponsors/export-your-sponsors.png)

View File

@@ -1,16 +0,0 @@
---
title: About Campus Advisors
intro: 'As an instructor or mentor, learn to use {% data variables.product.prodname_dotcom %} at your school with Campus Advisors training and support.'
redirect_from:
- /articles/about-campus-advisors
versions:
free-pro-team: '*'
---
Professors, teachers and mentors can use the Campus Advisors online training to master Git and {% data variables.product.prodname_dotcom %} and learn best practices for teaching students with {% data variables.product.prodname_dotcom %}. For more information, see "[Campus Advisors](https://education.github.com/teachers/advisors)."
{% note %}
**Note:** As an instructor, you can't create {% data variables.product.prodname_dotcom %} accounts for your students. Students must create their own {% data variables.product.prodname_dotcom %} accounts.
{% endnote %}

View File

@@ -1,10 +0,0 @@
---
title: About Campus Experts
intro: 'As a student, learn the skills you need to build your school''s technology community and a real-world portfolio, with {% data variables.product.prodname_dotcom %} Campus Experts training.'
redirect_from:
- /articles/about-campus-experts
versions:
free-pro-team: '*'
---
Learn public speaking skills, technical writing, community leadership, and software development skills as a {% data variables.product.prodname_dotcom %} Campus Expert. For more information, see "[Campus Experts](https://education.github.com/students/experts)."

View File

@@ -1,30 +0,0 @@
---
title: About GitHub Education for educators and researchers
intro: '{% data variables.product.prodname_education %} offers a variety of tools to help educators and researchers work more effectively inside and outside of the classroom.'
redirect_from:
- /articles/about-github-education-for-educators-and-researchers
versions:
free-pro-team: '*'
---
{% data reusables.education.about-github-education-link %}
### {% data variables.product.prodname_education %} for educators
With {% data variables.product.prodname_education %}'s tools and services for educators of all levels, you can:
- Use [{% data variables.product.prodname_classroom %}](https://classroom.github.com) to distribute code, give students feedback, and collect assignments on {% data variables.product.prodname_dotcom %}.
- Join our [{% data variables.product.prodname_education_community %}](https://education.github.com/forum) to discuss current trends in technology education with your peers from around the world.
- Access and adapt our [open source lesson plans](https://education.github.community/t/open-source-lesson-plans/1591) for teaching Git and {% data variables.product.prodname_dotcom %}.
- [Request a {% data variables.product.prodname_dotcom %} swag bag](https://education.github.community/t/get-a-github-swag-bag-for-your-classroom/33) with educational materials and goodies for your students.
{% data reusables.education.apply-for-team %}
### {% data variables.product.prodname_education %} for researchers
With {% data variables.product.prodname_education %}'s tools and services for researchers, you can:
- Collaborate with others on your research work around the world on {% data variables.product.prodname_dotcom %}.
- [Learn](https://education.github.com/stories) how academic institutions around the world are using {% data variables.product.prodname_dotcom %} for their research.
{% data reusables.education.apply-for-team %}
### Further reading
- "[About {% data variables.product.prodname_education %} for students](/articles/about-github-education-for-students)"

View File

@@ -1,20 +0,0 @@
---
title: About GitHub Education for students
intro: '{% data variables.product.prodname_education %} offers students real-world experience with free access to various developer tools from {% data variables.product.prodname_dotcom %}''s partners.'
redirect_from:
- /articles/about-github-education-for-students
versions:
free-pro-team: '*'
---
Using {% data variables.product.prodname_dotcom %} for your school projects is a practical way to collaborate with others and build a portfolio that showcases real-world experience.
{% data reusables.education.about-github-education-link %}
Everyone with a {% data variables.product.prodname_dotcom %} account can collaborate in unlimited public and private repositories with {% data variables.product.prodname_free_user %}. As a student, you can also apply for the {% data variables.product.prodname_student_pack %}, which offers free access to tools and services used by professional developers. For more information, see "[Applying for a student developer pack](/articles/applying-for-a-student-developer-pack)" and [{% data variables.product.prodname_education %}](https://education.github.com/pack).
If you're a member of a FIRST robotics club, your mentor can apply for an educator discount so your team can collaborate using {% data variables.product.prodname_team %}, which allows unlimited users and private repositories, for free. For more information, see "[Applying for an educator or researcher discount](/articles/applying-for-an-educator-or-researcher-discount)."
### Further reading
- "[About {% data variables.product.prodname_education %} for educators and researchers](/articles/about-github-education-for-educators-and-researchers)"

View File

@@ -1,18 +0,0 @@
---
title: About GitHub Education
intro: '{% data variables.product.prodname_education %} offers a special free product for schools that want to make the most of {% data variables.product.prodname_dotcom %} for their community and agree to specific program requirements.'
redirect_from:
- /articles/about-github-education
versions:
free-pro-team: '*'
---
If your school agrees to meet certain requirements, your secondary school, university, or bootcamp can get {% data variables.product.prodname_education %}, which offers the best of {% data variables.product.prodname_dotcom %} for free, including:
- {% data variables.product.prodname_ghe_cloud %} and/or {% data variables.product.prodname_ghe_server %}
- Teacher training to master Git and {% data variables.product.prodname_dotcom %} with our Campus Advisor program
- Automated access to premium {% data variables.product.prodname_education %} features, like the {% data variables.product.prodname_student_pack %}
- Leadership development and technical training for students with the Campus Experts program
For more information, see the [official {% data variables.product.prodname_education %}](https://education.github.com/partners/schools) page. To learn more about training programs for student leaders and teachers, see "[{% data variables.product.prodname_dotcom %} Campus Experts](https://education.github.com/students/experts)" and "[Campus Advisors](https://education.github.com/teachers/advisors)."
If you're a student or academic faculty and your school isn't partnered with {% data variables.product.prodname_dotcom %} as a {% data variables.product.prodname_education %} school, then you can still individually apply for discounts to use {% data variables.product.prodname_dotcom %}. For more information, see "[Using {% data variables.product.prodname_dotcom %} for your schoolwork](/articles/using-github-for-your-schoolwork/)" or "[Using {% data variables.product.prodname_dotcom %} in your classroom and research](/articles/using-github-in-your-classroom-and-research/)."

View File

@@ -1,53 +0,0 @@
---
title: Applying for a student developer pack
intro: 'As a student, you can apply for the {% data variables.product.prodname_student_pack %}, which includes offers and benefits from {% data variables.product.prodname_dotcom %} partners.'
redirect_from:
- /articles/applying-for-a-student-developer-pack
versions:
free-pro-team: '*'
---
{% data reusables.education.about-github-education-link %}
### Requirements
To be eligible for the {% data variables.product.prodname_student_pack %}, you must:
- Be currently enrolled in a degree or diploma granting course of study such as a high school, secondary school, college, university, homeschool, or similar educational institution
- Have a verifiable school-issued email address or upload documents that prove your current student status
- Have a [{% data variables.product.prodname_dotcom %} user account](/articles/signing-up-for-a-new-github-account)
- Be at least 13 years old
Documents that prove your current student status include a picture of your school ID, class schedule, transcript, and affiliation or enrollment verification letter.
During your tenure as a student, you may be prompted to periodically re-verify your current academic status.
{% note %}
**Note:** You cannot transfer academic discounts from one account to another. If you have more than one account you want to apply the discount to, consider [merging](/articles/merging-multiple-user-accounts) your user accounts and [renaming](/articles/changing-your-github-username) the retained account if desired.
{% endnote %}
For information about renewing your {% data variables.product.prodname_student_pack %}, see "[Expiration and renewals](/articles/applying-for-a-student-developer-pack/#expiration-and-renewals)."
### Applying for a {% data variables.product.prodname_student_pack %}
{% data reusables.education.benefits-page %}
3. Under "Which best describes your academic status?", select **Student**.
![Select academic status](/assets/images/help/education/academic-status-student.png)
{% data reusables.education.select-email-address %}
{% data reusables.education.upload-proof-status %}
{% data reusables.education.school-name %}
{% data reusables.education.plan-to-use-github %}
{% data reusables.education.submit-application %}
### Expiration and renewals
Once your {% data variables.product.prodname_student_pack %} access expires, you may reapply if you're still eligible, although some of our partner offers cannot renew. Most of the timed offers from our partners start once you set them up. For more information, see the [{% data variables.product.prodname_student_pack %}](https://education.github.com/pack) page.
To see when your free access to the {% data variables.product.prodname_student_pack %} expires, visit your account's [billing settings](https://github.com/settings/billing).
### Further reading
- "[Why wasn't my application for a {% data variables.product.prodname_student_pack %} approved?](/articles/why-wasn-t-my-application-for-a-student-developer-pack-approved)"
- "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/articles/signing-up-for-a-new-github-account)"
- [{% data variables.product.prodname_education %}](https://education.github.com)

View File

@@ -1,61 +0,0 @@
---
title: Applying for an educator or researcher discount
intro: 'If you''re an educator or a researcher, you can apply to receive {% data variables.product.prodname_team %} for your organization account for free.'
redirect_from:
- /articles/applying-for-a-classroom-discount/
- /articles/applying-for-a-discount-for-your-school-club/
- /articles/applying-for-an-academic-research-discount/
- /articles/applying-for-a-discount-for-your-first-robotics-team/
- /articles/applying-for-an-educator-or-researcher-discount
versions:
free-pro-team: '*'
---
### About educator and researcher discounts
{% data reusables.education.about-github-education-link %}
To apply for an educator or researcher discount, you must:
- Be an educator, faculty member, or researcher
- Have a verifiable school-issued email address
- Upload documents that prove your school affiliation
- Have a [{% data variables.product.prodname_dotcom %} user account](/articles/signing-up-for-a-new-github-account)
### Applying for an educator or researcher discount
{% data reusables.education.benefits-page %}
3. Under "Which best describes your academic status?", select **Faculty**.
![Select academic status](/assets/images/help/education/academic-status-faculty.png)
{% data reusables.education.select-email-address %}
{% data reusables.education.upload-proof-status %}
{% data reusables.education.school-name %}
{% data reusables.education.plan-to-use-github %}
{% data reusables.education.submit-application %}
### Upgrading your organization
After your request for an educator or researcher discount has been approved, you can upgrade the organizations you use with your learning community to {% data variables.product.prodname_team %}, which allows unlimited users and private repositories with full features, for free. You can upgrade an existing organization or create a new organization to upgrade.
#### Upgrading an existing organization
{% data reusables.education.upgrade-page %}
{% data reusables.education.upgrade-organization %}
#### Upgrading a new organization
{% data reusables.education.upgrade-page %}
1. Click {% octicon "plus" aria-label="The plus symbol" %} **Create an organization**.
![Create an organization button](/assets/images/help/education/create-org-button.png)
3. Read the information, then click **Create organization**.
![Create organization button](/assets/images/help/education/create-organization-button.png)
4. Under "Choose your plan", click **Choose {% data variables.product.prodname_free_team %}**.
5. Follow the prompts to create your organization.
{% data reusables.education.upgrade-page %}
{% data reusables.education.upgrade-organization %}
### Further reading
- "[Why wasn't my application for an educator or researcher discount approved?](/articles/why-wasn-t-my-application-for-an-educator-or-researcher-discount-approved)"
- [{% data variables.product.prodname_education %}](https://education.github.com)
- [{% data variables.product.prodname_classroom %} Videos](https://classroom.github.com/videos)
- [{% data variables.product.prodname_education_community %}](https://education.github.community/)

View File

@@ -1,23 +0,0 @@
---
title: Teaching and learning with GitHub Education
redirect_from:
- /categories/teaching-and-learning-with-github-education
versions:
free-pro-team: '*'
---
### Table of Contents
{% topic_link_in_list /using-github-at-your-educational-institution %}
{% link_in_list /about-github-education %}
{% link_in_list /about-campus-experts %}
{% link_in_list /about-campus-advisors %}
{% topic_link_in_list /using-github-for-your-schoolwork %}
{% link_in_list /about-github-education-for-students %}
{% link_in_list /applying-for-a-student-developer-pack %}
{% link_in_list /why-wasnt-my-application-for-a-student-developer-pack-approved %}
{% topic_link_in_list /using-github-in-your-classroom-and-research %}
{% link_in_list /about-github-education-for-educators-and-researchers %}
{% link_in_list /applying-for-an-educator-or-researcher-discount %}
{% link_in_list /why-wasnt-my-application-for-an-educator-or-researcher-discount-approved %}

View File

@@ -1,10 +0,0 @@
---
title: Using GitHub at your educational institution
intro: 'Maximize the benefits of using {% data variables.product.prodname_dotcom %} at your institution for your students, instructors, and IT staff with {% data variables.product.prodname_education %} and our various training programs for students and instructors.'
mapTopic: true
redirect_from:
- /articles/using-github-at-your-educational-institution
versions:
free-pro-team: '*'
---

View File

@@ -1,10 +0,0 @@
---
title: Using GitHub for your schoolwork
intro: 'As a student, use {% data variables.product.prodname_dotcom %} to collaborate on your school projects and build real-world experience.'
mapTopic: true
redirect_from:
- /articles/using-github-for-your-schoolwork
versions:
free-pro-team: '*'
---

View File

@@ -1,10 +0,0 @@
---
title: Using GitHub in your classroom and research
intro: 'As an educator or researcher, use {% data variables.product.prodname_dotcom %} to collaborate on your work in a classroom, student or research group, and more.'
mapTopic: true
redirect_from:
- /articles/using-github-in-your-classroom-and-research
versions:
free-pro-team: '*'
---

View File

@@ -1,66 +0,0 @@
---
title: Why wasn't my application for a student developer pack approved?
intro: 'Review common reasons that applications for the {% data variables.product.prodname_student_pack %} are not approved and learn tips for reapplying successfully.'
redirect_from:
- /articles/why-was-my-application-for-a-student-developer-pack-denied/
- /articles/why-wasn-t-my-application-for-a-student-developer-pack-approved
- /articles/why-wasnt-my-application-for-a-student-developer-pack-approved
versions:
free-pro-team: '*'
---
{% tip %}
**Tip:** {% data reusables.education.about-github-education-link %}
{% endtip %}
### Unclear academic affiliation documents
If the image you uploaded doesn't clearly identify your current academic status, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %}
{% data reusables.education.pdf-support %}
### Using an academic email with an unverified domain
If your academic email address has an unverified domain, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %}
{% data reusables.education.pdf-support %}
### Using an academic email from a school with lax email policies
If your school issues email addresses prior to paid student enrollment, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %}
{% data reusables.education.pdf-support %}
If you have other questions or concerns about the school domain please ask your school IT staff to contact us.
### Academic email address already used
If your academic email address was already used to request a {% data variables.product.prodname_student_pack %} for a different {% data variables.product.prodname_dotcom %} account, you cannot reuse the academic email address to successfully apply for another {% data variables.product.prodname_student_pack %} until that discount expires.
{% note %}
**Note:** It is against the {% data variables.product.prodname_dotcom %} [Terms of Service](/articles/github-terms-of-service/#3-account-requirements) to maintain more than one individual account.
{% endnote %}
If you have more than one personal user account, you must merge your accounts. To retain the discount, keep the account that was granted the discount. You can rename the retained account and keep your contribution history by adding all your email addresses to the retained account.
For more information, see:
- "[Merging multiple user accounts](/articles/merging-multiple-user-accounts)"
- "[Changing your {% data variables.product.prodname_dotcom %} username](/articles/changing-your-github-username)"
- "[Adding an email address to your {% data variables.product.prodname_dotcom %} account](/articles/adding-an-email-address-to-your-github-account)"
### Ineligible student status
You're ineligible for a {% data variables.product.prodname_student_pack %} if:
- Youre enrolled in an informal learning program that is not part of the [{% data variables.product.prodname_dotcom %} Campus Program](https://education.github.com/schools) and not enrolled in a degree or diploma granting course of study.
- You're under 13 years old.
Your instructor may still apply for a {% data variables.product.prodname_education %} discount for classroom use. If you're a student at a coding school or bootcamp, you will become eligible for a {% data variables.product.prodname_student_pack %} if your school joins the [{% data variables.product.prodname_dotcom %} Campus Program](https://education.github.com/schools).
### Further reading
- "[How to get the GitHub Student Developer Pack without a student ID](https://github.blog/2019-07-30-how-to-get-the-github-student-developer-pack-without-a-student-id/)" on {% data variables.product.prodname_blog %}
- "[Applying for a student developer pack](/articles/applying-for-a-student-developer-pack)"

View File

@@ -1,44 +0,0 @@
---
title: Why wasn't my application for an educator or researcher discount approved?
intro: Review common reasons that applications for an educator or researcher discount are not approved and learn tips for reapplying successfully.
redirect_from:
- /articles/why-was-my-application-for-an-educator-or-researcher-discount-denied/
- /articles/why-wasn-t-my-application-for-an-educator-or-researcher-discount-approved
- /articles/why-wasnt-my-application-for-an-educator-or-researcher-discount-approved
versions:
free-pro-team: '*'
---
{% tip %}
**Tip:** {% data reusables.education.about-github-education-link %}
{% endtip %}
### Unclear proof of affiliation documents
If the image you uploaded doesn't clearly identify your current employment with a school or university, you must reapply and upload another image of your faculty ID or employment verification letter with clear information.
{% data reusables.education.pdf-support %}
### Using an academic email with an unverified domain
If your academic email address has an unverified domain, we may require further proof of your academic status. {% data reusables.education.upload-different-image %}
{% data reusables.education.pdf-support %}
### Using an academic email from a school with lax email policies
If alumni and retired faculty of your school have lifetime access to school-issued email addresses, we may require further proof of your academic status. {% data reusables.education.upload-different-image %}
{% data reusables.education.pdf-support %}
If you have other questions or concerns about the school domain, please ask your school IT staff to contact us.
### Non-student applying for Student Developer Pack
Educators and researchers are not eligible for the partner offers that come with the [{% data variables.product.prodname_student_pack %}](https://education.github.com/pack). When you reapply, make sure that you choose **Faculty** to describe your academic status.
### Further reading
- "[Applying for an educator or researcher discount](/articles/applying-for-an-educator-or-researcher-discount)"

View File

@@ -21,6 +21,10 @@ The dependency graph is a summary of the manifest and lock files stored in a rep
When you push a commit to {% data variables.product.product_name %} that changes or adds a supported manifest or lock file to the default branch, the dependency graph is automatically updated.{% if currentVersion == "free-pro-team@latest" %} In addition, the graph is updated when anyone pushes a change to the repository of one of your dependencies.{% endif %} For information on the supported ecosystems and manifest files, see "[Supported package ecosystems](#supported-package-ecosystems)" below.
{% if currentVersion == "free-pro-team@latest" %}
When you create a pull request containing changes to dependencies that targets the default branch, {% data variables.product.prodname_dotcom %} uses the dependency graph to add dependency reviews to the pull request. These indicate whether the dependencies contain vulnerabilities and, if so, the version of the dependency in which the vulnerability was fixed. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)."
{% endif %}
### Dependencies included
The dependency graph includes all the dependencies of a repository that are detailed in the manifest and lock files, or their equivalent, for supported ecosystems. This includes:
@@ -41,7 +45,8 @@ You can use the dependency graph to:
- Explore the repositories your code depends on{% if currentVersion == "free-pro-team@latest" %}, and those that depend on it{% endif %}. For more information, see "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)." {% if currentVersion == "free-pro-team@latest" %}
- View a summary of the dependencies used in your organization's repositories in a single dashboard. For more information, see "[Viewing insights for your organization](/articles/viewing-insights-for-your-organization#viewing-organization-dependency-insights)."{% endif %}
- View and update vulnerable dependencies for your repository. The dependency graph lists vulnerable dependencies before other dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
- View and update vulnerable dependencies for your repository. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."{% if currentVersion == "free-pro-team@latest" %}
- See information about vulnerable dependencies in pull requests. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)."{% endif %}
### Enabling the dependency graph

View File

@@ -2,6 +2,7 @@
title: Working with GitHub Support
redirect_from:
- /categories/working-with-github-support
- /forum
versions:
free-pro-team: '*'
---