Merge branch 'main' into main
This commit is contained in:
Ethan Palm
@@ -85,3 +85,22 @@ You can disable all workflows for a repository or set a policy that configures w
|
||||
{% data reusables.repositories.settings-sidebar-actions %}
|
||||
{% data reusables.github-actions.private-repository-forks-configure %}
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
|
||||
### Setting the permissions of the `GITHUB_TOKEN` for your repository
|
||||
|
||||
{% data reusables.github-actions.workflow-permissions-intro %}
|
||||
|
||||
The default permissions can also be configured in the organization settings. If the more restricted default has been selected in the organization settings, the same option is auto-selected in your repository settings and the permissive option is disabled.
|
||||
|
||||
{% data reusables.github-actions.workflow-permissions-modifying %}
|
||||
|
||||
#### Configuring the default `GITHUB_TOKEN` permissions
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.repositories.settings-sidebar-actions %}
|
||||
1. Under **Workflow permissions**, choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope.
|
||||
|
||||
1. Click **Save** to apply the settings.
|
||||
{% endif %}
|
||||
|
||||
@@ -12,7 +12,7 @@ topics:
|
||||
|
||||
### About FUNDING files
|
||||
|
||||
You can configure your sponsor button by editing a _FUNDING.yml_ file in your repository's `.github` folder, on the default branch. You can configure the button to include sponsored developers in {% data variables.product.prodname_sponsors %}, external funding platforms, or a custom funding URL. For more information about {% data variables.product.prodname_sponsors %}, see "[About GitHub Sponsors](/articles/about-github-sponsors)."
|
||||
You can configure your sponsor button by editing a _FUNDING.yml_ file in your repository's `.github` folder, on the default branch. You can configure the button to include sponsored developers in {% data variables.product.prodname_sponsors %}, external funding platforms, or a custom funding URL. For more information about {% data variables.product.prodname_sponsors %}, see "[About GitHub Sponsors](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)."
|
||||
|
||||
You can add one username, package name, or project name per external funding platform and up to four custom URLs. You can add up to four sponsored developers or organizations in {% data variables.product.prodname_sponsors %}. Add each platform on a new line, using the following syntax:
|
||||
|
||||
@@ -79,5 +79,5 @@ Anyone with admin permissions can enable a sponsor button in a repository.
|
||||
{% data reusables.files.propose_new_file %}
|
||||
|
||||
### Further reading
|
||||
- "[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)"
|
||||
- "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)"
|
||||
- "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %}
|
||||
|
||||
@@ -87,6 +87,7 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc
|
||||
If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace.
|
||||
|
||||
```shell
|
||||
$ sudo apt-get update
|
||||
$ sudo apt-get install xclip
|
||||
# Downloads and installs xclip. If you don't have `apt-get`, you might need to use another installer (like `yum`)
|
||||
|
||||
|
||||
@@ -91,7 +91,7 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav
|
||||
$ touch ~/.ssh/config
|
||||
```
|
||||
|
||||
* Open your `~/.ssh/config` file, then modify the file, replacing ` ~/.ssh/id_ed25519` if you are not using the default location and name for your `id_ed25519` key.
|
||||
* Open your `~/.ssh/config` file, then modify the file to contain the following lines. If your SSH key file has a different name or path than the example code, modify the filename or path to match your current setup.
|
||||
|
||||
```
|
||||
Host *
|
||||
|
||||
@@ -54,7 +54,7 @@ The events listed in your security log are triggered by your actions. Actions ar
|
||||
| [`project`](#project-category-actions) | Contains all activities related to project boards.
|
||||
| [`public_key`](#public_key-category-actions) | Contains all activities related to [your public SSH keys](/articles/adding-a-new-ssh-key-to-your-github-account).
|
||||
| [`repo`](#repo-category-actions) | Contains all activities related to the repositories you own.{% if currentVersion == "free-pro-team@latest" %}
|
||||
| [`sponsors`](#sponsors-category-actions) | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
|
||||
| [`sponsors`](#sponsors-category-actions) | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
|
||||
| [`team`](#team-category-actions) | Contains all activities related to teams you are a part of.{% endif %}{% if currentVersion != "github-ae@latest" %}
|
||||
| [`two_factor_authentication`](#two_factor_authentication-category-actions) | Contains all activities related to [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa).{% endif %}
|
||||
| [`user`](#user-category-actions) | Contains all activities related to your account.
|
||||
@@ -93,6 +93,10 @@ An overview of some of the most common actions that are recorded as events in th
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `create` | Triggered when you [create a codespace](/github/developing-online-with-codespaces/creating-a-codespace).
|
||||
| `resume` | Triggered when you resume a suspended codespace.
|
||||
| `delete` | Triggered when you [delete a codespace](/github/developing-online-with-codespaces/deleting-a-codespace).
|
||||
| `manage_access_and_security` | Triggered when you update [the repositories a codespace has access to](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces).
|
||||
| `trusted_repositories_access_update` | Triggered when you change your user account's [access and security setting for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces).
|
||||
|
||||
#### `marketplace_agreement_signature` category actions
|
||||
@@ -189,19 +193,19 @@ An overview of some of the most common actions that are recorded as events in th
|
||||
| `custom_amount_settings_change` | Triggered when you enable or disable custom amounts, or when you change the suggested custom amount (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)")
|
||||
| `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 developer (see "[Managing your sponsorship](/articles/managing-your-sponsorship)")
|
||||
| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)")
|
||||
| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)")
|
||||
| `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
|
||||
| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `sponsored_developer_disable` | Triggered when your {% data variables.product.prodname_sponsors %} account is disabled
|
||||
| `sponsored_developer_redraft` | Triggered when your {% data variables.product.prodname_sponsors %} account is returned to draft state from approved state
|
||||
| `sponsored_developer_profile_update` | Triggered when you edit your sponsored developer profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors)")
|
||||
| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)")
|
||||
| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/articles/contacting-your-sponsors)")
|
||||
| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `waitlist_join` | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `sponsored_developer_profile_update` | Triggered when you edit your sponsored developer profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)")
|
||||
| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)")
|
||||
| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors)")
|
||||
| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
| `waitlist_join` | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
@@ -11,7 +11,7 @@ topics:
|
||||
|
||||
{% tip %}
|
||||
|
||||
**GitHub Enterprise users**: Accessing GitHub Enterprise via SSH over the HTTPS port is currently not supported.
|
||||
**{% data variables.product.prodname_ghe_server %} users**: Accessing {% data variables.product.prodname_ghe_server %} via SSH over the HTTPS port is currently not supported.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
|
||||
@@ -25,6 +25,12 @@ When you enable access and security for a repository owned by your user account,
|
||||
1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories you own. Repeat for all repositories whose codespaces you want to access other repositories you own.
|
||||
|
||||
|
||||
### Reviewing your security log for {% data variables.product.prodname_codespaces %}
|
||||
|
||||
The security log is where you can review {% data variables.product.prodname_codespaces %} actions that you have performed. For information about accessing the log, see "[Reviewing your security log](/github/authenticating-to-github/reviewing-your-security-log#accessing-your-security-log)."
|
||||
|
||||
The security log includes details on what action occured and when you performed it. For information about {% data variables.product.prodname_codespaces %} actions, see "[{% data variables.product.prodname_codespaces %} category actions](/github/authenticating-to-github/reviewing-your-security-log#codespaces-category-actions)".
|
||||
|
||||
### Managing security and access for your organization
|
||||
|
||||
Organization owners can manage security and access for {% data variables.product.prodname_codespaces %}.
|
||||
@@ -41,3 +47,9 @@ When you enable access and security for a repository owned by your organization,
|
||||
|
||||
1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories owned by your organization. Repeat for all repositories whose codespaces you want to access other repositories.
|
||||
|
||||
|
||||
### Reviewing your organization's audit logs for {% data variables.product.prodname_codespaces %}
|
||||
|
||||
The audit log is where you can review actions related to {% data variables.product.prodname_codespaces %} that have been performed by members of your organization. For information about accessing the log, see "[Reviewing your security log](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#accessing-the-audit-log)."
|
||||
|
||||
The audit log includes details such as who performed the action, what the action was, and when the action was performed. For information on {% data variables.product.prodname_codespaces %} actions, see "[{% data variables.product.prodname_codespaces %} category actions](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#codespaces-category-actions)."
|
||||
|
||||
@@ -22,6 +22,7 @@ You can add encrypted secrets to your user account that you want to use in your
|
||||
- Personal access tokens to cloud services
|
||||
- Service principals
|
||||
- Subscription identifiers
|
||||
- [Credentials for a private image registry](#allowing-your-codespace-to-access-private-images)
|
||||
|
||||
You can choose which repositories should have access to each secret. Then, you can use the secret in any codespace you create for a repository that has access to the secret.
|
||||
|
||||
@@ -67,3 +68,22 @@ You can update the value of an existing secret, and you can change which reposit
|
||||
|
||||
1. Read the warning, then click **OK**.
|
||||
|
||||
|
||||
### Allowing your codespace to access private images
|
||||
|
||||
A registry is a secure space for storing and managing private container images, such as Azure Container Registry or DockerHub. By adding a secret, your codespace can access private images within the registry.
|
||||
|
||||
When a codespace launches, {% data variables.product.prodname_codespaces %} will check for the following three secrets, which define the server name, username, and personal access token (PAT) for the container registry. If those secrets are found, {% data variables.product.prodname_codespaces %} will make the registry available inside your codespace.
|
||||
|
||||
- `<*>_CONTAINER_REGISTRY_SERVER`
|
||||
- `<*>_CONTAINER_REGISTRY_USER`
|
||||
- `<*>_CONTAINER_REGISTRY_PASSWORD`
|
||||
|
||||
Use the steps in "[Adding a secret](#adding-a-secret)" to add a secret for each of these items. Replace the “<*>” in the name with a consistent identifier. For example, if you had a private image registry in Azure, it might look like the following:
|
||||
|
||||
```
|
||||
ACR_CONTAINER_REGISTRY_SERVER = mycompany.azurecr.io
|
||||
ACR_CONTAINER_REGISTRY_USER = acr-user-here
|
||||
ACR_CONTAINER_REGISTRY_PASSWORD = <PAT>
|
||||
```
|
||||
|
||||
|
||||
@@ -154,6 +154,51 @@ If your workflow does not contain a matrix called `language`, then {% data varia
|
||||
with:
|
||||
languages: cpp, csharp, python
|
||||
```
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
### Analyzing Python dependencies
|
||||
|
||||
For GitHub-hosted runners that use Linux only, the {% data variables.product.prodname_codeql_workflow %} will try to auto-install Python dependencies to give more results for the CodeQL analysis. You can control this behavior by specifying the `setup-python-dependencies` parameter for the action called by the "Initialize CodeQL" step. By default, this parameter is set to `true`:
|
||||
|
||||
- If the repository contains code written in Python, the "Initialize CodeQL" step installs the necessary dependencies on the GitHub-hosted runner. If the auto-install succeeds, the action also sets the environment variable `CODEQL_PYTHON` to the Python executable file that includes the dependencies.
|
||||
|
||||
- If the repository doesn't have any Python dependencies, or the dependencies are specified in an unexpected way, you'll get a warning and the action will continue with the remaining jobs. The action can run successfully even when there are problems interpreting dependencies, but the results may be incomplete.
|
||||
|
||||
Alternatively, you can install Python dependencies manually on any operating system. You will need to add `setup-python-dependencies` and set it to `false`, as well as set `CODEQL_PYTHON` to the Python executable that includes the dependencies, as shown in this workflow extract:
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
CodeQL-Build:
|
||||
|
||||
runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
|
||||
permissions:
|
||||
security-events: write
|
||||
actions: read{% endif %}
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v2
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: '3.x'
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
if [ -f requirements.txt ];
|
||||
then pip install -r requirements.txt;
|
||||
fi
|
||||
# Set the `CODEQL-PYTHON` environment variable to the Python executable
|
||||
# that includes the dependencies
|
||||
echo "CODEQL_PYTHON=$(which python)" >> $GITHUB_ENV
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@v1
|
||||
with:
|
||||
languages: python
|
||||
# Override the default behavior so that the action doesn't attempt
|
||||
# to auto-install Python dependencies
|
||||
setup-python-dependencies: false
|
||||
```
|
||||
{% endif %}
|
||||
|
||||
### Running additional queries
|
||||
|
||||
|
||||
@@ -44,7 +44,10 @@ on:
|
||||
jobs:
|
||||
analyze:
|
||||
name: Analyze
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
|
||||
permissions:
|
||||
security-events: write
|
||||
actions: read{% endif %}
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
|
||||
@@ -29,7 +29,10 @@ If an automatic build of code for a compiled language within your project fails,
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
analyze:
|
||||
analyze:{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
|
||||
permissions:
|
||||
security-events: write
|
||||
actions: read{% endif %}
|
||||
...
|
||||
strategy:
|
||||
fail-fast: false
|
||||
|
||||
@@ -63,7 +63,9 @@ on:
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
|
||||
permissions:
|
||||
security-events: write{% endif %}
|
||||
steps:
|
||||
# This step checks out a copy of your repository.
|
||||
- name: Checkout repository
|
||||
@@ -95,6 +97,9 @@ on:
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
|
||||
permissions:
|
||||
security-events: write{% endif %}
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Run npm install
|
||||
|
||||
@@ -21,7 +21,7 @@ Query parameters are optional parts of a URL you can customize to share a specif
|
||||
|
||||
You must have the proper permissions for any action to use the equivalent query parameter. For example, you must have permission to add a label to an issue to use the `labels` query parameter.
|
||||
|
||||
If you create an invalid URL using query parameters, or if you don’t have the proper permissions, the URL will return a 404 error page.
|
||||
If you create an invalid URL using query parameters, or if you don’t have the proper permissions, the URL will return a `404 Not Found` error page. If you create a URL that exceeds the server limit, the URL will return a `414 URI Too Long` error page.
|
||||
|
||||
### Supported query parameters
|
||||
|
||||
|
||||
@@ -17,5 +17,5 @@ topics:
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)"
|
||||
- "[Sponsoring open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)"
|
||||
- "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)"
|
||||
- "[Sponsoring open source contributors](/sponsors/sponsoring-open-source-contributors)"
|
||||
|
||||
@@ -49,3 +49,20 @@ You can disable all workflows for an enterprise or set a policy that configures
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-tab %}
|
||||
{% data reusables.github-actions.private-repository-forks-configure %}
|
||||
|
||||
### Setting the permissions of the `GITHUB_TOKEN` for your enterprise
|
||||
|
||||
{% data reusables.github-actions.workflow-permissions-intro %}
|
||||
|
||||
You can set the default permissions for the `GITHUB_TOKEN` in the settings for your enterprise, organizations, or repositories. If you choose the restricted option as the default in your enterprise settings, this prevents the more permissive setting being chosen in the organization or repository settings.
|
||||
|
||||
{% data reusables.github-actions.workflow-permissions-modifying %}
|
||||
|
||||
#### Configuring the default `GITHUB_TOKEN` permissions
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-tab %}
|
||||
1. Under **Workflow permissions**, choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope.
|
||||
|
||||
1. Click **Save** to apply the settings.
|
||||
|
||||
@@ -56,7 +56,7 @@ You can change the name that is displayed on your profile. This name may also be
|
||||
|
||||
### Adding a bio to your profile
|
||||
|
||||
Add a bio to your profile to share information about yourself with other {% data variables.product.product_name %} users. With the help of [@mentions](/articles/basic-writing-and-formatting-syntax) and emoji, you can include information about where you currently or have previously worked, what type of work you do, or even what kind of coffee you drink.
|
||||
Add a bio to your profile to share information about yourself with other {% data variables.product.product_name %} users. With the help of [@mentions](/articles/basic-writing-and-formatting-syntax) and emoji, you can include information about where you currently or have previously worked, what type of work you do, or even what kind of coffee you drink.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
|
||||
|
||||
@@ -141,69 +141,78 @@ You can disable some of the badges for {% data variables.product.prodname_dotcom
|
||||
|
||||
### List of qualifying repositories for Mars 2020 Helicopter Contributor badge
|
||||
|
||||
If you authored any commit(s) on the default branch of one or more of the repositories below, up to the specified version, you'll receive the Mars 2020 Helicopter Contributor badge on your profile. The list was built based on the information received from NASA's Jet Propulsion Laboratory.
|
||||
If you authored any commit(s) present in the commit history for the listed tag of one or more of the repositories below, you'll receive the Mars 2020 Helicopter Contributor badge on your profile. The authored commit must be with a verified email address, associated with your account at the time {% data variables.product.prodname_dotcom %} determined the eligible contributions, in order to be attributed to you. Future changes to verified emails will not have an effect on the badge. We built the list based on information received from NASA's Jet Propulsion Laboratory.
|
||||
|
||||
| {% data variables.product.prodname_dotcom %} Repository | Version |
|
||||
|---|---|
|
||||
| [torvalds/linux](https://github.com/torvalds/linux) | 3.4 |
|
||||
| [nasa/fprime](https://github.com/nasa/fprime) | 1.3 |
|
||||
| [python/cpython](https://github.com/python/cpython) | 3.9.2 |
|
||||
| [boto/boto3](https://github.com/boto/boto3) | 1.17.17 |
|
||||
| [boto/botocore](https://github.com/boto/botocore) | 1.20.11 |
|
||||
| [certifi/python-certifi](https://github.com/certifi/python-certifi) | 2020.12.5 |
|
||||
| [chardet/chardet](https://github.com/chardet/chardet) | 4.0.0 |
|
||||
| [matplotlib/cycler](https://github.com/matplotlib/cycler) | 0.10.0 |
|
||||
| [elastic/elasticsearch-py](https://github.com/elastic/elasticsearch-py) | 6.8.1 |
|
||||
| [ianare/exif-py](https://github.com/ianare/exif-py) | 2.3.2 |
|
||||
| [kjd/idna](https://github.com/kjd/idna) | 2.10 |
|
||||
| [jmespath/jmespath.py](https://github.com/jmespath/jmespath.py) | 0.10.0 |
|
||||
| [nucleic/kiwi](https://github.com/nucleic/kiwi) | 1.3.1 |
|
||||
| [matplotlib/matplotlib](https://github.com/matplotlib/matplotlib) | 3.3.4 |
|
||||
| [numpy/numpy](https://github.com/numpy/numpy) | 1.20.1 |
|
||||
| [opencv/opencv-python](https://github.com/opencv/opencv-python) | 4.5.1.48 |
|
||||
| [python-pillow/Pillow](https://github.com/python-pillow/Pillow) | 8.1.0 |
|
||||
| [pycurl/pycurl](https://github.com/pycurl/pycurl) | 7.43.0.6 |
|
||||
| [pyparsing/pyparsing](https://github.com/pyparsing/pyparsing) | 2.4.7 |
|
||||
| [pyserial/pyserial](https://github.com/pyserial/pyserial) | 3.5 |
|
||||
| [dateutil/dateutil](https://github.com/dateutil/dateutil) | 2.8.1 |
|
||||
| [yaml/pyyaml](https://github.com/yaml/pyyaml) | 5.4.1 |
|
||||
| [psf/requests](https://github.com/psf/requests) | 2.25.1 |
|
||||
| [boto/s3transfer](https://github.com/boto/s3transfer) | 0.3.4 |
|
||||
| [enthought/scimath](https://github.com/enthought/scimath) | 4.2.0 |
|
||||
| [scipy/scipy](https://github.com/scipy/scipy) | 1.6.1 |
|
||||
| [benjaminp/six](https://github.com/benjaminp/six) | 1.15.0 |
|
||||
| [enthought/traits](https://github.com/enthought/traits) | 6.2.0 |
|
||||
| [urllib3/urllib3](https://github.com/urllib3/urllib3) | 1.26.3 |
|
||||
| [python-attrs/attrs](https://github.com/python-attrs/attrs) | 19.3.0 |
|
||||
| [CheetahTemplate3/cheetah3](https://github.com/CheetahTemplate3/cheetah3/) | 3.2.4 |
|
||||
| [pallets/click](https://github.com/pallets/click) | 7.0 |
|
||||
| [pallets/flask](https://github.com/pallets/flask) | 1.1.1 |
|
||||
| [flask-restful/flask-restful](https://github.com/flask-restful/flask-restful) | 0.3.7 |
|
||||
| [pytest-dev/iniconfig](https://github.com/pytest-dev/iniconfig) | 1.0.0 |
|
||||
| [pallets/itsdangerous](https://github.com/pallets/itsdangerous) | 1.1.0 |
|
||||
| [pallets/jinja](https://github.com/pallets/jinja) | 2.10.3 |
|
||||
| [lxml/lxml](https://github.com/lxml/lxml) | 4.4.1 |
|
||||
| [Python-Markdown/markdown](https://github.com/Python-Markdown/markdown) | 3.1.1 |
|
||||
| [pallets/markupsafe](https://github.com/pallets/markupsafe) | 1.1.1 |
|
||||
| [pypa/packaging](https://github.com/pypa/packaging) | 19.2 |
|
||||
| [pexpect/pexpect](https://github.com/pexpect/pexpect) | 4.7.0 |
|
||||
| [pytest-dev/pluggy](https://github.com/pytest-dev/pluggy) | 0.13.0 |
|
||||
| [pexpect/ptyprocess](https://github.com/pexpect/ptyprocess) | 0.6.0 |
|
||||
| [pytest-dev/py](https://github.com/pytest-dev/py) | 1.8.0 |
|
||||
| [pyparsing/pyparsing](https://github.com/pyparsing/pyparsing) | 2.4.5 |
|
||||
| [pytest-dev/pytest](https://github.com/pytest-dev/pytest) | 5.3.0 |
|
||||
| [stub42/pytz](https://github.com/stub42/pytz) | 2019.3 |
|
||||
| [uiri/toml](https://github.com/uiri/toml) | 0.10.0 |
|
||||
| [pallets/werkzeug](https://github.com/pallets/werkzeug) | 0.16.0 |
|
||||
| [dmnfarrell/tkintertable](https://github.com/dmnfarrell/tkintertable) | 1.2 |
|
||||
| [wxWidgets/wxPython-Classic](https://github.com/wxWidgets/wxPython-Classic) | 2.9.1.1 |
|
||||
| [opencv/opencv](https://github.com/opencv/opencv) | 4.5.1 |
|
||||
| [curl/curl](https://github.com/curl/curl) | 7.19.0 |
|
||||
| [madler/zlib](https://github.com/madler/zlib) | 1.2.11 |
|
||||
| [apache/lucene](https://github.com/apache/lucene) | 7.7.3 |
|
||||
| [yaml/libyaml](https://github.com/yaml/libyaml) | 0.2.5 |
|
||||
| [elastic/elasticsearch](https://github.com/elastic/elasticsearch) | 6.8.1 |
|
||||
| [nucleic/cppy](https://github.com/nucleic/cppy) | 1.1.0 |
|
||||
| {% data variables.product.prodname_dotcom %} Repository | Version | Tag |
|
||||
|---|---|---|
|
||||
| [torvalds/linux](https://github.com/torvalds/linux) | 3.4 | [v3.4](https://github.com/torvalds/linux/releases/tag/v3.4) |
|
||||
| [python/cpython](https://github.com/python/cpython) | 3.9.2 | [v3.9.2](https://github.com/python/cpython/releases/tag/v3.9.2) |
|
||||
| [boto/boto3](https://github.com/boto/boto3) | 1.17.17 | [1.17.17](https://github.com/boto/boto3/releases/tag/1.17.17) |
|
||||
| [boto/botocore](https://github.com/boto/botocore) | 1.20.11 | [1.20.11](https://github.com/boto/botocore/releases/tag/1.20.11) |
|
||||
| [certifi/python-certifi](https://github.com/certifi/python-certifi) | 2020.12.5 | [2020.12.05](https://github.com/certifi/python-certifi/releases/tag/2020.12.05) |
|
||||
| [chardet/chardet](https://github.com/chardet/chardet) | 4.0.0 | [4.0.0](https://github.com/chardet/chardet/releases/tag/4.0.0) |
|
||||
| [matplotlib/cycler](https://github.com/matplotlib/cycler) | 0.10.0 | [v0.10.0](https://github.com/matplotlib/cycler/releases/tag/v0.10.0) |
|
||||
| [elastic/elasticsearch-py](https://github.com/elastic/elasticsearch-py) | 6.8.1 | [6.8.1](https://github.com/elastic/elasticsearch-py/releases/tag/6.8.1) |
|
||||
| [ianare/exif-py](https://github.com/ianare/exif-py) | 2.3.2 | [2.3.2](https://github.com/ianare/exif-py/releases/tag/2.3.2) |
|
||||
| [kjd/idna](https://github.com/kjd/idna) | 2.10 | [v2.10](https://github.com/kjd/idna/releases/tag/v2.10) |
|
||||
| [jmespath/jmespath.py](https://github.com/jmespath/jmespath.py) | 0.10.0 | [0.10.0](https://github.com/jmespath/jmespath.py/releases/tag/0.10.0) |
|
||||
| [nucleic/kiwi](https://github.com/nucleic/kiwi) | 1.3.1 | [1.3.1](https://github.com/nucleic/kiwi/releases/tag/1.3.1) |
|
||||
| [matplotlib/matplotlib](https://github.com/matplotlib/matplotlib) | 3.3.4 | [v3.3.4](https://github.com/matplotlib/matplotlib/releases/tag/v3.3.4) |
|
||||
| [numpy/numpy](https://github.com/numpy/numpy) | 1.20.1 | [v1.20.1](https://github.com/numpy/numpy/releases/tag/v1.20.1) |
|
||||
| [opencv/opencv-python](https://github.com/opencv/opencv-python) | 4.5.1.48 | [48](https://github.com/opencv/opencv-python/releases/tag/48) |
|
||||
| [python-pillow/Pillow](https://github.com/python-pillow/Pillow) | 8.1.0 | [8.1.0](https://github.com/python-pillow/Pillow/releases/tag/8.1.0) |
|
||||
| [pycurl/pycurl](https://github.com/pycurl/pycurl) | 7.43.0.6 | [REL_7_43_0_6](https://github.com/pycurl/pycurl/releases/tag/REL_7_43_0_6) |
|
||||
| [pyparsing/pyparsing](https://github.com/pyparsing/pyparsing) | 2.4.7 | [pyparsing_2.4.7](https://github.com/pyparsing/pyparsing/releases/tag/pyparsing_2.4.7) |
|
||||
| [pyserial/pyserial](https://github.com/pyserial/pyserial) | 3.5 | [v3.5](https://github.com/pyserial/pyserial/releases/tag/v3.5) |
|
||||
| [dateutil/dateutil](https://github.com/dateutil/dateutil) | 2.8.1 | [2.8.1](https://github.com/dateutil/dateutil/releases/tag/2.8.1) |
|
||||
| [yaml/pyyaml ](https://github.com/yaml/pyyaml) | 5.4.1 | [5.4.1](https://github.com/yaml/pyyaml/releases/tag/5.4.1) |
|
||||
| [psf/requests](https://github.com/psf/requests) | 2.25.1 | [v2.25.1](https://github.com/psf/requests/releases/tag/v2.25.1) |
|
||||
| [boto/s3transfer](https://github.com/boto/s3transfer) | 0.3.4 | [0.3.4](https://github.com/boto/s3transfer/releases/tag/0.3.4) |
|
||||
| [enthought/scimath](https://github.com/enthought/scimath) | 4.2.0 | [4.2.0](https://github.com/enthought/scimath/releases/tag/4.2.0) |
|
||||
| [scipy/scipy](https://github.com/scipy/scipy) | 1.6.1 | [v1.6.1](https://github.com/scipy/scipy/releases/tag/v1.6.1) |
|
||||
| [benjaminp/six](https://github.com/benjaminp/six) | 1.15.0 | [1.15.0](https://github.com/benjaminp/six/releases/tag/1.15.0) |
|
||||
| [enthought/traits](https://github.com/enthought/traits) | 6.2.0 | [6.2.0](https://github.com/enthought/traits/releases/tag/6.2.0) |
|
||||
| [urllib3/urllib3](https://github.com/urllib3/urllib3) | 1.26.3 | [1.26.3](https://github.com/urllib3/urllib3/releases/tag/1.26.3) |
|
||||
| [python-attrs/attrs](https://github.com/python-attrs/attrs) | 19.3.0 | [19.3.0](https://github.com/python-attrs/attrs/releases/tag/19.3.0) |
|
||||
| [CheetahTemplate3/cheetah3](https://github.com/CheetahTemplate3/cheetah3/) | 3.2.4 | [3.2.4](https://github.com/CheetahTemplate3/cheetah3/releases/tag/3.2.4) |
|
||||
| [pallets/click](https://github.com/pallets/click) | 7.0 | [7.0](https://github.com/pallets/click/releases/tag/7.0) |
|
||||
| [pallets/flask](https://github.com/pallets/flask) | 1.1.1 | [1.1.1](https://github.com/pallets/flask/releases/tag/1.1.1) |
|
||||
| [flask-restful/flask-restful](https://github.com/flask-restful/flask-restful) | 0.3.7 | [0.3.7](https://github.com/flask-restful/flask-restful/releases/tag/0.3.7) |
|
||||
| [pytest-dev/iniconfig](https://github.com/pytest-dev/iniconfig) | 1.0.0 | [v1.0.0](https://github.com/pytest-dev/iniconfig/releases/tag/v1.0.0) |
|
||||
| [pallets/itsdangerous](https://github.com/pallets/itsdangerous) | 1.1.0 | [1.1.0](https://github.com/pallets/itsdangerous/releases/tag/1.1.0) |
|
||||
| [pallets/jinja](https://github.com/pallets/jinja) | 2.10.3 | [2.10.3](https://github.com/pallets/jinja/releases/tag/2.10.3) |
|
||||
| [lxml/lxml](https://github.com/lxml/lxml) | 4.4.1 | [lxml-4.4.1](https://github.com/lxml/lxml/releases/tag/lxml-4.4.1) |
|
||||
| [Python-Markdown/markdown](https://github.com/Python-Markdown/markdown) | 3.1.1 | [3.1.1](https://github.com/Python-Markdown/markdown/releases/tag/3.1.1) |
|
||||
| [pallets/markupsafe](https://github.com/pallets/markupsafe) | 1.1.1 | [1.1.1](https://github.com/pallets/markupsafe/releases/tag/1.1.1) |
|
||||
| [pypa/packaging](https://github.com/pypa/packaging) | 19.2 | [19.2](https://github.com/pypa/packaging/releases/tag/19.2) |
|
||||
| [pexpect/pexpect](https://github.com/pexpect/pexpect) | 4.7.0 | [4.7.0](https://github.com/pexpect/pexpect/releases/tag/4.7.0) |
|
||||
| [pytest-dev/pluggy](https://github.com/pytest-dev/pluggy) | 0.13.0 | [0.13.0](https://github.com/pytest-dev/pluggy/releases/tag/0.13.0) |
|
||||
| [pexpect/ptyprocess](https://github.com/pexpect/ptyprocess) | 0.6.0 | [0.6.0](https://github.com/pexpect/ptyprocess/releases/tag/0.6.0) |
|
||||
| [pytest-dev/py](https://github.com/pytest-dev/py) | 1.8.0 | [1.8.0](https://github.com/pytest-dev/py/releases/tag/1.8.0) |
|
||||
| [pyparsing/pyparsing](https://github.com/pyparsing/pyparsing) | 2.4.5 | [pyparsing_2.4.5](https://github.com/pyparsing/pyparsing/releases/tag/pyparsing_2.4.5) |
|
||||
| [pytest-dev/pytest](https://github.com/pytest-dev/pytest) | 5.3.0 | [5.3.0](https://github.com/pytest-dev/pytest/releases/tag/5.3.0) |
|
||||
| [stub42/pytz](https://github.com/stub42/pytz) | 2019.3 | [release_2019.3](https://github.com/stub42/pytz/releases/tag/release_2019.3) |
|
||||
| [uiri/toml](https://github.com/uiri/toml) | 0.10.0 | [0.10.0](https://github.com/uiri/toml/releases/tag/0.10.0) |
|
||||
| [pallets/werkzeug](https://github.com/pallets/werkzeug) | 0.16.0 | [0.16.0](https://github.com/pallets/werkzeug/releases/tag/0.16.0) |
|
||||
| [dmnfarrell/tkintertable](https://github.com/dmnfarrell/tkintertable) | 1.2 | [v1.2](https://github.com/dmnfarrell/tkintertable/releases/tag/v1.2) |
|
||||
| [wxWidgets/wxPython-Classic](https://github.com/wxWidgets/wxPython-Classic) | 2.9.1.1 | [wxPy-2.9.1.1](https://github.com/wxWidgets/wxPython-Classic/releases/tag/wxPy-2.9.1.1) |
|
||||
| [nasa/fprime](https://github.com/nasa/fprime) | 1.3 | [NASA-v1.3](https://github.com/nasa/fprime/releases/tag/NASA-v1.3) |
|
||||
| [nucleic/cppy](https://github.com/nucleic/cppy) | 1.1.0 | [1.1.0](https://github.com/nucleic/cppy/releases/tag/1.1.0) |
|
||||
| [opencv/opencv](https://github.com/opencv/opencv) | 4.5.1 | [4.5.1](https://github.com/opencv/opencv/releases/tag/4.5.1) |
|
||||
| [curl/curl](https://github.com/curl/curl) | 7.72.0 | [curl-7_72_0](https://github.com/curl/curl/releases/tag/curl-7_72_0) |
|
||||
| [madler/zlib](https://github.com/madler/zlib) | 1.2.11 | [v1.2.11](https://github.com/madler/zlib/releases/tag/v1.2.11) |
|
||||
| [apache/lucene](https://github.com/apache/lucene) | 7.7.3 | [releases/lucene-solr/7.7.3](https://github.com/apache/lucene/releases/tag/releases%2Flucene-solr%2F7.7.3) |
|
||||
| [yaml/libyaml](https://github.com/yaml/libyaml) | 0.2.5 | [0.2.5](https://github.com/yaml/libyaml/releases/tag/0.2.5) |
|
||||
| [elastic/elasticsearch](https://github.com/elastic/elasticsearch) | 6.8.1 | [v6.8.1](https://github.com/elastic/elasticsearch/releases/tag/v6.8.1) |
|
||||
| [twbs/bootstrap](https://github.com/twbs/bootstrap) | 4.3.1 | [v4.3.1](https://github.com/twbs/bootstrap/releases/tag/v4.3.1) |
|
||||
| [vuejs/vue](https://github.com/vuejs/vue) | 2.6.10 | [v2.6.10](https://github.com/vuejs/vue/releases/tag/v2.6.10) |
|
||||
| [carrotsearch/hppc](https://github.com/carrotsearch/hppc) | 0.7.1 | [0.7.1](https://github.com/carrotsearch/hppc/releases/tag/0.7.1) |
|
||||
| [JodaOrg/joda-time](https://github.com/JodaOrg/joda-time) | 2.10.1 | [v2.10.1](https://github.com/JodaOrg/joda-time/releases/tag/v2.10.1) |
|
||||
| [tdunning/t-digest](https://github.com/tdunning/t-digest) | 3.2 | [t-digest-3.2](https://github.com/tdunning/t-digest/releases/tag/t-digest-3.2) |
|
||||
| [HdrHistogram/HdrHistogram](https://github.com/HdrHistogram/HdrHistogram) | 2.1.9 | [HdrHistogram-2.1.9](https://github.com/HdrHistogram/HdrHistogram/releases/tag/HdrHistogram-2.1.9) |
|
||||
| [locationtech/spatial4j](https://github.com/locationtech/spatial4j) | 0.7 | [spatial4j-0.7](https://github.com/locationtech/spatial4j/releases/tag/spatial4j-0.7) |
|
||||
| [locationtech/jts](https://github.com/locationtech/jts) | 1.15.0 | [jts-1.15.0](https://github.com/locationtech/jts/releases/tag/jts-1.15.0) |
|
||||
| [apache/log4j](https://github.com/apache/log4j) | 2.11 | [v1_2_11](https://github.com/apache/log4j/releases/tag/v1_2_11) |
|
||||
|
||||
### Further reading
|
||||
|
||||
|
||||
@@ -64,7 +64,7 @@ We require some basic information at the time of account creation. When you crea
|
||||
##### Payment information
|
||||
If you sign on to a paid Account with us, send funds through the GitHub Sponsors Program, or buy an application on GitHub Marketplace, we collect your full name, address, and credit card information or PayPal information. Please note, GitHub does not process or store your credit card information or PayPal information, but our third-party payment processor does.
|
||||
|
||||
If you list and sell an application on [GitHub Marketplace](https://github.com/marketplace), we require your banking information. If you raise funds through the [GitHub Sponsors Program](https://github.com/sponsors), we require some [additional information](/github/supporting-the-open-source-community-with-github-sponsors/becoming-a-sponsored-developer#submitting-your-bank-information) through the registration process for you to participate in and receive funds through those services and for compliance purposes.
|
||||
If you list and sell an application on [GitHub Marketplace](https://github.com/marketplace), we require your banking information. If you raise funds through the [GitHub Sponsors Program](https://github.com/sponsors), we require some [additional information](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account#submitting-your-bank-information) through the registration process for you to participate in and receive funds through those services and for compliance purposes.
|
||||
|
||||
##### Profile information
|
||||
You may choose to give us more information for your Account profile, such as your full name, an avatar which may include a photograph, your biography, your location, your company, and a URL to a third-party website. This information may include User Personal Information. Please note that your profile information may be visible to other Users of our Service.
|
||||
@@ -77,7 +77,7 @@ If you have a paid Account with us, sell an application listed on [GitHub Market
|
||||
##### Usage information
|
||||
If you're accessing our Service or Website, we automatically collect the same basic information that most services collect, subject, where necessary, to your consent. This includes information about how you use the Service, such as the pages you view, the referring site, your IP address and session information, and the date and time of each request. This is information we collect from every visitor to the Website, whether they have an Account or not. This information may include User Personal information.
|
||||
|
||||
##### Cookies
|
||||
##### Cookies
|
||||
As further described below, we automatically collect information from cookies (such as cookie ID and settings) to keep you logged in, to remember your preferences, to identify you and your device and to analyze your use of our service.
|
||||
|
||||
##### Device information
|
||||
@@ -147,7 +147,7 @@ For more information about our disclosure in response to legal requests, see our
|
||||
We may share User Personal Information if we are involved in a merger, sale, or acquisition of corporate entities or business units. If any such change of ownership happens, we will ensure that it is under terms that preserve the confidentiality of User Personal Information, and we will notify you on our Website or by email before any transfer of your User Personal Information. The organization receiving any User Personal Information will have to honor any promises we made in our Privacy Statement or Terms of Service.
|
||||
|
||||
#### Aggregate, non-personally identifying information
|
||||
We share certain aggregated, non-personally identifying information with others about how our users, collectively, use GitHub, or how our users respond to our other offerings, such as our conferences or events.
|
||||
We share certain aggregated, non-personally identifying information with others about how our users, collectively, use GitHub, or how our users respond to our other offerings, such as our conferences or events.
|
||||
|
||||
We **do not** sell your User Personal Information for monetary or other consideration.
|
||||
|
||||
@@ -157,13 +157,13 @@ Please note: The California Consumer Privacy Act of 2018 (“CCPA”) requires b
|
||||
|
||||
#### Access to private repositories
|
||||
|
||||
If your repository is private, you control the access to your Content. If you include User Personal Information or Sensitive Personal Information, that information may only be accessible to GitHub in accordance with this Privacy Statement. GitHub personnel [do not access private repository content](/github/site-policy/github-terms-of-service#e-private-repositories) except for
|
||||
If your repository is private, you control the access to your Content. If you include User Personal Information or Sensitive Personal Information, that information may only be accessible to GitHub in accordance with this Privacy Statement. GitHub personnel [do not access private repository content](/github/site-policy/github-terms-of-service#e-private-repositories) except for
|
||||
- security purposes
|
||||
- to assist the repository owner with a support matter
|
||||
- to maintain the integrity of the Service
|
||||
- to comply with our legal obligations
|
||||
- if we have reason to believe the contents are in violation of the law, or
|
||||
- with your consent.
|
||||
- if we have reason to believe the contents are in violation of the law, or
|
||||
- with your consent.
|
||||
|
||||
However, while we do not generally search for content in your repositories, we may scan our servers and content to detect certain tokens or security signatures, known active malware, known vulnerabilities in dependencies, or other content known to violate our Terms of Service, such as violent extremist or terrorist content or child exploitation imagery, based on algorithmic fingerprinting techniques (collectively, "automated scanning"). Our Terms of Service provides more details on [private repositories](/github/site-policy/github-terms-of-service#e-private-repositories).
|
||||
|
||||
@@ -238,13 +238,13 @@ That said, the email address you have supplied [via your Git commit settings](/g
|
||||
|
||||
#### Cookies
|
||||
|
||||
GitHub only uses strictly necessary cookies. Cookies are small text files that websites often store on computer hard drives or mobile devices of visitors.
|
||||
GitHub only uses strictly necessary cookies. Cookies are small text files that websites often store on computer hard drives or mobile devices of visitors.
|
||||
|
||||
We use cookies solely to provide, secure, and improve our service. For example, we use them to keep you logged in, remember your preferences, identify your device for security purposes, analyze your use of our service, compile statistical reports, and provide information for future development of GitHub. We use our own cookies for analytics purposes, but do not use any third-party analytics service providers.
|
||||
We use cookies solely to provide, secure, and improve our service. For example, we use them to keep you logged in, remember your preferences, identify your device for security purposes, analyze your use of our service, compile statistical reports, and provide information for future development of GitHub. We use our own cookies for analytics purposes, but do not use any third-party analytics service providers.
|
||||
|
||||
By using our service, you agree that we can place these types of cookies on your computer or device. If you disable your browser or device’s ability to accept these cookies, you will not be able to log in or use our service.
|
||||
|
||||
We provide more information about [cookies on GitHub](/github/site-policy/github-subprocessors-and-cookies#cookies-on-github) on our [GitHub Subprocessors and Cookies](/github/site-policy/github-subprocessors-and-cookies) page that describes the cookies we set, the needs we have for those cookies, and the expiration of such cookies.
|
||||
We provide more information about [cookies on GitHub](/github/site-policy/github-subprocessors-and-cookies#cookies-on-github) on our [GitHub Subprocessors and Cookies](/github/site-policy/github-subprocessors-and-cookies) page that describes the cookies we set, the needs we have for those cookies, and the expiration of such cookies.
|
||||
|
||||
#### DNT
|
||||
|
||||
@@ -321,7 +321,7 @@ In the unlikely event that a dispute arises between you and GitHub regarding our
|
||||
|
||||
### Changes to our Privacy Statement
|
||||
|
||||
Although most changes are likely to be minor, GitHub may change our Privacy Statement from time to time. We will provide notification to Users of material changes to this Privacy Statement through our Website at least 30 days prior to the change taking effect by posting a notice on our home page or sending email to the primary email address specified in your GitHub account. We will also update our [Site Policy repository](https://github.com/github/site-policy/), which tracks all changes to this policy. For other changes to this Privacy Statement, we encourage Users to [watch](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository) or to check our Site Policy repository frequently.
|
||||
Although most changes are likely to be minor, GitHub may change our Privacy Statement from time to time. We will provide notification to Users of material changes to this Privacy Statement through our Website at least 30 days prior to the change taking effect by posting a notice on our home page or sending email to the primary email address specified in your GitHub account. We will also update our [Site Policy repository](https://github.com/github/site-policy/), which tracks all changes to this policy. For other changes to this Privacy Statement, we encourage Users to [watch](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository) or to check our Site Policy repository frequently.
|
||||
|
||||
### License
|
||||
|
||||
|
||||
@@ -1,44 +0,0 @@
|
||||
---
|
||||
title: About GitHub Sponsors for open source contributors
|
||||
intro: 'If you provide value to an open source project, you can become a sponsored contributor to receive payments for your work.'
|
||||
redirect_from:
|
||||
- /articles/about-github-sponsors-for-sponsored-developers
|
||||
- /github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-sponsored-developers
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
### Joining {% data variables.product.prodname_sponsors %}
|
||||
|
||||
{% data reusables.sponsors.you-can-be-a-sponsored-developer %} 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)."
|
||||
|
||||
{% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, 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)."
|
||||
|
||||
After you join {% data variables.product.prodname_sponsors %}, you can add a sponsor button to the open source repository you contribute to, to increase the visibility of your {% data variables.product.prodname_sponsors %} profile and other funding platforms. For more information, see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)."
|
||||
|
||||
You can set a goal for your sponsorships. For more information, see "[Managing your sponsorship goal](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal)."
|
||||
|
||||
{% data reusables.sponsors.github-contact-applicants %}
|
||||
|
||||
### Sponsorship tiers
|
||||
|
||||
{% data reusables.sponsors.tier-details %} 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)," "[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), and "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)."
|
||||
|
||||
It's best to set up a range of different sponsorship options, including monthly and one-time tiers, to make it easy for anyone to support your work. In particular, one-time payments allow people to reward your efforts without worrying about whether their finances will support a regular payment schedule.
|
||||
|
||||
### Sponsorship payouts
|
||||
|
||||
{% data reusables.sponsors.no-fees %}
|
||||
|
||||
{% data reusables.sponsors.payout-info %}
|
||||
|
||||
For more information, see "[Managing your payouts from {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors)."
|
||||
|
||||
### Sharing feedback about {% data variables.product.prodname_sponsors %}
|
||||
|
||||
{% data reusables.sponsors.feedback %}
|
||||
|
||||
### Further reading
|
||||
- "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %}
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
title: About GitHub Sponsors
|
||||
intro: '{% data variables.product.prodname_sponsors %} allows the developer community to financially support the people and organizations who design, build, and maintain the open source projects they depend on, directly on {% data variables.product.product_name %}.'
|
||||
redirect_from:
|
||||
- /articles/about-github-sponsors
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
### 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.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)."
|
||||
|
||||
{% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, 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)."
|
||||
|
||||
When you become a sponsored developer or sponsored organization, additional terms for {% data variables.product.prodname_sponsors %} apply. For more information, see "[GitHub Sponsors Additional Terms](/github/site-policy/github-sponsors-additional-terms)."
|
||||
|
||||
### About the {% data variables.product.prodname_matching_fund %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** {% data reusables.sponsors.matching-fund-eligible %}
|
||||
|
||||
{% 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). 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)."
|
||||
|
||||
{% data reusables.sponsors.legal-additional-terms %}
|
||||
|
||||
### Sharing feedback about {% data variables.product.prodname_sponsors %}
|
||||
|
||||
{% data reusables.sponsors.feedback %}
|
||||
|
||||
### 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)"
|
||||
- "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %}
|
||||
@@ -1,19 +0,0 @@
|
||||
---
|
||||
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.
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
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**.
|
||||
|
||||
1. In the upper-right corner, click {% octicon "gear" aria-label="The gear icon" %} **Settings**.
|
||||
|
||||
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.
|
||||
|
||||
1. Click **Link account**.
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
---
|
||||
title: Configuring webhooks for events in your sponsored account
|
||||
intro: You can configure webhooks to alert you when you receive new sponsorships or existing sponsors make changes to their sponsorships.
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
### About webhooks for events in your sponsored 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).
|
||||
|
||||
### 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 %}
|
||||
{% 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 %}
|
||||
@@ -1,27 +0,0 @@
|
||||
---
|
||||
title: Contacting your sponsors
|
||||
intro: You can send an email to your sponsors who have opted in to receive updates about your work.
|
||||
redirect_from:
|
||||
- /articles/contacting-your-sponsors
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
### 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)."
|
||||
|
||||
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)."
|
||||
|
||||
You can also contact any one-time sponsors who contributed within the last 30 days and enabled updates.
|
||||
|
||||
### Contacting your sponsors
|
||||
|
||||
{% 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 %}
|
||||
{% data reusables.sponsors.write-sponsor-update %}
|
||||
{% data reusables.sponsors.publish-sponsor-update %}
|
||||
@@ -1,28 +0,0 @@
|
||||
---
|
||||
title: Editing your profile details for GitHub Sponsors
|
||||
intro: You can update the information that potential sponsors see about your work.
|
||||
redirect_from:
|
||||
- /articles/editing-your-sponsored-developer-profile
|
||||
- /github/supporting-the-open-source-community-with-github-sponsors/editing-your-sponsored-developer-profile
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
### 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 profile. We recommend including the following information.
|
||||
|
||||
- Open source work that you contribute to
|
||||
- Why you are committed to open source development
|
||||
|
||||
### Editing your profile details
|
||||
|
||||
{% 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 %}
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
title: Supporting the open source community with GitHub Sponsors
|
||||
shortTitle: GitHub Sponsors
|
||||
intro: 'You can support the people and organizations who design, build, and maintain the open source projects you depend on by compensating them via {% data variables.product.prodname_dotcom %}.'
|
||||
redirect_from:
|
||||
- /categories/supporting-the-open-source-community-with-github-sponsors
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
|
||||
### Table of Contents
|
||||
|
||||
{% topic_link_in_list /overview %}
|
||||
{% link_in_list /about-github-sponsors %}
|
||||
{% 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 %}
|
||||
{% link_in_list /setting-up-github-sponsors-for-your-organization %}
|
||||
{% link_in_list /editing-your-profile-details-for-github-sponsors %}
|
||||
{% link_in_list /managing-your-sponsorship-goal %}
|
||||
{% link_in_list /managing-your-sponsorship-tiers %}
|
||||
{% link_in_list /viewing-your-sponsors-and-sponsorships %}
|
||||
{% link_in_list /managing-your-payouts-from-github-sponsors %}
|
||||
{% link_in_list /configuring-webhooks-for-events-in-your-sponsored-account %}
|
||||
{% link_in_list /contacting-your-sponsors %}
|
||||
{% link_in_list /tax-information-for-github-sponsors %}
|
||||
@@ -1,22 +0,0 @@
|
||||
---
|
||||
title: Managing your payouts from GitHub Sponsors
|
||||
intro: 'You can view information about past and future payouts from {% data variables.product.prodname_sponsors %} and edit your bank information.'
|
||||
redirect_from:
|
||||
- /articles/managing-your-payouts-from-github-sponsors
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
### About payouts from {% data variables.product.prodname_sponsors %}
|
||||
|
||||
You can only manage your payouts from {% data variables.product.prodname_sponsors %} if you are paid through Stripe Connect. If you are paid through ACH transfer or wire transfer for your sponsored user account, you will not see the **Payouts** tab on your sponsored open source contributor dashboard. Sponsored organizations can only use Stripe Connect for payouts. 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#sponsorship-payouts)."
|
||||
|
||||
{% data reusables.sponsors.payout-info %}
|
||||
|
||||
### Viewing and editing payout information
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-payouts-tab %}
|
||||
{% data reusables.sponsors.edit-bank-information %}
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
title: Managing your sponsorship goal
|
||||
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: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
### About sponsorship goals
|
||||
|
||||
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.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Goals are intended to help people track momentum so only monthly sponsors contribute toward your goal.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
### Setting a goal
|
||||
|
||||
{% 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 %}
|
||||
{% data reusables.sponsors.publish-goal %}
|
||||
|
||||
### Editing a goal
|
||||
|
||||
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 %}
|
||||
{% data reusables.sponsors.publish-goal %}
|
||||
|
||||
### Retiring a goal
|
||||
|
||||
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 %}
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
title: Managing your sponsorship tiers
|
||||
intro: 'You can add a new sponsorship tier, or edit or retire an existing tier.'
|
||||
redirect_from:
|
||||
- /articles/changing-your-sponsorship-tiers
|
||||
- /github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
### About sponsorship tiers
|
||||
|
||||
{% data reusables.sponsors.tier-details %}
|
||||
|
||||
{% data reusables.sponsors.maximum-tier %}
|
||||
|
||||
### Adding a tier
|
||||
|
||||
{% 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 %}
|
||||
|
||||
### Editing or retiring a tier
|
||||
|
||||
{% 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 %}
|
||||
|
||||
### Enabling tiers with custom amounts
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsor-tiers-tab %}
|
||||
{% data reusables.sponsors.enable-custom-amounts %}
|
||||
|
||||
### Disabling tiers with custom amounts
|
||||
|
||||
You can disable tiers with custom amounts by deselecting the **Enable custom amounts** option on the **Sponsor tiers** tab. If you disable custom amounts, all custom tiers are retired.
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
title: Managing your sponsorship
|
||||
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: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
{% data reusables.sponsors.org-sponsors-release-phase %}
|
||||
|
||||
### Managing the privacy setting for your 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 email updates for 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 %}
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)"
|
||||
- "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)"
|
||||
@@ -1,10 +0,0 @@
|
||||
---
|
||||
title: Overview
|
||||
intro: 'Learn about {% data variables.product.prodname_sponsors %} and how you can get involved as a sponsor or open source contributor.'
|
||||
mapTopic: true
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
---
|
||||
title: Receiving sponsorships through GitHub Sponsors
|
||||
shortTitle: Receiving sponsorships
|
||||
intro: 'You or your organization can become a sponsored open source contributor to receive payments for your work, update your sponsorship details, and view and contact your sponsors.'
|
||||
mapTopic: true
|
||||
redirect_from:
|
||||
- /articles/receiving-sponsorships-as-a-sponsored-developer
|
||||
- /github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-as-a-sponsored-developer
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
@@ -1,88 +0,0 @@
|
||||
---
|
||||
title: Setting up GitHub Sponsors for your organization
|
||||
intro: 'Your organization can join {% data variables.product.prodname_sponsors %} to receive payments for your work.'
|
||||
redirect_from:
|
||||
- /articles/setting-up-github-sponsorship-for-your-organization
|
||||
- /articles/receiving-sponsorships-as-a-sponsored-organization
|
||||
permissions: 'Organization owners can set up {% data variables.product.prodname_sponsors %} for an organization.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
### Joining {% data variables.product.prodname_sponsors %}
|
||||
|
||||
{% data reusables.sponsors.you-can-be-a-sponsored-organization %} {% data reusables.sponsors.stripe-supported-regions %}
|
||||
|
||||
After you receive an invitation for your organization to join {% data variables.product.prodname_sponsors %}, you can complete the steps below to become a sponsored organization.
|
||||
|
||||
To join {% data variables.product.prodname_sponsors %} as an individual contributor outside an organization, 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)."
|
||||
|
||||
{% data reusables.sponsors.navigate-to-github-sponsors %}
|
||||
{% data reusables.sponsors.view-eligible-accounts %}
|
||||
3. To the right of your organization, click **Join the waitlist**.
|
||||
{% data reusables.sponsors.contact-info %}
|
||||
{% data reusables.sponsors.accept-legal-terms %}
|
||||
|
||||
### Completing your sponsored organization profile
|
||||
|
||||
{% 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.meet-the-team %}
|
||||
{% data reusables.sponsors.edit-featured-work %}
|
||||
{% data reusables.sponsors.opt-in-to-being-featured %}
|
||||
{% data reusables.sponsors.save-profile %}
|
||||
|
||||
### Creating sponsorship tiers
|
||||
|
||||
{% data reusables.sponsors.tier-details %}
|
||||
|
||||
{% data reusables.sponsors.maximum-tier %}
|
||||
|
||||
{% 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 %}
|
||||
{% data reusables.sponsors.enable-custom-amounts %}
|
||||
{% data reusables.sponsors.add-more-tiers %}
|
||||
|
||||
### Submitting your bank information
|
||||
|
||||
As a sponsored organization, you must receive payouts to a dedicated bank account for your organization in a supported region. You can get a business bank account through services like [Open Collective](https://opencollective.com/) and [Stripe Atlas](https://stripe.com/atlas). The region your organization legally operates in and the region of your bank account must match. The person setting up {% data variables.product.prodname_sponsors %} for the organization must live in the same supported region, too. {% data reusables.sponsors.stripe-supported-regions %}
|
||||
|
||||
{% data reusables.sponsors.double-check-stripe-info %}
|
||||
|
||||
{% 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.
|
||||
|
||||
### Submitting your tax information
|
||||
|
||||
{% data reusables.sponsors.tax-form-information-org %}
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.settings-tab %}
|
||||
{% data reusables.sponsors.country-of-residence %}
|
||||
{% data reusables.sponsors.overview-tab %}
|
||||
{% data reusables.sponsors.tax-form-link %}
|
||||
|
||||
### Enabling two-factor authentication (2FA) on your {% data variables.product.prodname_dotcom %} account
|
||||
|
||||
Before your organization can become a sponsored organization, you must enable 2FA on your {% data variables.product.product_name %} account. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)."
|
||||
|
||||
### Submitting your application to {% data variables.product.prodname_dotcom %} for approval
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.request-approval %}
|
||||
|
||||
{% data reusables.sponsors.github-review-app %}
|
||||
|
||||
### Further reading
|
||||
- "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)"
|
||||
- "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors)"
|
||||
@@ -1,83 +0,0 @@
|
||||
---
|
||||
title: Setting up GitHub Sponsors for your user account
|
||||
intro: 'You can become a sponsored developer by joining {% data variables.product.prodname_sponsors %}, completing your sponsored developer profile, creating sponsorship tiers, submitting your bank and tax information, and enabling two-factor authentication on your {% data variables.product.prodname_dotcom %} account.'
|
||||
redirect_from:
|
||||
- /articles/becoming-a-sponsored-developer
|
||||
- /github/supporting-the-open-source-community-with-github-sponsors/becoming-a-sponsored-developer
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
### Joining {% data variables.product.prodname_sponsors %}
|
||||
|
||||
{% data reusables.sponsors.you-can-be-a-sponsored-developer %} {% data reusables.sponsors.stripe-supported-regions %}
|
||||
|
||||
To join {% data variables.product.prodname_sponsors %} as an 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)."
|
||||
|
||||
{% data reusables.sponsors.navigate-to-github-sponsors %}
|
||||
2. If you are an organization owner, you have more than one eligible account. Click **View your eligible accounts**, then in the list of accounts, find your user account.
|
||||
3. Click **Join the waitlist**.
|
||||
{% data reusables.sponsors.contact-info %}
|
||||
{% data reusables.sponsors.accept-legal-terms %}
|
||||
|
||||
If you have a bank account in a supported region, {% data variables.product.prodname_dotcom %} will review your application within two weeks.
|
||||
|
||||
### Completing your sponsored developer profile
|
||||
|
||||
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-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 %}
|
||||
|
||||
### Creating sponsorship tiers
|
||||
|
||||
{% data reusables.sponsors.tier-details %}
|
||||
|
||||
{% data reusables.sponsors.maximum-tier %}
|
||||
|
||||
{% 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 %}
|
||||
{% data reusables.sponsors.enable-custom-amounts %}
|
||||
{% data reusables.sponsors.add-more-tiers %}
|
||||
|
||||
### Submitting your bank information
|
||||
|
||||
If you live in a supported region, you can follow these instructions to submit your bank information by creating a Stripe Connect account. Your region of residence and the region of your bank account must match. {% data reusables.sponsors.stripe-supported-regions %}
|
||||
|
||||
{% data reusables.sponsors.double-check-stripe-info %}
|
||||
|
||||
{% 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-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.settings-tab %}
|
||||
{% data reusables.sponsors.country-of-residence %}
|
||||
{% data reusables.sponsors.overview-tab %}
|
||||
{% data reusables.sponsors.tax-form-link %}
|
||||
|
||||
### Enabling two-factor authentication (2FA) on your {% data variables.product.prodname_dotcom %} account
|
||||
|
||||
Before you can become a sponsored developer, you must enable 2FA on your {% data variables.product.product_name %} account. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)."
|
||||
|
||||
### Submitting your application to {% data variables.product.prodname_dotcom %} for approval
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
4. Click **Request approval**.
|
||||
|
||||
|
||||
{% data reusables.sponsors.github-review-app %}
|
||||
@@ -1,67 +0,0 @@
|
||||
---
|
||||
title: Sponsoring an open source contributor
|
||||
intro: 'You can make a one-time or monthly recurring payment to a developer or organization who designs, creates, or maintains open source projects you depend on.'
|
||||
redirect_from:
|
||||
- /articles/sponsoring-a-developer
|
||||
- /articles/sponsoring-an-open-source-contributor
|
||||
- /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.
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
{% data reusables.sponsors.org-sponsors-release-phase %}
|
||||
|
||||
### About sponsorships
|
||||
|
||||
{% data reusables.sponsors.sponsorship-details %}
|
||||
|
||||
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
|
||||
|
||||
You use your normal payment method to sponsor an account on {% data variables.product.product_name %}. If your organization wants to pay by invoice, [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 the change is effective immediately, unless you are sponsoring on behalf of an organization that pays by invoice. {% data reusables.sponsors.prorated-sponsorship %} Your sponsorship is included in the next scheduled payment to the sponsored account.
|
||||
|
||||
{% 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 %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** {% data variables.product.prodname_dotcom %} is not responsible for how developers represent themselves nor does {% data variables.product.prodname_dotcom %} endorse any sponsored open source projects. The claims are solely the responsibility of the developer receiving the funds. Make sure you trust a person before offering a sponsorship. For more information, see the [{% data variables.product.prodname_sponsors %} Additional Terms](/github/site-policy/github-sponsors-additional-terms).
|
||||
|
||||
{% endnote %}
|
||||
|
||||
### Sponsoring an account
|
||||
|
||||
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 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**.
|
||||
|
||||
- To sponsor an organization, to the right of the organization's name, click **Sponsor**.
|
||||
|
||||
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.
|
||||
|
||||
{% data reusables.sponsors.review-tiers-to-select %}
|
||||
{% data reusables.sponsors.select-a-tier %}
|
||||
{% data reusables.sponsors.pay-prorated-amount %}
|
||||
{% data reusables.sponsors.select-sponsorship-billing %}
|
||||
|
||||
{% data reusables.sponsors.who-can-see-your-sponsorship %}
|
||||
|
||||
{% data reusables.sponsors.choose-updates %}
|
||||
{% data reusables.sponsors.sponsor-account %}
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
title: Sponsoring open source contributors
|
||||
intro: 'You can sponsor contributors, receive updates on developers and organizations you sponsor, and display a sponsor badge throughout {% data variables.product.product_name %}.'
|
||||
mapTopic: true
|
||||
redirect_from:
|
||||
- /articles/sponsoring-open-source-developers
|
||||
- /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-developers
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
@@ -1,23 +0,0 @@
|
||||
---
|
||||
title: Tax information for GitHub Sponsors
|
||||
intro: 'Sponsored developers and organizations must submit tax information to {% data variables.product.prodname_dotcom %} and are responsible for evaluating and paying their own taxes.'
|
||||
redirect_from:
|
||||
- /articles/tax-information-for-sponsored-developers
|
||||
- /github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-sponsored-developers
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
If you are a taxpayer in the United States, you must submit a W-9 before you can receive payments. If you are a taxpayer in any other region besides the United States, you must submit a W-8BEN before you can receive payments. 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#submitting-your-tax-information)" 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#submitting-your-tax-information)." {% data variables.product.prodname_dotcom %} will send you the appropriate forms, notify you when they are due, and give you a reasonable amount of time to complete and send in the forms.
|
||||
|
||||
If you are a taxpayer in the United States and earn more than $600 in a tax year, {% data variables.product.prodname_dotcom %} will send you a 1099 before January 31 of the next calendar year. We do not provide tax forms for international taxpayers.
|
||||
|
||||
{% data variables.product.prodname_dotcom %} does not withhold tax from {% data variables.product.prodname_sponsors %} payments. Sponsored developers are responsible for evaluating and paying their own taxes.
|
||||
|
||||
{% data reusables.sponsors.sponsorships-not-tax-deductible %}
|
||||
|
||||
### Further reading
|
||||
|
||||
- [Viewing your sponsors and sponsorships](/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships)
|
||||
@@ -1,36 +0,0 @@
|
||||
---
|
||||
title: Viewing your sponsors and sponsorships
|
||||
intro: You can view and export detailed information and analytics about your sponsors and sponsorships.
|
||||
redirect_from:
|
||||
- /articles/viewing-your-sponsors-and-sponsorships
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- sponsors
|
||||
---
|
||||
|
||||
### 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.
|
||||
|
||||
### Viewing your sponsors and sponsorships
|
||||
|
||||
{% 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.
|
||||
|
||||
|
||||
### Viewing recent sponsorship activity
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.activity-tab %}
|
||||
|
||||
### Exporting your sponsorship data
|
||||
|
||||
You can export your sponsorship transactions by month. {% data variables.product.company_short %} will send you an email with transaction 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.activity-tab %}
|
||||
1. Click {% octicon "download" aria-label="The download icon" %} **Export**.
|
||||
|
||||
1. Choose a time frame and a format for the data you'd like to export, then click **Start export**.
|
||||
|
||||
Reference in New Issue
Block a user