1
0
mirror of synced 2025-12-22 11:26:57 -05:00

Merge branch 'main' into update-billing-topics

This commit is contained in:
Sarita Iyer
2021-04-26 14:54:29 -04:00
committed by GitHub
169 changed files with 7856 additions and 3988 deletions

View File

@@ -25,3 +25,11 @@ Thanks again!
- [ ] I have reviewed my changes in staging. (look for the **deploy-to-heroku** link in your pull request, then click **View deployment**) - [ ] I have reviewed my changes in staging. (look for the **deploy-to-heroku** link in your pull request, then click **View deployment**)
- [ ] For content changes, I have reviewed the [localization checklist](https://github.com/github/docs/blob/main/contributing/localization-checklist.md) - [ ] For content changes, I have reviewed the [localization checklist](https://github.com/github/docs/blob/main/contributing/localization-checklist.md)
- [ ] For content changes, I have reviewed the [Content style guide for GitHub Docs](https://github.com/github/docs/blob/main/contributing/content-style-guide.md). - [ ] For content changes, I have reviewed the [Content style guide for GitHub Docs](https://github.com/github/docs/blob/main/contributing/content-style-guide.md).
### Writer impact (This section is for GitHub staff members only):
- [ ] This pull request impacts the contribution experience
- [ ] I have added the 'writer impact' label
- [ ] I have added a description and/or a video demo of the changes below (eg. a "before and after video")
<!-- Description of the writer impact here -->

View File

@@ -0,0 +1,69 @@
name: Copy to REST API issue to docs-content
# **What it does**: Copies an issue in the open source repo to the docs-content repo, comments on and closes the original issue
# **Why we have it**: REST API updates cannot be made in the open source repo. Instead, we copy the issue to an internal issue (we do not transfer so that the issue does not disappear for the contributor) and close the original issue.
# **Who does it impact**: Open source and docs-content maintainers
on:
issues:
types:
- labeled
jobs:
transfer-issue:
name: Transfer issue
runs-on: ubuntu-latest
if: github.event.label.name == 'rest-description' && github.repository == 'github/docs'
steps:
- name: Check if this run was triggered by a member of the docs team
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
id: triggered-by-member
with:
github-token: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
result-encoding: string
script: |
const triggerer_login = context.payload.sender.login
const teamMembers = await github.request(
`/orgs/github/teams/docs/members?per_page=100`
)
const logins = teamMembers.data.map(member => member.login)
if (logins.includes(triggerer_login)) {
console.log(`This workflow was triggered by ${triggerer_login} (on the docs team).`)
return 'true'
}
console.log(`This workflow was triggered by ${triggerer_login} (not on the docs team), so no action will be taken.`)
return 'false'
- name: Exit if not triggered by a docs team member
if: steps.triggered-by-member.outputs.result == 'false'
run: |
echo Aborting. This workflow must be triggered by a member of the docs team.
exit 1
- name: Create an issue in the docs-content repo
run: |
new_issue_url="$(gh issue create --title "$ISSUE_TITLE" --body "$ISSUE_BODY" --repo github/docs-content)"
echo 'NEW_ISSUE='$new_issue_url >> $GITHUB_ENV
env:
GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
ISSUE_TITLE: ${{ github.event.issue.title }}
ISSUE_BODY: ${{ github.event.issue.body }}
- name: Comment on the new issue
run: gh issue comment $NEW_ISSUE --body "This issue was originally opened in the open source repo as $OLD_ISSUE"
env:
GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
NEW_ISSUE: ${{ env.NEW_ISSUE }}
OLD_ISSUE: ${{ github.event.issue.html_url }}
- name: Comment on the old issue
run: gh issue comment $OLD_ISSUE --body "Thank you for opening this issue! Updates to the REST API description must be made internally. I have copied your issue to an internal issue, so I will close this issue."
env:
GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
OLD_ISSUE: ${{ github.event.issue.html_url }}
- name: Close the old issue
run: gh issue close $OLD_ISSUE
env:
GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
OLD_ISSUE: ${{ github.event.issue.html_url }}

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

View File

@@ -46,6 +46,7 @@ In the tutorial, you will first make a workflow file that uses the [`andymckay/l
uses: andymckay/labeler@1.0.2 uses: andymckay/labeler@1.0.2
with: with:
add-labels: "triage" add-labels: "triage"
repo-token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
``` ```
4. Customize the parameters in your workflow file: 4. Customize the parameters in your workflow file:

View File

@@ -48,6 +48,7 @@ In the tutorial, you will first make a workflow file that uses the [`andymckay/l
uses: andymckay/labeler@master uses: andymckay/labeler@master
with: with:
remove-labels: "needs review" remove-labels: "needs review"
repo-token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
``` ```
5. Customize the parameters in your workflow file: 5. Customize the parameters in your workflow file:

View File

@@ -53,7 +53,7 @@ When creating a group, you must choose a policy that defines which repositories
**Warning** **Warning**
{% indented_data_reference site.data.reusables.github-actions.self-hosted-runner-security spaces=3 %} {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %}
For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)."
@@ -85,7 +85,7 @@ When creating a group, you must choose a policy that defines which organizations
**Warning** **Warning**
{% indented_data_reference site.data.reusables.github-actions.self-hosted-runner-security spaces=3 %} {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %}
For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)."

View File

@@ -443,7 +443,9 @@ jobs:
path: vendor/bundle path: vendor/bundle
key: administrate-${{ matrix.image }}-${{ hashFiles('Gemfile.lock') }} key: administrate-${{ matrix.image }}-${{ hashFiles('Gemfile.lock') }}
- name: Install postgres headers - name: Install postgres headers
run: sudo apt-get install libpq-dev run: |
sudo apt-get update
sudo apt-get install libpq-dev
- name: Install dependencies - name: Install dependencies
run: bundle install --path vendor/bundle run: bundle install --path vendor/bundle
- name: Setup environment configuration - name: Setup environment configuration

View File

@@ -0,0 +1,19 @@
---
title: Approving workflow runs from public forks
intro: 'When a first-time contributor submits a pull request to a public repository, a maintainer with write access must approve any workflow runs.'
product: '{% data reusables.gated-features.actions %}'
versions:
free-pro-team: '*'
---
Forks of public repositories can submit pull requests that propose changes to a repository's {% data variables.product.prodname_actions %} workflows. Although workflows from forks do not have access to sensitive data such as secrets, they can be an annoyance for maintainers if they are modified for abusive purposes. To help prevent this, workflows on pull requests are not run automatically if they are received from first-time contributors, and must be approved first.
Maintainers with write access to the repository can use the following procedure to review and run workflows on pull requests from first-time contributors. After a contributor has at least one pull request merged into a project's repository, any future pull requests from that contributor's fork will automatically run workflows.
{% data reusables.repositories.sidebar-pr %}
{% data reusables.repositories.choose-pr-review %}
{% data reusables.repositories.changed-files %}
1. Inspect the proposed changes in the pull request and ensure that you are comfortable running your workflows on the pull request branch. You should be especially alert to any proposed changes in the `.github/workflows/` directory that affect workflow files.
1. If you are comfortable with running workflows on the pull request branch, return to the {% octicon "comment-discussion" aria-label="The discussion icon" %} **Conversation** tab, and under "Workflow(s) awaiting approval", click **Approve and run**.
![Approve and run workflows](/assets/images/help/pull_requests/actions-approve-and-run-workflows-from-fork.png)

View File

@@ -26,6 +26,7 @@ versions:
{% link_in_list /manually-running-a-workflow %} {% link_in_list /manually-running-a-workflow %}
{% link_in_list /re-running-a-workflow %} {% link_in_list /re-running-a-workflow %}
{% link_in_list /canceling-a-workflow %} {% link_in_list /canceling-a-workflow %}
{% link_in_list /approving-workflow-runs-from-public-forks %}
{% link_in_list /reviewing-deployments %} {% link_in_list /reviewing-deployments %}
{% link_in_list /disabling-and-enabling-a-workflow %} {% link_in_list /disabling-and-enabling-a-workflow %}
{% link_in_list /deleting-a-workflow-run %} {% link_in_list /deleting-a-workflow-run %}

View File

@@ -110,8 +110,8 @@ The following workflow will run on pushes to `releases/10` or `releases/beta/mon
on: on:
push: push:
branches: branches:
- 'releases/**' - 'releases/**'
- '!releases/**-alpha' - '!releases/**-alpha'
``` ```
### `on.<push|pull_request>.paths` ### `on.<push|pull_request>.paths`
@@ -128,7 +128,7 @@ When all the path names match patterns in `paths-ignore`, the workflow will not
on: on:
push: push:
paths-ignore: paths-ignore:
- 'docs/**' - 'docs/**'
``` ```
#### Example including paths #### Example including paths
@@ -139,7 +139,7 @@ If at least one path matches a pattern in the `paths` filter, the workflow runs.
on: on:
push: push:
paths: paths:
- '**.js' - '**.js'
``` ```
#### Excluding paths #### Excluding paths
@@ -160,8 +160,8 @@ This example runs anytime the `push` event includes a file in the `sub-project`
on: on:
push: push:
paths: paths:
- 'sub-project/**' - 'sub-project/**'
- '!sub-project/docs/**' - '!sub-project/docs/**'
``` ```
#### Git diff comparisons #### Git diff comparisons
@@ -478,15 +478,15 @@ jobs:
output1: ${{ steps.step1.outputs.test }} output1: ${{ steps.step1.outputs.test }}
output2: ${{ steps.step2.outputs.test }} output2: ${{ steps.step2.outputs.test }}
steps: steps:
- id: step1 - id: step1
run: echo "::set-output name=test::hello" run: echo "::set-output name=test::hello"
- id: step2 - id: step2
run: echo "::set-output name=test::world" run: echo "::set-output name=test::world"
job2: job2:
runs-on: ubuntu-latest runs-on: ubuntu-latest
needs: job1 needs: job1
steps: steps:
- run: echo ${{needs.job1.outputs.output1}} ${{needs.job1.outputs.output2}} - run: echo ${{needs.job1.outputs.output1}} ${{needs.job1.outputs.output2}}
``` ```
{% endraw %} {% endraw %}
@@ -556,14 +556,14 @@ jobs:
name: My Job name: My Job
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Print a greeting - name: Print a greeting
env: env:
MY_VAR: Hi there! My name is MY_VAR: Hi there! My name is
FIRST_NAME: Mona FIRST_NAME: Mona
MIDDLE_NAME: The MIDDLE_NAME: The
LAST_NAME: Octocat LAST_NAME: Octocat
run: | run: |
echo $MY_VAR $FIRST_NAME $MIDDLE_NAME $LAST_NAME. echo $MY_VAR $FIRST_NAME $MIDDLE_NAME $LAST_NAME.
``` ```
{% endraw %} {% endraw %}

View File

@@ -93,6 +93,10 @@ We recommend using actions to interact with the software installed on runners. T
If there is a tool that you'd like to request, please open an issue at [actions/virtual-environments](https://github.com/actions/virtual-environments). This repository also contains announcements about all major software updates on runners. If there is a tool that you'd like to request, please open an issue at [actions/virtual-environments](https://github.com/actions/virtual-environments). This repository also contains announcements about all major software updates on runners.
#### Installing additional software
You can install additional software on {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see "[Customizing GitHub-hosted runners](/actions/using-github-hosted-runners/customizing-github-hosted-runners)".
### IP addresses ### IP addresses
{% note %} {% note %}

View File

@@ -0,0 +1,92 @@
---
title: Customizing GitHub-hosted runners
intro: >-
You can install additional software on GitHub-hosted runners as a
part of your workflow.
product: '{% data reusables.gated-features.actions %}'
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
type: tutorial
topics:
- Workflows
---
{% data reusables.actions.enterprise-github-hosted-runners %}
If you require additional software packages on {% data variables.product.prodname_dotcom %}-hosted runners, you can create a job that installs the packages as part of your workflow.
To see which packages are already installed by default, see "[Preinstalled software](/actions/using-github-hosted-runners/about-github-hosted-runners#preinstalled-software)."
This guide demonstrates how to create a job that installs additional software on a {% data variables.product.prodname_dotcom %}-hosted runner.
### Installing software on Ubuntu runners
The following example demonstrates how to install an `apt` package as part of a job.
{% raw %}
```yaml
name: Build on Ubuntu
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Check out repository code
uses: actions/checkout@v2
- name: Install jq tool
run: |
sudo apt-get update
sudo apt-get install jq
```
{% endraw %}
{% note %}
**Note:** Always run `sudo apt-get update` before installing a package. In case the `apt` index is stale, this command fetches and re-indexes any available packages, which helps prevent package installation failures.
{% endnote %}
### Installing software on macOS runners
The following example demonstrates how to install Brew packages and casks as part of a job.
{% raw %}
```yaml
name: Build on macOS
on: push
jobs:
build:
runs-on: macos-latest
steps:
- name: Check out repository code
uses: actions/checkout@v2
- name: Install GitHub CLI
run: |
brew update
brew install gh
- name: Install Microsoft Edge
run: |
brew update
brew install --cask microsoft-edge
```
{% endraw %}
### Installing software on Windows runners
The following example demonstrates how to use [Chocolatey](https://community.chocolatey.org/packages) to install the {% data variables.product.prodname_dotcom %} CLI as part of a job.
{% raw %}
```yaml
name: Build on Windows
on: push
jobs:
build:
runs-on: windows-latest
steps:
- run: choco install gh
- run: gh version
```
{% endraw %}

View File

@@ -11,6 +11,7 @@ versions:
{% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.enterprise-github-hosted-runners %}
{% link_in_list /about-github-hosted-runners %} {% link_in_list /about-github-hosted-runners %}
{% link_in_list /customizing-github-hosted-runners %}
{% link_in_list /about-ae-hosted-runners %} {% link_in_list /about-ae-hosted-runners %}
{% link_in_list /adding-ae-hosted-runners %} {% link_in_list /adding-ae-hosted-runners %}
{% link_in_list /using-ae-hosted-runners-in-a-workflow %} {% link_in_list /using-ae-hosted-runners-in-a-workflow %}

View File

@@ -89,7 +89,12 @@ There are two types of snapshots:
{% note %} {% note %}
**Note**: Installing a hotpatch using the {% data variables.enterprise.management_console %} is not available in clustered environments. To install a hotpatch in a clustered environment, see "[Upgrading a cluster](/enterprise/{{ currentVersion }}/admin/clustering/upgrading-a-cluster#upgrading-with-a-hotpatch)." **{% if currentVersion ver_gt "enterprise-server@2.22" %}Notes{% else %}Note{% endif %}**:
{% if currentVersion ver_gt "enterprise-server@2.22" %}
- If {% data variables.product.product_location %} is running a release candidate build, you can't upgrade with a hotpatch.
- {% endif %}Installing a hotpatch using the {% data variables.enterprise.management_console %} is not available in clustered environments. To install a hotpatch in a clustered environment, see "[Upgrading a cluster](/enterprise/{{ currentVersion }}/admin/clustering/upgrading-a-cluster#upgrading-with-a-hotpatch)."
{% endnote %} {% endnote %}

View File

@@ -14,7 +14,7 @@ topics:
Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps: Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps:
* Create your Amazon S3 bucket for storing artifacts generated by workflow runs. {% indented_data_reference site.data.reusables.actions.enterprise-s3-permission spaces=2 %} * Create your Amazon S3 bucket for storing artifacts generated by workflow runs. {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %}
{% data reusables.actions.enterprise-common-prereqs %} {% data reusables.actions.enterprise-common-prereqs %}

View File

@@ -15,7 +15,7 @@ topics:
Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps: Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps:
* To avoid resource contention on the appliance, we recommend that MinIO be hosted separately from {% data variables.product.product_location %}. * To avoid resource contention on the appliance, we recommend that MinIO be hosted separately from {% data variables.product.product_location %}.
* Create your bucket for storing workflow artifacts. To set up your bucket and access key, see the [MinIO documentation](https://docs.min.io/docs/minio-gateway-for-nas.html). {% indented_data_reference site.data.reusables.actions.enterprise-s3-permission spaces=2 %} * Create your bucket for storing workflow artifacts. To set up your bucket and access key, see the [MinIO documentation](https://docs.min.io/docs/minio-gateway-for-nas.html). {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %}
{% data reusables.actions.enterprise-common-prereqs %} {% data reusables.actions.enterprise-common-prereqs %}

View File

@@ -26,12 +26,19 @@ You can use {% data variables.product.prodname_github_connect %} to allow {% dat
Once {% data variables.product.prodname_github_connect %} is configured, you can use the latest version of an action by deleting its local repository in the `actions` organization on your instance. For example, if your enterprise instance is using the `actions/checkout@v1` action, and you need to use `actions/checkout@v2` which isn't available on your enterprise instance, perform the following steps to be able to use the latest `checkout` action from {% data variables.product.prodname_dotcom_the_website %}: Once {% data variables.product.prodname_github_connect %} is configured, you can use the latest version of an action by deleting its local repository in the `actions` organization on your instance. For example, if your enterprise instance is using the `actions/checkout@v1` action, and you need to use `actions/checkout@v2` which isn't available on your enterprise instance, perform the following steps to be able to use the latest `checkout` action from {% data variables.product.prodname_dotcom_the_website %}:
1. To get the required access to delete the `checkout` repository, use the `ghe-org-admin-promote` command to promote a user to be an owner of the bundled `actions` organization. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" and "[`ghe-org-admin-promote`](/admin/configuration/command-line-utilities#ghe-org-admin-promote)." For example: 1. By default, site administrators are not owners of the bundled actions organization. To get the required access to delete the `checkout` repository, use the `ghe-org-admin-promote` command to promote a user to be an owner of the bundled `actions` organization. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" and "[`ghe-org-admin-promote`](/admin/configuration/command-line-utilities#ghe-org-admin-promote)." For example:
```shell ```shell
ghe-org-admin-promote -u <em>USERNAME</em> -o actions $ ghe-org-admin-promote -u octocat -o actions
Do you want to give organization admin privileges for actions to octocat? (y/N) y
Making octocat an admin of actions
--> Adding octocat as an admin of actions
--> octocat is now an admin of the actions organization
--> Done.
``` ```
1. On your {% data variables.product.product_name %} instance, delete the `checkout` repository within the `actions` organization. For information on how to delete a repository, see "[Deleting a repository 1. On your {% data variables.product.product_name %} instance, delete the `checkout` repository within the `actions` organization. For information on how to delete a repository, see "[Deleting a repository
](/github/administering-a-repository/deleting-a-repository)." ](/github/administering-a-repository/deleting-a-repository)."
1. It is recommended that you leave the `actions` organization once you no longer require administrative access. For more information, see "[Removing yourself from an organization
](/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-an-organization)."
1. Configure your workflow's YAML to use `actions/checkout@v2`. 1. Configure your workflow's YAML to use `actions/checkout@v2`.
1. Each time your workflow runs, the runner will use the `v2` version of `actions/checkout` from {% data variables.product.prodname_dotcom_the_website %}. 1. Each time your workflow runs, the runner will use the `v2` version of `actions/checkout` from {% data variables.product.prodname_dotcom_the_website %}.

View File

@@ -34,6 +34,12 @@ If you don't have private mode enabled, the migration script will have no effect
### Running the migration ### Running the migration
1. Connect to the administrative shell. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/admin/installation/accessing-the-administrative-shell-ssh)." 1. Connect to the administrative shell. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/admin/installation/accessing-the-administrative-shell-ssh)."
{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
2. Run the migration command.
```shell
github-env bin/safe-ruby lib/github/transitions/20191210220630_convert_public_ghes_repos_to_internal.rb --verbose -w | tee -a /tmp/convert_public_ghes_repos_to_internal.log
```
{% else %}
2. Navigate to the `/data/github/current` directory. 2. Navigate to the `/data/github/current` directory.
```shell ```shell
cd /data/github/current cd /data/github/current
@@ -42,6 +48,7 @@ If you don't have private mode enabled, the migration script will have no effect
```shell ```shell
sudo bin/safe-ruby lib/github/transitions/20191210220630_convert_public_ghes_repos_to_internal.rb --verbose -w | tee -a /tmp/convert_public_ghes_repos_to_internal.log sudo bin/safe-ruby lib/github/transitions/20191210220630_convert_public_ghes_repos_to_internal.rb --verbose -w | tee -a /tmp/convert_public_ghes_repos_to_internal.log
``` ```
{% endif %}
Log output will appear in the terminal and `/tmp/convert_public_ghes_repos_to_internal.log`. Log output will appear in the terminal and `/tmp/convert_public_ghes_repos_to_internal.log`.

View File

@@ -20,6 +20,7 @@ topics:
{% link_in_list /exploring-the-dependencies-of-a-repository %} {% link_in_list /exploring-the-dependencies-of-a-repository %}
{% topic_link_in_list /keeping-your-dependencies-updated-automatically %} {% topic_link_in_list /keeping-your-dependencies-updated-automatically %}
{% link_in_list /about-dependabot-version-updates %} {% link_in_list /about-dependabot-version-updates %}
{% link_in_list /upgrading-from-dependabotcom-to-github-native-dependabot %}
{% link_in_list /enabling-and-disabling-version-updates %} {% link_in_list /enabling-and-disabling-version-updates %}
{% link_in_list /listing-dependencies-configured-for-version-updates %} {% link_in_list /listing-dependencies-configured-for-version-updates %}
{% link_in_list /managing-pull-requests-for-dependency-updates %} {% link_in_list /managing-pull-requests-for-dependency-updates %}

View File

@@ -0,0 +1,36 @@
---
title: Upgrading from Dependabot.com to GitHub-native Dependabot
intro: 'You can upgrade to GitHub-native Dependabot by merging a pull request that will allow your dependencies to continue being updated.'
versions:
free-pro-team: '*'
topics:
- repositories
---
### About upgrading from Dependabot Preview to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}
Dependabot Preview has been built directly into {% data variables.product.prodname_dotcom %}, so you can use {% data variables.product.prodname_dependabot %} alongside all the other functionality in {% data variables.product.prodname_dotcom %} without having to install and use a separate application. By migrating to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, we can also focus on bringing lots of exciting new features to {% data variables.product.prodname_dependabot %}, including more [ecosystem updates](https://github.com/github/roadmap/issues/150), [improved notifications](https://github.com/github/roadmap/issues/133), and {% data variables.product.prodname_dependabot %} support for [{% data variables.product.prodname_ghe_server %}](https://github.com/github/roadmap/issues/86) and [{% data variables.product.prodname_ghe_managed %}](https://github.com/github/roadmap/issues/135).
### Differences between Dependabot Preview and {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}
While most of the Dependabot Preview features exist in {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, a few remain unavailable:
- **Live updates:** We hope to bring these back in the future. For now, you can run {% data variables.product.prodname_dotcom %} {% data variables.product.prodname_dependabot %} daily to catch new packages within one day of release.
- **PHP environment variable registries:** For now, you can use {% data variables.product.prodname_actions %} to fetch dependencies from these registries.
- **Auto-merge:** We always recommend verifying your dependencies before merging them; therefore, auto-merge will not be supported for the foreseeable future. For those of you who have vetted your dependencies, or are only using internal dependencies, we recommend adding third-party auto-merge apps, or setting up GitHub Actions to merge.
In {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, you can configure all version updates using the configuration file. This file is similar to the Dependabot Preview configuration file with a few changes and improvements that will be automatically included in your upgrade pull request. For more information about the upgrade pull request, see "[Upgrading to GitHub-native Dependabot](/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot#upgrading-to-github-native-dependabot)".
To see update logs for {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} that were previously on the Dependabot.com dashboard:
1. Navigate to your repositorys **Insights** page.
2. Click **Dependency graph** to the left.
3. Click **{% data variables.product.prodname_dependabot %}**.
For more information about version updates with {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, see "[About Dependabot version updates](/code-security/supply-chain-security/about-dependabot-version-updates)."
### Upgrading to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}
Upgrading from Dependabot Preview to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} requires only one step: merge the *Upgrade to GitHub-native Dependabot* pull request in your repository. This pull request includes the updated configuration file needed for {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}.
If you have any questions or need help migrating, you can view or open issues in the [dependabot/dependabot-core](https://github.com/dependabot/dependabot-core/issues) repository.

View File

@@ -22,6 +22,12 @@ With wikis, you can write content just like everywhere else on {% data variables
You can edit wikis directly on {% data variables.product.product_name %}, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on {% data variables.product.product_location %} to contribute to a wiki in {% if currentVersion == "github-ae@latest" %}an internal{% else %}a public{% endif %} repository. For more information, see "[Changing access permissions for wikis](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)". You can edit wikis directly on {% data variables.product.product_name %}, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on {% data variables.product.product_location %} to contribute to a wiki in {% if currentVersion == "github-ae@latest" %}an internal{% else %}a public{% endif %} repository. For more information, see "[Changing access permissions for wikis](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)".
{% note %}
**Note:** Search engines will not index the contents of wikis. To have your content indexed by search engines, you can use [{% data variables.product.prodname_pages %}](/pages) in a public repository.
{% endnote %}
### Further reading ### Further reading
- "[Adding or editing wiki pages](/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages)" - "[Adding or editing wiki pages](/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages)"

View File

@@ -140,18 +140,16 @@ You'll add this new method as a [Sinatra helper](https://github.com/sinatra/sina
``` ruby ``` ruby
# Create a new check run with the status queued # Create a new check run with the status queued
def create_check_run def create_check_run
# # At the time of writing, Octokit does not support the Checks API yet, but @installation_client.create_check_run(
# it does provide generic HTTP methods you can use: # [String, Integer, Hash, Octokit Repository object] A GitHub repository.
# /rest/reference/checks#create-a-check-run @payload['repository']['full_name'],
check_run = @installation_client.post( # [String] The name of your check run.
"repos/#{@payload['repository']['full_name']}/check-runs", 'Octo RuboCop',
{ # [String] The SHA of the commit to check
accept: 'application/vnd.github.v3+json', # The payload structure differs depending on whether a check run or a check suite event occurred.
# The name of your check run. @payload['check_run'].nil? ? @payload['check_suite']['head_sha'] : @payload['check_run']['head_sha'],
name: 'Octo RuboCop', # [Hash] 'Accept' header option, to avoid a warning about the API not being ready for production use.
# The payload structure differs depending on whether a check run or a check suite event occurred. accept: 'application/vnd.github.v3+json'
head_sha: @payload['check_run'].nil? ? @payload['check_suite']['head_sha'] : @payload['check_run']['head_sha']
}
) )
end end
``` ```
@@ -159,25 +157,22 @@ end
``` ruby ``` ruby
# Create a new check run with the status queued # Create a new check run with the status queued
def create_check_run def create_check_run
# # At the time of writing, Octokit does not support the Checks API yet, but @installation_client.create_check_run(
# it does provide generic HTTP methods you can use: # [String, Integer, Hash, Octokit Repository object] A GitHub repository.
# /rest/reference/checks#create-a-check-run @payload['repository']['full_name'],
check_run = @installation_client.post( # [String] The name of your check run.
"repos/#{@payload['repository']['full_name']}/check-runs", 'Octo RuboCop',
{ # [String] The SHA of the commit to check
# This header allows for beta access to Checks API # The payload structure differs depending on whether a check run or a check suite event occurred.
accept: 'application/vnd.github.antiope-preview+json', @payload['check_run'].nil? ? @payload['check_suite']['head_sha'] : @payload['check_run']['head_sha'],
# The name of your check run. # [Hash] 'Accept' header option, to avoid a warning about the API not being ready for production use.
name: 'Octo RuboCop', accept: 'application/vnd.github.antiope-preview+json'
# The payload structure differs depending on whether a check run or a check suite event occurred.
head_sha: @payload['check_run'].nil? ? @payload['check_suite']['head_sha'] : @payload['check_run']['head_sha']
}
) )
end end
``` ```
{% endif %} {% endif %}
This code calls the "[Create a check run](/rest/reference/checks#create-a-check-run)" endpoint using the generic [HTTP `POST` method](http://octokit.github.io/octokit.rb/Octokit/Connection.html#post-instance_method). This method takes two parameters: the URL of the endpoint and the input parameters to the method. This code calls the "[Create a check run](/rest/reference/checks#create-a-check-run)" endpoint using the [create_check_run method](https://rdoc.info/gems/octokit/Octokit%2FClient%2FChecks:create_check_run).
To create a check run, only two input parameters are required: `name` and `head_sha`. We will use [Rubocop](https://rubocop.readthedocs.io/en/latest/) to implement the CI test later in this quickstart, which is why the name "Octo Rubocop" is used here, but you can choose any name you'd like for the check run. To create a check run, only two input parameters are required: `name` and `head_sha`. We will use [Rubocop](https://rubocop.readthedocs.io/en/latest/) to implement the CI test later in this quickstart, which is why the name "Octo Rubocop" is used here, but you can choose any name you'd like for the check run.
@@ -240,31 +235,22 @@ def initiate_check_run
# to 'in_progress' and run the CI process. When the CI finishes, you'll # to 'in_progress' and run the CI process. When the CI finishes, you'll
# update the check run status to 'completed' and add the CI results. # update the check run status to 'completed' and add the CI results.
# Octokit doesn't yet support the Checks API, but it does provide generic @installation_client.update_check_run(
# HTTP methods you can use: @payload['repository']['full_name'],
# /rest/reference/checks#update-a-check-run @payload['check_run']['id'],
updated_check_run = @installation_client.patch( status: 'in_progress',
"repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", accept: 'application/vnd.github.v3+json'
{
accept: 'application/vnd.github.v3+json',
name: 'Octo RuboCop',
status: 'in_progress',
started_at: Time.now.utc.iso8601
}
) )
# ***** RUN A CI TEST ***** # ***** RUN A CI TEST *****
# Mark the check run as complete! # Mark the check run as complete!
updated_check_run = @installation_client.patch( @installation_client.update_check_run(
"repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", @payload['repository']['full_name'],
{ @payload['check_run']['id'],
accept: 'application/vnd.github.v3+json', status: 'completed',
name: 'Octo RuboCop', conclusion: 'success',
status: 'completed', accept: 'application/vnd.github.v3+json'
conclusion: 'success',
completed_at: Time.now.utc.iso8601
}
) )
end end
``` ```
@@ -276,40 +262,30 @@ def initiate_check_run
# to 'in_progress' and run the CI process. When the CI finishes, you'll # to 'in_progress' and run the CI process. When the CI finishes, you'll
# update the check run status to 'completed' and add the CI results. # update the check run status to 'completed' and add the CI results.
# Octokit doesn't yet support the Checks API, but it does provide generic @installation_client.update_check_run(
# HTTP methods you can use: @payload['repository']['full_name'],
# /rest/reference/checks#update-a-check-run @payload['check_run']['id'],
updated_check_run = @installation_client.patch( status: 'in_progress',
"repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", accept: 'application/vnd.github.antiope-preview+json'
{
accept: 'application/vnd.github.antiope-preview+json', # This header is necessary for beta access to Checks API
name: 'Octo RuboCop',
status: 'in_progress',
started_at: Time.now.utc.iso8601
}
) )
# ***** RUN A CI TEST ***** # ***** RUN A CI TEST *****
# Mark the check run as complete! # Mark the check run as complete!
updated_check_run = @installation_client.patch( @installation_client.update_check_run(
"repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", @payload['repository']['full_name'],
{ @payload['check_run']['id'],
# This header is necessary for beta access to Checks API status: 'completed',
accept: 'application/vnd.github.antiope-preview+json', conclusion: 'success',
name: 'Octo RuboCop', accept: 'application/vnd.github.antiope-preview+json'
status: 'completed',
conclusion: 'success',
completed_at: Time.now.utc.iso8601
}
) )
end end
``` ```
{% endif %} {% endif %}
The code above calls the "[Update a check run](/rest/reference/checks#update-a-check-run)" API endpoint using the generic [`patch` HTTP method](http://octokit.github.io/octokit.rb/Octokit/Connection.html#patch-instance_method) to update the check run that you already created. The code above calls the "[Update a check run](/rest/reference/checks#update-a-check-run)" API endpoint using the [`update_check_run` Octokit method](https://rdoc.info/gems/octokit/Octokit%2FClient%2FChecks:update_check_run) to update the check run that you already created.
Here's what this code is doing. First, it updates the check run's status to `in_progress` and sets the `started_at` time to the current time. In [Part 2](#part-2-creating-the-octo-rubocop-ci-test) of this quickstart, you'll add code that kicks off a real CI test under `***** RUN A CI TEST *****`. For now, you'll leave that section as a placeholder, so the code that follows it will just simulate that the CI process succeeds and all tests pass. Finally, the code updates the status of the check run again to `completed`. Here's what this code is doing. First, it updates the check run's status to `in_progress` and implicitly sets the `started_at` time to the current time. In [Part 2](#part-2-creating-the-octo-rubocop-ci-test) of this quickstart, you'll add code that kicks off a real CI test under `***** RUN A CI TEST *****`. For now, you'll leave that section as a placeholder, so the code that follows it will just simulate that the CI process succeeds and all tests pass. Finally, the code updates the status of the check run again to `completed`.
You'll notice in the "[Update a check run](/rest/reference/checks#update-a-check-run)" docs that when you provide a status of `completed`, the `conclusion` and `completed_at` parameters are required. The `conclusion` summarizes the outcome of a check run and can be `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. You'll set the conclusion to `success`, the `completed_at` time to the current time, and the status to `completed`. You'll notice in the "[Update a check run](/rest/reference/checks#update-a-check-run)" docs that when you provide a status of `completed`, the `conclusion` and `completed_at` parameters are required. The `conclusion` summarizes the outcome of a check run and can be `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. You'll set the conclusion to `success`, the `completed_at` time to the current time, and the status to `completed`.
@@ -613,29 +589,23 @@ Now you've got all the information you need to update your check run. In the [fi
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
``` ruby ``` ruby
# Mark the check run as complete! # Mark the check run as complete!
updated_check_run = @installation_client.patch( @installation_client.update_check_run(
"repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", @payload['repository']['full_name'],
{ @payload['check_run']['id'],
accept: 'application/vnd.github.v3+json', status: 'completed',
name: 'Octo RuboCop', conclusion: 'success',
status: 'completed', accept: 'application/vnd.github.v3+json'
conclusion: 'success',
completed_at: Time.now.utc.iso8601
}
) )
``` ```
{% else %} {% else %}
``` ruby ``` ruby
# Mark the check run as complete! # Mark the check run as complete!
updated_check_run = @installation_client.patch( @installation_client.update_check_run(
"repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", @payload['repository']['full_name'],
{ @payload['check_run']['id'],
accept: 'application/vnd.github.antiope-preview+json', # This header is necessary for beta access to Checks API status: 'completed',
name: 'Octo RuboCop', conclusion: 'success',
status: 'completed', accept: 'application/vnd.github.antiope-preview+json' # This header is necessary for beta access to Checks API
conclusion: 'success',
completed_at: Time.now.utc.iso8601
}
) )
``` ```
{% endif %} {% endif %}
@@ -645,51 +615,45 @@ You'll need to update that code to use the `conclusion` variable you set based o
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
``` ruby ``` ruby
# Mark the check run as complete! And if there are warnings, share them. # Mark the check run as complete! And if there are warnings, share them.
updated_check_run = @installation_client.patch( @installation_client.update_check_run(
"repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", @payload['repository']['full_name'],
{ @payload['check_run']['id'],
accept: 'application/vnd.github.v3+json', status: 'completed',
name: 'Octo RuboCop', conclusion: conclusion,
status: 'completed', output: {
conclusion: conclusion, title: 'Octo RuboCop',
completed_at: Time.now.utc.iso8601, summary: summary,
output: { text: text,
title: 'Octo RuboCop', annotations: annotations
summary: summary, },
text: text, actions: [{
annotations: annotations label: 'Fix this',
}, description: 'Automatically fix all linter notices.',
actions: [{ identifier: 'fix_rubocop_notices'
label: 'Fix this', }],
description: 'Automatically fix all linter notices.', accept: 'application/vnd.github.v3+json'
identifier: 'fix_rubocop_notices'
}]
}
) )
``` ```
{% else %} {% else %}
``` ruby ``` ruby
# Mark the check run as complete! And if there are warnings, share them. # Mark the check run as complete! And if there are warnings, share them.
updated_check_run = @installation_client.patch( @installation_client.update_check_run(
"repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", @payload['repository']['full_name'],
{ @payload['check_run']['id'],
accept: 'application/vnd.github.antiope-preview+json', status: 'completed',
name: 'Octo RuboCop', conclusion: conclusion,
status: 'completed', output: {
conclusion: conclusion, title: 'Octo RuboCop',
completed_at: Time.now.utc.iso8601, summary: summary,
output: { text: text,
title: 'Octo RuboCop', annotations: annotations
summary: summary, },
text: text, actions: [{
annotations: annotations label: 'Fix this',
}, description: 'Automatically fix all linter notices.',
actions: [{ identifier: 'fix_rubocop_notices'
label: 'Fix this', }],
description: 'Automatically fix all linter notices.', accept: 'application/vnd.github.antiope-preview+json'
identifier: 'fix_rubocop_notices'
}]
}
) )
``` ```
{% endif %} {% endif %}

View File

@@ -88,6 +88,12 @@ We strongly recommend you implement signature validation in your secret alert se
{% endnote %} {% endnote %}
Assuming you receive the following message, the code snippets below demonstrate how you could perform signature validation. Assuming you receive the following message, the code snippets below demonstrate how you could perform signature validation.
The code also assumes you've set an environment variable called `GITHUB_PRODUCTION_TOKEN` with a generated PAT (https://github.com/settings/tokens). The token does not need any permissions set.
**Sample message sent to verify endpoint**
```http
POST / HTTP/1.1
Host: HOST
Accept: */* Accept: */*
content-type: application/json content-type: application/json
GITHUB-PUBLIC-KEY-IDENTIFIER: 90a421169f0a406205f1563a953312f0be898d3c7b6c06b681aa86a874555f4a GITHUB-PUBLIC-KEY-IDENTIFIER: 90a421169f0a406205f1563a953312f0be898d3c7b6c06b681aa86a874555f4a
@@ -358,4 +364,3 @@ A few important points:
**Note:** Our request timeout is set to be higher (that is, 30 seconds) for partners who provide data about false positives. If you require a timeout higher than 30 seconds, email us at <a href="mailto:secret-scanning@github.com">secret-scanning@github.com</a>. **Note:** Our request timeout is set to be higher (that is, 30 seconds) for partners who provide data about false positives. If you require a timeout higher than 30 seconds, email us at <a href="mailto:secret-scanning@github.com">secret-scanning@github.com</a>.
{% endnote %} {% endnote %}

View File

@@ -1200,7 +1200,7 @@ Key | Type | Description
{% data reusables.webhooks.sponsorship_short_desc %} {% data reusables.webhooks.sponsorship_short_desc %}
You can only create a sponsorship webhook on {% data variables.product.prodname_dotcom %}. For more information, see "[Configuring webhooks for events in your sponsored account](/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)". You can only create a sponsorship webhook on {% data variables.product.prodname_dotcom %}. For more information, see "[Configuring webhooks for events in your sponsored account](/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)".
#### Availability #### Availability

View File

@@ -12,7 +12,7 @@ topics:
### About FUNDING files ### 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: 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 %} {% data reusables.files.propose_new_file %}
### Further reading ### 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 %} - "[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 %}

View File

@@ -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. 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 ```shell
$ sudo apt-get update
$ sudo apt-get install xclip $ 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`) # Downloads and installs xclip. If you don't have `apt-get`, you might need to use another installer (like `yum`)

View File

@@ -91,7 +91,7 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav
$ touch ~/.ssh/config $ 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 * Host *

View File

@@ -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. | [`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). | [`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" %} | [`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" %} | [`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 %} | [`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. | [`user`](#user-category-actions) | Contains all activities related to your account.
@@ -193,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)") | `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)") | `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_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_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](/articles/managing-your-sponsorship)") | `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)") | `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_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](/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](/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_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_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_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](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your 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](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") | `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](/articles/contacting-your-sponsors)") | `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](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your 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](/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](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
{% endif %} {% endif %}
{% if currentVersion == "free-pro-team@latest" %} {% if currentVersion == "free-pro-team@latest" %}

View File

@@ -11,7 +11,7 @@ topics:
{% tip %} {% 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 %} {% endtip %}

View File

@@ -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. 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 dont have the proper permissions, the URL will return a 404 error page. If you create an invalid URL using query parameters, or if you dont 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 ### Supported query parameters

View File

@@ -17,5 +17,5 @@ topics:
### Further reading ### Further reading
- "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" - "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)"
- "[Sponsoring open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)" - "[Sponsoring open source contributors](/sponsors/sponsoring-open-source-contributors)"

View File

@@ -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 ### 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" %} {% 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 ### 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 | | {% data variables.product.prodname_dotcom %} Repository | Version | Tag |
|---|---| |---|---|---|
| [torvalds/linux](https://github.com/torvalds/linux) | 3.4 | | [torvalds/linux](https://github.com/torvalds/linux) | 3.4 | [v3.4](https://github.com/torvalds/linux/releases/tag/v3.4) |
| [nasa/fprime](https://github.com/nasa/fprime) | 1.3 | | [python/cpython](https://github.com/python/cpython) | 3.9.2 | [v3.9.2](https://github.com/python/cpython/releases/tag/v3.9.2) |
| [python/cpython](https://github.com/python/cpython) | 3.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/boto3](https://github.com/boto/boto3) | 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) |
| [boto/botocore](https://github.com/boto/botocore) | 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) |
| [certifi/python-certifi](https://github.com/certifi/python-certifi) | 2020.12.5 | | [chardet/chardet](https://github.com/chardet/chardet) | 4.0.0 | [4.0.0](https://github.com/chardet/chardet/releases/tag/4.0.0) |
| [chardet/chardet](https://github.com/chardet/chardet) | 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) |
| [matplotlib/cycler](https://github.com/matplotlib/cycler) | 0.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) |
| [elastic/elasticsearch-py](https://github.com/elastic/elasticsearch-py) | 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) |
| [ianare/exif-py](https://github.com/ianare/exif-py) | 2.3.2 | | [kjd/idna](https://github.com/kjd/idna) | 2.10 | [v2.10](https://github.com/kjd/idna/releases/tag/v2.10) |
| [kjd/idna](https://github.com/kjd/idna) | 2.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) |
| [jmespath/jmespath.py](https://github.com/jmespath/jmespath.py) | 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) |
| [nucleic/kiwi](https://github.com/nucleic/kiwi) | 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) |
| [matplotlib/matplotlib](https://github.com/matplotlib/matplotlib) | 3.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) |
| [numpy/numpy](https://github.com/numpy/numpy) | 1.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) |
| [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 | [8.1.0](https://github.com/python-pillow/Pillow/releases/tag/8.1.0) |
| [python-pillow/Pillow](https://github.com/python-pillow/Pillow) | 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) |
| [pycurl/pycurl](https://github.com/pycurl/pycurl) | 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) |
| [pyparsing/pyparsing](https://github.com/pyparsing/pyparsing) | 2.4.7 | | [pyserial/pyserial](https://github.com/pyserial/pyserial) | 3.5 | [v3.5](https://github.com/pyserial/pyserial/releases/tag/v3.5) |
| [pyserial/pyserial](https://github.com/pyserial/pyserial) | 3.5 | | [dateutil/dateutil](https://github.com/dateutil/dateutil) | 2.8.1 | [2.8.1](https://github.com/dateutil/dateutil/releases/tag/2.8.1) |
| [dateutil/dateutil](https://github.com/dateutil/dateutil) | 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) |
| [yaml/pyyaml](https://github.com/yaml/pyyaml) | 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) |
| [psf/requests](https://github.com/psf/requests) | 2.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) |
| [boto/s3transfer](https://github.com/boto/s3transfer) | 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) |
| [enthought/scimath](https://github.com/enthought/scimath) | 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) |
| [scipy/scipy](https://github.com/scipy/scipy) | 1.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) |
| [benjaminp/six](https://github.com/benjaminp/six) | 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) |
| [enthought/traits](https://github.com/enthought/traits) | 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) |
| [urllib3/urllib3](https://github.com/urllib3/urllib3) | 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) |
| [python-attrs/attrs](https://github.com/python-attrs/attrs) | 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) |
| [CheetahTemplate3/cheetah3](https://github.com/CheetahTemplate3/cheetah3/) | 3.2.4 | | [pallets/click](https://github.com/pallets/click) | 7.0 | [7.0](https://github.com/pallets/click/releases/tag/7.0) |
| [pallets/click](https://github.com/pallets/click) | 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) |
| [pallets/flask](https://github.com/pallets/flask) | 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) |
| [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 | [v1.0.0](https://github.com/pytest-dev/iniconfig/releases/tag/v1.0.0) |
| [pytest-dev/iniconfig](https://github.com/pytest-dev/iniconfig) | 1.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/itsdangerous](https://github.com/pallets/itsdangerous) | 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) |
| [pallets/jinja](https://github.com/pallets/jinja) | 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) |
| [lxml/lxml](https://github.com/lxml/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) |
| [Python-Markdown/markdown](https://github.com/Python-Markdown/markdown) | 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) |
| [pallets/markupsafe](https://github.com/pallets/markupsafe) | 1.1.1 | | [pypa/packaging](https://github.com/pypa/packaging) | 19.2 | [19.2](https://github.com/pypa/packaging/releases/tag/19.2) |
| [pypa/packaging](https://github.com/pypa/packaging) | 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) |
| [pexpect/pexpect](https://github.com/pexpect/pexpect) | 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) |
| [pytest-dev/pluggy](https://github.com/pytest-dev/pluggy) | 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) |
| [pexpect/ptyprocess](https://github.com/pexpect/ptyprocess) | 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) |
| [pytest-dev/py](https://github.com/pytest-dev/py) | 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) |
| [pyparsing/pyparsing](https://github.com/pyparsing/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) |
| [pytest-dev/pytest](https://github.com/pytest-dev/pytest) | 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) |
| [stub42/pytz](https://github.com/stub42/pytz) | 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) |
| [uiri/toml](https://github.com/uiri/toml) | 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) |
| [pallets/werkzeug](https://github.com/pallets/werkzeug) | 0.16.0 | | [dmnfarrell/tkintertable](https://github.com/dmnfarrell/tkintertable) | 1.2 | [v1.2](https://github.com/dmnfarrell/tkintertable/releases/tag/v1.2) |
| [dmnfarrell/tkintertable](https://github.com/dmnfarrell/tkintertable) | 1.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) |
| [wxWidgets/wxPython-Classic](https://github.com/wxWidgets/wxPython-Classic) | 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) |
| [opencv/opencv](https://github.com/opencv/opencv) | 4.5.1 | | [nucleic/cppy](https://github.com/nucleic/cppy) | 1.1.0 | [1.1.0](https://github.com/nucleic/cppy/releases/tag/1.1.0) |
| [curl/curl](https://github.com/curl/curl) | 7.19.0 | | [opencv/opencv](https://github.com/opencv/opencv) | 4.5.1 | [4.5.1](https://github.com/opencv/opencv/releases/tag/4.5.1) |
| [madler/zlib](https://github.com/madler/zlib) | 1.2.11 | | [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) |
| [apache/lucene](https://github.com/apache/lucene) | 7.7.3 | | [madler/zlib](https://github.com/madler/zlib) | 1.2.11 | [v1.2.11](https://github.com/madler/zlib/releases/tag/v1.2.11) |
| [yaml/libyaml](https://github.com/yaml/libyaml) | 0.2.5 | | [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) |
| [elastic/elasticsearch](https://github.com/elastic/elasticsearch) | 6.8.1 | | [yaml/libyaml](https://github.com/yaml/libyaml) | 0.2.5 | [0.2.5](https://github.com/yaml/libyaml/releases/tag/0.2.5) |
| [nucleic/cppy](https://github.com/nucleic/cppy) | 1.1.0 | | [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 ### Further reading

View File

@@ -64,7 +64,7 @@ We require some basic information at the time of account creation. When you crea
##### Payment information ##### 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 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 ##### 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. 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 ##### 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. 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. 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 ##### 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. 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 #### 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. 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 #### 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 - security purposes
- to assist the repository owner with a support matter - to assist the repository owner with a support matter
- to maintain the integrity of the Service - to maintain the integrity of the Service
- to comply with our legal obligations - to comply with our legal obligations
- if we have reason to believe the contents are in violation of the law, or - if we have reason to believe the contents are in violation of the law, or
- with your consent. - 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). 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 #### 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 devices ability to accept these cookies, you will not be able to log in or use our service. 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 devices 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 #### DNT
@@ -321,7 +321,7 @@ In the unlikely event that a dispute arises between you and GitHub regarding our
### Changes to our Privacy Statement ### 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 ### License

View File

@@ -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 %}

View File

@@ -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
---

View File

@@ -25,6 +25,7 @@ children:
- graphql - graphql
- insights - insights
- discussions - discussions
- sponsors
- communities - communities
- pages - pages
- education - education
@@ -52,4 +53,3 @@ externalProducts:
href: 'https://codeql.github.com/docs' href: 'https://codeql.github.com/docs'
external: true external: true
--- ---

View File

@@ -144,9 +144,9 @@ For example, you can make a GraphQL request to see all the new organization memb
#### Using the REST API #### Using the REST API
{% note %} {% note %}
**Note:** The audit log REST API is available for users of {% data variables.product.prodname_ghe_cloud %} only. **Note:** The audit log REST API is available for users of {% data variables.product.prodname_ghe_cloud %} only.
{% endnote %} {% endnote %}
@@ -643,19 +643,19 @@ For more information, see "[Managing the publication of {% data variables.produc
| `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)") | `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)") | `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_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_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 account (see "[Managing your sponsorship](/articles/managing-your-sponsorship)") | `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored account (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)") | `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") | `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)")
| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") | `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)")
| `sponsored_developer_disable` | Triggered when your {% data variables.product.prodname_sponsors %} account is disabled | `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_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 organization profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors)") | `sponsored_developer_profile_update` | Triggered when you edit your sponsored organization 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 organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") | `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)")
| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") | `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](/articles/contacting-your-sponsors)") | `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 organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") | `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)")
| `waitlist_join` | Triggered when you join the waitlist to become a sponsored organization (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") | `waitlist_join` | Triggered when you join the waitlist to become a sponsored organization (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)")
{% endif %} {% endif %}
#### `team` category actions #### `team` category actions

View File

@@ -11,11 +11,11 @@ topics:
- teams - teams
--- ---
{% data reusables.sponsors.org-sponsors-release-phase %} {% data reusables.sponsors.org-sponsors-release-phase %}
The developers and organizations that your organization sponsors can send you updates about their work. You can manage the email address that receives these updates. The developers and organizations that your organization sponsors can send you updates about their work. You can manage the email address that receives these updates.
You can also disable updates from accounts your organization sponsors. For more information, see "[Managing your sponsorship](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship#managing-email-updates-for-your-sponsorship)." You can also disable updates from accounts your organization sponsors. For more information, see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship#managing-email-updates-for-your-sponsorship)."
{% data reusables.profile.access_profile %} {% data reusables.profile.access_profile %}
{% data reusables.profile.access_org %} {% data reusables.profile.access_org %}
@@ -27,4 +27,4 @@ You can also disable updates from accounts your organization sponsors. For more
### Further reading ### Further reading
- "[Supporting the open source community with {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors)" - "[{% data variables.product.prodname_sponsors %}](/sponsors)"

View File

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

View File

@@ -47,7 +47,7 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl
![Save custom domain button](/assets/images/help/pages/save-custom-subdomain.png) ![Save custom domain button](/assets/images/help/pages/save-custom-subdomain.png)
5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `<user>.github.io`. If you want to use the subdomain `www.anotherexample.com` for your organization site, create a `CNAME` record that points `www.anotherexample.com` to `<organization>.github.io`. The `CNAME` record should always point to `<user>.github.io` or `<organization>.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} 5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `<user>.github.io`. If you want to use the subdomain `www.anotherexample.com` for your organization site, create a `CNAME` record that points `www.anotherexample.com` to `<organization>.github.io`. The `CNAME` record should always point to `<user>.github.io` or `<organization>.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %}
{% indented_data_reference site.data.reusables.pages.wildcard-dns-warning spaces=3 %} {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %}
{% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.command_line.open_the_multi_os_terminal %}
6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your subdomain. 6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your subdomain.
```shell ```shell
@@ -81,7 +81,7 @@ To set up an apex domain, such as `example.com`, you must configure a _CNAME_ fi
185.199.111.153 185.199.111.153
``` ```
{% indented_data_reference site.data.reusables.pages.wildcard-dns-warning spaces=3 %} {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %}
{% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.command_line.open_the_multi_os_terminal %}
6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _EXAMPLE.COM_ with your apex domain. Confirm that the results match the IP addresses for {% data variables.product.prodname_pages %} above. 6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _EXAMPLE.COM_ with your apex domain. Confirm that the results match the IP addresses for {% data variables.product.prodname_pages %} above.
```shell ```shell

View File

@@ -3,21 +3,24 @@ 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 %}.' 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: redirect_from:
- /articles/about-github-sponsors - /articles/about-github-sponsors
- /github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors
versions: versions:
free-pro-team: '*' free-pro-team: '*'
type: 'overview'
topics: topics:
- sponsors - 'Open Source'
- 'Fundamentals'
--- ---
### About {% data variables.product.prodname_sponsors %} ### About {% data variables.product.prodname_sponsors %}
{% data reusables.sponsors.sponsorship-details %} {% 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.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-developer %} For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" and "[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)."
{% 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)." {% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-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)." 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)."
@@ -31,7 +34,9 @@ When you become a sponsored developer or sponsored organization, additional term
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 %}. 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)." 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 %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)."
Donations between sponsored developers will not be matched.
{% data reusables.sponsors.legal-additional-terms %} {% data reusables.sponsors.legal-additional-terms %}
@@ -40,6 +45,6 @@ To be eligible for the {% data variables.product.prodname_matching_fund %}, you
{% data reusables.sponsors.feedback %} {% data reusables.sponsors.feedback %}
### Further reading ### Further reading
- "[Sponsoring open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)" - "[Sponsoring open source contributors](/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)" - "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/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 %} - "[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 %}

View File

@@ -1,10 +1,10 @@
--- ---
title: Overview title: Getting started with GitHub Sponsors
intro: 'Learn about {% data variables.product.prodname_sponsors %} and how you can get involved as a sponsor or open source contributor.' intro: 'Learn about {% data variables.product.prodname_sponsors %} and how you can get involved as a sponsor or open source contributor.'
mapTopic: true
versions: versions:
free-pro-team: '*' free-pro-team: '*'
topics:
- sponsors
--- ---
{% link_with_intro /about-github-sponsors %}
{% link_with_intro /quickstart-for-finding-contributors-to-sponsor %}

View File

@@ -0,0 +1,51 @@
---
title: Quickstart for finding contributors to sponsor
intro: 'Learn some best practices for finding open source contributors to sponsor.'
versions:
free-pro-team: '*'
type: 'quick_start'
topics:
- 'Open Source'
---
### Explore projects you depend on
As you consider where to find open source contributors to sponsor, consider starting at https://github.com/sponsors/community.
If you're logged in, the sponsors results will start with public dependencies that your repositories depend on.
![The Babel open source project with highlighted text that says "4 of your repositories depend on this"](/assets/images/help/sponsors/example-of-open-source-project-dependency.png)
You can also toggle which of your accounts to view results for and further filter or search.
![Search options on sponsors community search page](/assets/images/help/sponsors/sponsors-search-options.png)
### Explore whom others sponsor
You can see whom a user or organization sponsors on their {% data variables.product.prodname_dotcom %} profile page.
### Consider how you benefit from different contributions
Consider whether you benefit from the work of open source contributions, such as:
- Documentation
- Design
- Translation
- Newsletters
- Code reviews
- Tutorials
- Mentoring
- Triaging issues and helping with project management
- Answering questions
- Event planning
For more information on different types of open source contributions, see the [Open source guide](https://opensource.guide/how-to-contribute/#you-dont-have-to-contribute-code).
You can check if contributors you've benefited from have {% data variables.product.prodname_sponsors %} profiles by using search at https://github.com/sponsors/community.
### Search for a specific project or contributor
At https://github.com/sponsors/community, you can search by ecosystem, most used, recently updated, and more. You can filter search results for your personal user account or for organizations that you're a member of.
### Next steps
For more information on starting your sponsorship, see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)."

View File

@@ -0,0 +1,17 @@
---
title: GitHub Sponsors guides
shortTitle: Guides
intro: 'Learn how to make the most of {% data variables.product.prodname_sponsors %}.'
allowTitleToDifferFromFilename: true
layout: product-sublanding
versions:
free-pro-team: '*'
includeGuides:
- /sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor
- /sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization
- /sponsors/sponsoring-open-source-contributors/managing-your-sponsorship
- /sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors
- /sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account
- /sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization
- /sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account
---

35
content/sponsors/index.md Normal file
View File

@@ -0,0 +1,35 @@
---
title: GitHub Sponsors Documentation
shortTitle: GitHub Sponsors
intro: 'Invest in the open source projects you depend on, support digital infrastructure, and make open source careers possible by sponsoring open source contributors and their projects. Build a {% data variables.product.prodname_sponsors %} profile and receive compensation for your open source work.'
introLinks:
quickstart: /sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor
redirect_from:
- /categories/supporting-the-open-source-community-with-github-sponsors
- /github/supporting-the-open-source-community-with-github-sponsors
changelog:
label: 'sponsors'
featuredLinks:
guides:
- /sponsors/sponsoring-open-source-contributors/managing-your-sponsorship
- /sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization
- /sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors
guideCards:
- /sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account
- /sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization
- /sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account
popular:
- /sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor
- /sponsors/getting-started-with-github-sponsors/about-github-sponsors
- /sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors
- /sponsors/sponsoring-open-source-contributors
- /sponsors/about-github-sponsors-for-open-source-contributors
layout: product-landing
versions:
free-pro-team: '*'
---
<!--{% link_with_intro /getting-started-with-github-sponsors %}-->
<!--{% link_with_intro /sponsoring-open-source-contributors %}-->
<!--{% link_with_intro /receiving-sponsorships-through-github-sponsors%}-->
<!--{% link_with_intro /integrating-with-github-sponsors %}-->

View File

@@ -1,10 +1,15 @@
--- ---
title: Configuring webhooks for events in your sponsored account 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. intro: You can configure webhooks to alert you when you receive new sponsorships or existing sponsors make changes to their sponsorships.
redirect_from:
- /github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account
versions: versions:
free-pro-team: '*' free-pro-team: '*'
type: 'how_to'
topics: topics:
- sponsors - 'Webhooks'
- 'Events'
- 'Open Source'
--- ---
### About webhooks for events in your sponsored account ### About webhooks for events in your sponsored account

View File

@@ -0,0 +1,14 @@
---
title: Getting started with the Sponsors GraphQL API
intro: 'Using the GraphQL API, you can build custom integrations to manage or review your sponsorships.'
versions:
free-pro-team: '*'
type: 'overview'
topics:
- 'GraphQL'
- 'API'
---
To get started with the GraphQL API, see "[Introduction to GraphQL](/graphql/guides/introduction-to-graphql)."
You can find the details about the Sponsors GraphQL API in the reference docs. For more information, see "[GraphQL reference](/graphql/reference)." We recommend using the GraphQL explorer to build your GraphQL calls. For more information, see "[Using the explorer](/graphql/guides/using-the-explorer)."

View File

@@ -0,0 +1,9 @@
---
title: Integrating with GitHub Sponsors
intro: 'As an open source contributor, you can build custom tools to manage your GitHub sponsorships.'
versions:
free-pro-team: '*'
---
{% link_with_intro /configuring-webhooks-for-events-in-your-sponsored-account %}
{% link_with_intro /getting-started-with-the-sponsors-graphql-api %}

View File

@@ -6,25 +6,27 @@ redirect_from:
- /github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-sponsored-developers - /github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-sponsored-developers
versions: versions:
free-pro-team: '*' free-pro-team: '*'
type: 'overview'
topics: topics:
- sponsors - 'Open Source'
- 'Fundamentals'
--- ---
### Joining {% data variables.product.prodname_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-developer %} For more information, 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)."
{% 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)." {% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-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)." 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)." You can set a goal for your sponsorships. For more information, see "[Managing your sponsorship goal](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-goal)."
{% data reusables.sponsors.github-contact-applicants %} {% data reusables.sponsors.github-contact-applicants %}
### Sponsorship tiers ### 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)." {% data reusables.sponsors.tier-details %} For more information, 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)," "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization), and "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-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. 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.
@@ -34,7 +36,7 @@ It's best to set up a range of different sponsorship options, including monthly
{% data reusables.sponsors.payout-info %} {% 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)." For more information, see "[Managing your payouts from {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors)."
### Sharing feedback about {% data variables.product.prodname_sponsors %} ### Sharing feedback about {% data variables.product.prodname_sponsors %}

View File

@@ -3,20 +3,21 @@ title: Contacting your sponsors
intro: You can send an email to your sponsors who have opted in to receive updates about your work. intro: You can send an email to your sponsors who have opted in to receive updates about your work.
redirect_from: redirect_from:
- /articles/contacting-your-sponsors - /articles/contacting-your-sponsors
- /github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors
versions: versions:
free-pro-team: '*' free-pro-team: '*'
type: 'how_to'
topics: topics:
- sponsors - 'Open Source'
- 'Contacting sponsors'
--- ---
### About sponsorship updates ### 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)." Your sponsors can choose whether they receive email updates about your work. For more information, see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/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)." 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 ### Contacting your sponsors
{% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.navigate-to-sponsors-dashboard %}

View File

@@ -4,10 +4,13 @@ intro: You can update the information that potential sponsors see about your wor
redirect_from: redirect_from:
- /articles/editing-your-sponsored-developer-profile - /articles/editing-your-sponsored-developer-profile
- /github/supporting-the-open-source-community-with-github-sponsors/editing-your-sponsored-developer-profile - /github/supporting-the-open-source-community-with-github-sponsors/editing-your-sponsored-developer-profile
- /github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors
versions: versions:
free-pro-team: '*' free-pro-team: '*'
type: 'how_to'
topics: topics:
- sponsors - 'Sponsors profile'
- 'Open Source'
--- ---
### About sponsor profiles ### About sponsor profiles

View File

@@ -0,0 +1,22 @@
---
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.'
redirect_from:
- /articles/receiving-sponsorships-as-a-sponsored-developer
- /github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-as-a-sponsored-developer
- /github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors
versions:
free-pro-team: '*'
---
{% link_with_intro /about-github-sponsors-for-open-source-contributors %}
{% link_with_intro /setting-up-github-sponsors-for-your-user-account %}
{% link_with_intro /setting-up-github-sponsors-for-your-organization %}
{% link_with_intro /editing-your-profile-details-for-github-sponsors %}
{% link_with_intro /managing-your-sponsorship-goal %}
{% link_with_intro /managing-your-sponsorship-tiers %}
{% link_with_intro /viewing-your-sponsors-and-sponsorships %}
{% link_with_intro /managing-your-payouts-from-github-sponsors %}
{% link_with_intro /contacting-your-sponsors %}
{% link_with_intro /tax-information-for-github-sponsors %}

View File

@@ -3,15 +3,18 @@ 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.' intro: 'You can view information about past and future payouts from {% data variables.product.prodname_sponsors %} and edit your bank information.'
redirect_from: redirect_from:
- /articles/managing-your-payouts-from-github-sponsors - /articles/managing-your-payouts-from-github-sponsors
- /github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors
versions: versions:
free-pro-team: '*' free-pro-team: '*'
type: 'how_to'
topics: topics:
- sponsors - 'Sponsors payments'
- 'Open Source'
--- ---
### About payouts from {% data variables.product.prodname_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)." 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](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors#sponsorship-payouts)."
{% data reusables.sponsors.payout-info %} {% data reusables.sponsors.payout-info %}

View File

@@ -1,10 +1,15 @@
--- ---
title: Managing your sponsorship goal 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. intro: You can set a goal for your sponsored developer or sponsored organization account to help the community understand the impact of sponsoring you.
redirect_from:
- /github/supporting-the-open-source-community-with-github-sponsors/manage-your-sponsorship-goal
- /github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal
versions: versions:
free-pro-team: '*' free-pro-team: '*'
type: 'how_to'
topics: topics:
- sponsors - 'Open Source'
- 'Sponsors profile'
--- ---
### About sponsorship goals ### About sponsorship goals
@@ -13,12 +18,6 @@ You can set a funding goal for your sponsored account and share the goal with yo
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. 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 ### Setting a goal
{% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.navigate-to-sponsors-dashboard %}

View File

@@ -4,10 +4,13 @@ intro: 'You can add a new sponsorship tier, or edit or retire an existing tier.'
redirect_from: redirect_from:
- /articles/changing-your-sponsorship-tiers - /articles/changing-your-sponsorship-tiers
- /github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers - /github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers
- /github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers
versions: versions:
free-pro-team: '*' free-pro-team: '*'
type: 'how_to'
topics: topics:
- sponsors - 'Open Source'
- 'Sponsors profile'
--- ---
### About sponsorship tiers ### About sponsorship tiers

View File

@@ -4,11 +4,15 @@ intro: 'Your organization can join {% data variables.product.prodname_sponsors %
redirect_from: redirect_from:
- /articles/setting-up-github-sponsorship-for-your-organization - /articles/setting-up-github-sponsorship-for-your-organization
- /articles/receiving-sponsorships-as-a-sponsored-organization - /articles/receiving-sponsorships-as-a-sponsored-organization
- /github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization
permissions: 'Organization owners can set up {% data variables.product.prodname_sponsors %} for an organization.' permissions: 'Organization owners can set up {% data variables.product.prodname_sponsors %} for an organization.'
versions: versions:
free-pro-team: '*' free-pro-team: '*'
type: 'how_to'
topics: topics:
- sponsors - 'Organizations'
- 'Sponsors profile'
- 'Open Source'
--- ---
### Joining {% data variables.product.prodname_sponsors %} ### Joining {% data variables.product.prodname_sponsors %}
@@ -17,7 +21,7 @@ topics:
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. 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)." 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](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)."
{% data reusables.sponsors.navigate-to-github-sponsors %} {% data reusables.sponsors.navigate-to-github-sponsors %}
{% data reusables.sponsors.view-eligible-accounts %} {% data reusables.sponsors.view-eligible-accounts %}
@@ -48,7 +52,6 @@ To join {% data variables.product.prodname_sponsors %} as an individual contribu
{% data reusables.sponsors.tier-price-description %} {% data reusables.sponsors.tier-price-description %}
{% data reusables.sponsors.save-tier-draft %} {% data reusables.sponsors.save-tier-draft %}
{% data reusables.sponsors.review-and-publish-tier %} {% data reusables.sponsors.review-and-publish-tier %}
{% data reusables.sponsors.enable-custom-amounts %}
{% data reusables.sponsors.add-more-tiers %} {% data reusables.sponsors.add-more-tiers %}
### Submitting your bank information ### Submitting your bank information
@@ -84,5 +87,5 @@ Before your organization can become a sponsored organization, you must enable 2F
{% data reusables.sponsors.github-review-app %} {% data reusables.sponsors.github-review-app %}
### Further reading ### Further reading
- "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" - "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/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)" - "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors)"

View File

@@ -4,17 +4,20 @@ intro: 'You can become a sponsored developer by joining {% data variables.produc
redirect_from: redirect_from:
- /articles/becoming-a-sponsored-developer - /articles/becoming-a-sponsored-developer
- /github/supporting-the-open-source-community-with-github-sponsors/becoming-a-sponsored-developer - /github/supporting-the-open-source-community-with-github-sponsors/becoming-a-sponsored-developer
- /github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account
versions: versions:
free-pro-team: '*' free-pro-team: '*'
type: 'how_to'
topics: topics:
- sponsors - 'User account'
- 'Sponsors profile'
--- ---
### Joining {% data variables.product.prodname_sponsors %} ### Joining {% data variables.product.prodname_sponsors %}
{% data reusables.sponsors.you-can-be-a-sponsored-developer %} {% data reusables.sponsors.stripe-supported-regions %} {% 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)." To join {% data variables.product.prodname_sponsors %} as an organization, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)."
{% data reusables.sponsors.navigate-to-github-sponsors %} {% 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. 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.
@@ -48,7 +51,6 @@ After {% data variables.product.prodname_dotcom %} reviews your application, you
{% data reusables.sponsors.tier-price-description %} {% data reusables.sponsors.tier-price-description %}
{% data reusables.sponsors.save-tier-draft %} {% data reusables.sponsors.save-tier-draft %}
{% data reusables.sponsors.review-and-publish-tier %} {% data reusables.sponsors.review-and-publish-tier %}
{% data reusables.sponsors.enable-custom-amounts %}
{% data reusables.sponsors.add-more-tiers %} {% data reusables.sponsors.add-more-tiers %}
### Submitting your bank information ### Submitting your bank information

View File

@@ -6,13 +6,15 @@ redirect_from:
- /github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-sponsored-developers - /github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-sponsored-developers
versions: versions:
free-pro-team: '*' free-pro-team: '*'
type: 'overview'
topics: topics:
- sponsors - 'Open Source'
- 'Sponsors payments'
--- ---
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, 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](/sponsors/receiving-sponsorships-through-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](/sponsors/receiving-sponsorships-through-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. If you are a taxpayer in the United States and earn more than $600 USD 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 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.
@@ -20,4 +22,4 @@ If you are a taxpayer in the United States and earn more than $600 in a tax year
### Further reading ### Further reading
- [Viewing your sponsors and sponsorships](/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships) - [Viewing your sponsors and sponsorships](/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships)

View File

@@ -3,15 +3,18 @@ title: Viewing your sponsors and sponsorships
intro: You can view and export detailed information and analytics about your sponsors and sponsorships. intro: You can view and export detailed information and analytics about your sponsors and sponsorships.
redirect_from: redirect_from:
- /articles/viewing-your-sponsors-and-sponsorships - /articles/viewing-your-sponsors-and-sponsorships
- /github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships
versions: versions:
free-pro-team: '*' free-pro-team: '*'
type: 'how_to'
topics: topics:
- sponsors - 'Open Source'
- 'Analytics'
--- ---
### About sponsors and sponsorships ### About sponsors and sponsorships
You can view analytics on your current and past sponsorships, the payments you've received from sponsors, and events, such as cancellations and sponsor tier changes for your sponsorships. You can also view activity such as new sponsorships, changes to sponsorships, and canceled sponsorships. You can filter the list of activities by date. You can also export sponsorship data for the account you're viewing in CSV or JSON format. You 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 ### Viewing your sponsors and sponsorships

View File

@@ -1,15 +1,20 @@
--- ---
title: Attributing sponsorships to your organization title: Attributing sponsorships to your organization
intro: You can attribute the sponsorships paid by one of your organizations to another organization. intro: You can attribute the sponsorships paid by one of your organizations to another organization.
redirect_from:
- /github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization
versions: versions:
free-pro-team: '*' free-pro-team: '*'
permissions: People who are organization owners of both organizations can attribute one organization's sponsorships to another organization. permissions: People who are organization owners of both organizations can attribute one organization's sponsorships to another organization.
type: 'how_to'
topics: topics:
- sponsors - 'Open Source'
- 'Organizations'
- 'Sponsors profile'
--- ---
1. Navigate to the organization whose sponsorships you want to attribute to another organization. 1. Navigate to the organization whose sponsorships you want to attribute to another organization.
1. Under your organization name, click {% octicon "heart" aria-label="The heart icon" %} **Sponsoring**. 2. Under your organization name, click {% octicon "heart" aria-label="The heart icon" %} **Sponsoring**.
!["Sponsoring" tab](/assets/images/help/sponsors/sponsoring-tab.png) !["Sponsoring" tab](/assets/images/help/sponsors/sponsoring-tab.png)
1. In the upper-right corner, click {% octicon "gear" aria-label="The gear icon" %} **Settings**. 1. In the upper-right corner, click {% octicon "gear" aria-label="The gear icon" %} **Settings**.
!["Settings" button](/assets/images/help/sponsors/sponsoring-settings-button.png) !["Settings" button](/assets/images/help/sponsors/sponsoring-settings-button.png)

View File

@@ -1,13 +1,14 @@
--- ---
title: Sponsoring open source contributors 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 %}.' 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: redirect_from:
- /articles/sponsoring-open-source-developers - /articles/sponsoring-open-source-developers
- /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-developers - /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-developers
- /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors
versions: versions:
free-pro-team: '*' free-pro-team: '*'
topics:
- sponsors
--- ---
{% link_with_intro /sponsoring-an-open-source-contributor %}
{% link_with_intro /managing-your-sponsorship %}
{% link_with_intro /attributing-sponsorships-to-your-organization %}

View File

@@ -3,13 +3,17 @@ title: Managing your sponsorship
intro: You can manage who can see your sponsorship and whether you receive email updates from the sponsored account. intro: You can manage who can see your sponsorship and whether you receive email updates from the sponsored account.
redirect_from: redirect_from:
- /articles/managing-your-sponsorship - /articles/managing-your-sponsorship
- /github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship
versions: versions:
free-pro-team: '*' free-pro-team: '*'
type: 'how_to'
topics: topics:
- sponsors - 'Contacting sponsors'
- 'Privacy'
- 'Open Source'
--- ---
{% data reusables.sponsors.org-sponsors-release-phase %} {% data reusables.sponsors.org-sponsors-release-phase %}
### Managing the privacy setting for your sponsorship ### Managing the privacy setting for your sponsorship
@@ -23,7 +27,7 @@ topics:
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. 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.manage-updates-for-orgs %}
{% data reusables.sponsors.navigate-to-sponsored-account %} {% data reusables.sponsors.navigate-to-sponsored-account %}
{% data reusables.sponsors.sponsorship-dashboard %} {% data reusables.sponsors.sponsorship-dashboard %}

View File

@@ -1,22 +1,25 @@
--- ---
title: Sponsoring an open source contributor 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.' intro: 'You can make a monthly recurring payment to a developer or organization who designs, creates, or maintains open source projects you depend on.'
redirect_from: redirect_from:
- /articles/sponsoring-a-developer - /articles/sponsoring-a-developer
- /articles/sponsoring-an-open-source-contributor - /articles/sponsoring-an-open-source-contributor
- /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-a-developer - /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-a-developer
- /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor
versions: versions:
free-pro-team: '*' 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. 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.
type: 'how_to'
topics: topics:
- sponsors - 'Open Source'
- 'Sponsors payments'
--- ---
{% data reusables.sponsors.org-sponsors-release-phase %} {% data reusables.sponsors.org-sponsors-release-phase %}
### About sponsorships ### About sponsorships
{% data reusables.sponsors.sponsorship-details %} {% 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. 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 - Sustaining specific libraries that your organization's work depends on
@@ -24,17 +27,17 @@ You can sponsor an account on behalf of your user account to invest in projects
- Developing brand awareness as an organization that values open source - Developing brand awareness as an organization that values open source
- Thanking open source developers for building libraries that complement the product your organization offers - 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). You can use a credit card 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)." {% 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. When you sponsor an account using a credit card, the change will become effective immediately. {% data reusables.sponsors.prorated-sponsorship %}
{% data reusables.sponsors.manage-updates-for-orgs %} {% 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 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)." 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](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)."
{% data reusables.sponsors.sponsorships-not-tax-deductible %} {% data reusables.sponsors.sponsorships-not-tax-deductible %}
@@ -56,7 +59,6 @@ Before you can sponsor an account, you must have a verified email address. For m
![Sponsor button](/assets/images/help/sponsors/sponsor-org-button.png) ![Sponsor button](/assets/images/help/sponsors/sponsor-org-button.png)
1. Optionally, on the right side of the page, to sponsor the account on behalf of your organization, use the **Sponsor as** drop-down menu, and click the organization. 1. Optionally, on the right side of the page, to sponsor the account on behalf of your organization, use the **Sponsor as** drop-down menu, and click the organization.
![Drop-down menu to choose the account you'll sponsor as](/assets/images/help/sponsors/sponsor-as-drop-down-menu.png) ![Drop-down menu to choose the account you'll sponsor as](/assets/images/help/sponsors/sponsor-as-drop-down-menu.png)
{% data reusables.sponsors.review-tiers-to-select %}
{% data reusables.sponsors.select-a-tier %} {% data reusables.sponsors.select-a-tier %}
{% data reusables.sponsors.pay-prorated-amount %} {% data reusables.sponsors.pay-prorated-amount %}
{% data reusables.sponsors.select-sponsorship-billing %} {% data reusables.sponsors.select-sponsorship-billing %}

View File

@@ -15,35 +15,47 @@ module.exports = [
'Action development', 'Action development',
'Amazon ECS', 'Amazon ECS',
'Ant', 'Ant',
'Analytics',
'API',
'Azure App Service', 'Azure App Service',
'Azure Pipelines', 'Azure Pipelines',
'CD', 'CD',
'CI', 'CI',
'CircleCI', 'CircleCI',
'Contacting sponsors',
'Containers', 'Containers',
'Docker', 'Docker',
'Events',
'Fundamentals', 'Fundamentals',
'GitLab', 'GitLab',
'Google Kubernetes Engine', 'Google Kubernetes Engine',
'Gradle', 'Gradle',
'GraphQL',
'Java', 'Java',
'JavaScript', 'JavaScript',
'Jenkins', 'Jenkins',
'Maven', 'Maven',
'Migration', 'Migration',
'Node', 'Node',
'Open Source',
'Organizations',
'Packaging', 'Packaging',
'Powershell', 'Powershell',
'Privacy',
'Project management', 'Project management',
'Publishing', 'Publishing',
'Python', 'Python',
'Ruby', 'Ruby',
'Security', 'Security',
'Sponsors payments',
'Sponsors profile',
'Travis CI', 'Travis CI',
'User account',
'Webhooks',
'Workflows', 'Workflows',
'access management', 'access management',
'accounts', 'accounts',
'api', 'api', // replace this with API
'billing', 'billing',
'cli', 'cli',
'codespaces', 'codespaces',
@@ -52,7 +64,7 @@ module.exports = [
'device verification', 'device verification',
'early access', 'early access',
'enterprise', 'enterprise',
'events', 'events', // replace this with Events
'github', 'github',
'github apps', 'github apps',
'github search', 'github search',
@@ -64,8 +76,8 @@ module.exports = [
'mobile', 'mobile',
'notifications', 'notifications',
'oauth apps', 'oauth apps',
'open source', 'open source', // replace this with Open Source
'organizations', 'organizations', // replace this with Organization
'pages', 'pages',
'permissions', 'permissions',
'policy', 'policy',
@@ -75,11 +87,10 @@ module.exports = [
'pull requests', 'pull requests',
'repositories', 'repositories',
'security', 'security',
'sponsors',
'ssh', 'ssh',
'sso', 'sso',
'teams', 'teams',
'usernames', 'usernames',
'webhooks', 'webhooks', // replace this with Webhooks
'Xcode' 'Xcode'
] ]

View File

@@ -10,6 +10,10 @@ When you create a pull request from a forked repository to the base repository,
Workflows don't run on forked repositories by default. You must enable GitHub Actions in the **Actions** tab of the forked repository. Workflows don't run on forked repositories by default. You must enable GitHub Actions in the **Actions** tab of the forked repository.
{% if currentVersion == "free-pro-team@latest"%}
When a first-time contributor submits a pull request to a public repository, a maintainer with write access must approve running workflows on the pull request. For more information, see "[Approving workflow runs from public forks](/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."
{% endif %}
{% data reusables.actions.forked-secrets %} The permissions for the `GITHUB_TOKEN` in forked repositories is read-only. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." {% data reusables.actions.forked-secrets %} The permissions for the `GITHUB_TOKEN` in forked repositories is read-only. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)."
{% note %} {% note %}

View File

@@ -1 +1 @@
{% if currentVersion == "github-ae@latest" %}Auto-merge for pull requests is available in internal and private repositories with {% data variables.product.prodname_ghe_managed %}, {% else %}Auto-merge for pull requests is available {% endif %} in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %} {% if currentVersion == "github-ae@latest" %}Auto-merge for pull requests is available in internal and private repositories with {% data variables.product.prodname_ghe_managed %}, {% else %}Auto-merge for pull requests is available {% endif %} in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% if enterpriseServerVersions contains "enterprise-server@3.1" %}{% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}{% else %}and {% data variables.product.prodname_ghe_cloud %}{% endif %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %}

View File

@@ -6,7 +6,7 @@
**Warning** **Warning**
{% indented_data_reference site.data.reusables.github-actions.self-hosted-runner-security spaces=3 %} {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %}
For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)."

View File

@@ -1,6 +1,7 @@
| Virtual environment | YAML workflow label | | Virtual environment | YAML workflow label |
| --------------------|---------------------| | --------------------|---------------------|
| Windows Server 2019 | `windows-latest` or `windows-2019` | | Windows Server 2019 | `windows-latest` or `windows-2019` |
| Windows Server 2016 | `windows-2016` |
| Ubuntu 20.04 | `ubuntu-latest` or `ubuntu-20.04` | | Ubuntu 20.04 | `ubuntu-latest` or `ubuntu-20.04` |
| Ubuntu 18.04 | `ubuntu-18.04` | | Ubuntu 18.04 | `ubuntu-18.04` |
| Ubuntu 16.04 | `ubuntu-16.04` | | Ubuntu 16.04 | `ubuntu-16.04` |

View File

@@ -6,6 +6,6 @@ This example triggers the workflow every day at 5:30 and 17:30 UTC:
on: on:
schedule: schedule:
# * is a special character in YAML so you have to quote this string # * is a special character in YAML so you have to quote this string
- cron: '*/30 5,17 * * *' - cron: '30 5,17 * * *'
``` ```

View File

@@ -32,6 +32,7 @@ Dropbox | Dropbox Short Lived Access Token | dropbox_short_lived_access_token
Dynatrace | Dynatrace Access Token | dynatrace_access_token Dynatrace | Dynatrace Access Token | dynatrace_access_token
Dynatrace | Dynatrace Internal Token | dynatrace_internal_token Dynatrace | Dynatrace Internal Token | dynatrace_internal_token
Facebook | Facebook Access Token | facebook_access_token Facebook | Facebook Access Token | facebook_access_token
Fastly | Fastly API Token | fastly_api_token
Finicity | Finicity App Key | finicity_app_key Finicity | Finicity App Key | finicity_app_key
Frame.io | Frame.io JSON Web Token | frameio_jwt Frame.io | Frame.io JSON Web Token | frameio_jwt
Frame.io| Frame.io Developer Token | frameio_developer_token Frame.io| Frame.io Developer Token | frameio_developer_token
@@ -54,6 +55,7 @@ Mailchimp | Mailchimp API Key | mailchimp_api_key
Mailgun | Mailgun API Key | mailgun_api_key Mailgun | Mailgun API Key | mailgun_api_key
npm | npm Access Token | npm_access_token npm | npm Access Token | npm_access_token
NuGet | NuGet API Key | nuget_api_key NuGet | NuGet API Key | nuget_api_key
OpenAI | OpenAI API Key | openai_api_key
Palantir | Palantir JSON Web Token | palantir_jwt Palantir | Palantir JSON Web Token | palantir_jwt
Postman | Postman API Key | postman_api_key Postman | Postman API Key | postman_api_key
Proctorio | Proctorio Consumer Key | proctorio_consumer_key Proctorio | Proctorio Consumer Key | proctorio_consumer_key

View File

@@ -47,6 +47,7 @@ Mailgun | Mailgun API Key
MessageBird | MessageBird API Key MessageBird | MessageBird API Key
npm | npm Access Token npm | npm Access Token
NuGet | NuGet API Key NuGet | NuGet API Key
OpenAI | OpenAI API Key
Palantir | Palantir JSON Web Token Palantir | Palantir JSON Web Token
Plivo | Plivo Auth Token Plivo | Plivo Auth Token
Postman | Postman API Key Postman | Postman API Key

View File

@@ -1,6 +1,6 @@
Key | Type | Description Key | Type | Description
----|------|------------- ----|------|-------------
`action` |`string` | The action that was performed. This can be one of `created`, `reopened_by_user`, `closed_by_user`, `fixed`, `appeared_in_branch`, or `reopened`. `action` | `string` | The action that was performed. This can be one of `created`, `reopened_by_user`, `closed_by_user`, `fixed`, `appeared_in_branch`, or `reopened`.
`alert` |`object` | The code scanning alert involved in the event. `alert` | `object` | The code scanning alert involved in the event.
`ref` | `string` | The Git reference of the code scanning alert. When the action is `reopened_by_user ` or `closed_by_user `, the event was triggered by the `sender` and this value will be empty. `ref` | `string` | The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.
`commit_oid` | `string` | The commit SHA of the code scanning alert. When the action is `reopened_by_user ` or `closed_by_user `, the event was triggered by the `sender` and this value will be empty. `commit_oid` | `string` | The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.

View File

@@ -1 +1 @@
Activity related to a sponsorship listing. {% data reusables.webhooks.action_type_desc %} For more information, see "[About GitHub Sponsors](/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors)". Activity related to a sponsorship listing. {% data reusables.webhooks.action_type_desc %} For more information, see "[About GitHub Sponsors](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)".

View File

@@ -143,6 +143,7 @@ product_landing:
code_examples: Code examples code_examples: Code examples
search_code_examples: Search code examples search_code_examples: Search code examples
show_more: Show more show_more: Show more
explore_people_and_projects: Explore people and projects
sorry: Sorry, there is no result for sorry: Sorry, there is no result for
no_example: It looks like we don't have an example that fits your filter. no_example: It looks like we don't have an example that fits your filter.
try_another: Try another filter or add your code example. try_another: Try another filter or add your code example.
@@ -150,6 +151,7 @@ product_landing:
learn: Learn how to add a code example learn: Learn how to add a code example
communities_using_discussions: Communities using discussions communities_using_discussions: Communities using discussions
add_your_community: Add your community add_your_community: Add your community
sponsor_community: GitHub Sponsors community
product_sublanding: product_sublanding:
start: Start start: Start
start_path: Start path start_path: Start path

View File

@@ -0,0 +1,19 @@
# Images and descriptions are pulled directly from the repo
- user: chaynHQ
description: Chayn helps women experiencing abuse find the right information and support they need to take control of their lives.
- user: foosel
description: 👋 I'm Gina, and I'm mostly known for being the creator and main developer of OctoPrint 🐙.
- user: dayhaysoos
description: What's up? I'm Nick. I'm an engineer who has a new-found passion for removing friction from the e-commerce developer experience.
- user: yyx990803
description: I'm working fulltime on Vue.js, a frontend JavaScript framework for building web applications, and Vite, a modern web build tool.
- user: calebporzio
description: 🚶I left my day job in Jan 2019 to pursue open-source. Since then, I've built Laravel Livewire, AlpineJS, and a bunch of other stuff.
- user: kjaymiller
description: Hi Y'all I'm Jay! 👋 I'm a Marine Corps Veteran turned developer that's been actively coding since 2014. I'm also involved in the productivity space where I can be found helping people with automations for some of their favorite apps and tools.

View File

@@ -1,4 +1,5 @@
{ {
"FEATURE_TEST_TRUE": true, "FEATURE_TEST_TRUE": true,
"FEATURE_TEST_FALSE": false "FEATURE_TEST_FALSE": false,
"FEATURE_NEW_SITETREE": false
} }

View File

@@ -1,7 +1,10 @@
{% assign maxArticles = 9 %} {% assign maxArticles = 9 %}
<div class="container-xl px-3 px-md-6 pt-3 pb-2"> <div class="container-xl px-3 px-md-6 pt-3 pb-2">
<!-- When learning tracks aren't present, only guides exist and this heading duplicates the article's title -->
{% if page.learningTracks %}
<h2 class="mb-3 font-mktg">{% data ui.product_sublanding.all_guides %}</h2> <h2 class="mb-3 font-mktg">{% data ui.product_sublanding.all_guides %}</h2>
{% endif %}
<form class="mt-2 mb-5 d-flex d-flex"> <form class="mt-2 mb-5 d-flex d-flex">
<div> <div>
@@ -39,9 +42,11 @@
{{ link_card | replace: "<display condition>", card_display_class }} {{ link_card | replace: "<display condition>", card_display_class }}
{% endfor %} {% endfor %}
{% if page.includeGuides.length > maxArticles %}
<button class="col-12 mt-5 text-center text-bold color-text-link btn-link js-filter-card-show-more" data-js-filter-card-max="{{ maxArticles }}"> <button class="col-12 mt-5 text-center text-bold color-text-link btn-link js-filter-card-show-more" data-js-filter-card-max="{{ maxArticles }}">
{% data ui.product_sublanding.load_more %} {% data ui.product_sublanding.load_more %}
</button> </button>
{% endif %}
<div class="js-filter-card-no-results d-none py-4 text-center color-text-secondary"> <div class="js-filter-card-no-results d-none py-4 text-center color-text-secondary">
<h4 class="text-normal">{% data ui.product_sublanding.no_result %}</h4> <h4 class="text-normal">{% data ui.product_sublanding.no_result %}</h4>

View File

@@ -68,6 +68,14 @@
{% include featured-links %} {% include featured-links %}
{% endif %} {% endif %}
{{ renderedPage }} {{ renderedPage }}
{% if tocItems and tocItems.length %}
{% if page.documentType == "category" or page.relativePath == "github/index.md" %}
{% include generic-toc-list %}
{% else %}
{% include generic-toc-items %}
{% endif %}
{% endif %}
</div> </div>
</div> </div>

View File

@@ -1,3 +1,16 @@
{% if FEATURE_NEW_SITETREE %}
<nav class="breadcrumbs f5" aria-label="Breadcrumb">
{% for breadcrumb in breadcrumbs %}
{% if breadcrumb.href == '' %}
<span title="{{ breadcrumb.documentType }}: {{ breadcrumb.title }}">{{ breadcrumb.title }}</span>
{% else %}
<a title="{{ breadcrumb.documentType }}: {{ breadcrumb.title }}" href="{{ breadcrumb.href }}" class="d-inline-block {% if breadcrumb.href == currentPath %}text-gray-light{% endif %}">
{{ breadcrumb.title }}
</a>
{% endif %}
{% endfor %}
</nav>
{% else %}
<nav class="breadcrumbs f5" aria-label="Breadcrumb"> <nav class="breadcrumbs f5" aria-label="Breadcrumb">
{% for breadcrumb in breadcrumbs %} {% for breadcrumb in breadcrumbs %}
{% if breadcrumb[1].href == '' %} {% if breadcrumb[1].href == '' %}
@@ -9,3 +22,4 @@
{% endif %} {% endif %}
{% endfor %} {% endfor %}
</nav> </nav>
{% endif %}

View File

@@ -0,0 +1,34 @@
{% for categoryPage in currentProductTree.childPages %}
{% if categoryPage.href == currentPath %}{% assign currentCategory = categoryPage %}{% endif %}
{% endfor %}
{% if currentCategory.page.shortTitle and currentCategory.page.shortTitle != '' %}{% assign currentCategoryTitle = currentCategory.page.shortTitle %}{% else %}{% assign currentCategoryTitle = currentCategory.page.title %}{% endif %}
{% assign maxArticles = 10 %}
<div class="py-6 all-articles-list">
<h2 class="font-mktg mb-4">{{ currentCategoryTitle }} docs</h2>
<div class="d-flex gutter flex-wrap">
{% for childPage in currentCategory.childPages %}
{% unless childPage.page.hidden %}
<div class="col-12 col-lg-4 mb-6 height-full">
<h4 class="mb-3"><a href="{{ childPage.href }}">{{ childPage.page.title }}</a></h4>
<ul class="list-style-none">
{% for grandchildPage in childPage.childPages %}
<li class="mb-3 {% if forloop.index > maxArticles %}d-none{% endif %}">
<a href="{{ grandchildPage.href }}">
{{ grandchildPage.page.title }}
</a>
</li>
{% endfor %}
{% assign numArticles = childPage.childPages | obj_size %}
{% if numArticles > maxArticles %}
<button class="js-all-articles-show-more btn-link Link--secondary">Show {{ numArticles | minus: maxArticles }} more {% octicon "chevron-up" class="v-align-text-bottom" %}</button>
{% endif %}
</ul>
</div>
{% endunless %}
{% endfor %}
</div>
</div>

View File

@@ -0,0 +1,12 @@
{% if tocItems %}
{% for tocItem in tocItems %}
{% assign title = tocItem.title %}
{% assign fullPath = tocItem.fullPath %}
{% assign intro = tocItem.intro %}
{% include liquid-tags/link-with-intro %}
{% endfor %}
{% endif %}

View File

@@ -0,0 +1,24 @@
{% if tocItems %}
<ul>
{% for tocItem in tocItems %}
{% assign title = tocItem.title %}
{% assign fullPath = tocItem.fullPath %}
{% assign intro = tocItem.intro %}
<li>{% include liquid-tags/link %}
{% if tocItem.childTocItems %}
{% unless page.relativePath == "github/index.md" %}
<ul>
{% for childItem in tocItem.childTocItems %}
{% assign title = childItem.title %}
{% assign fullPath = childItem.fullPath %}
<li>{% include liquid-tags/link %}</li>
{% endfor %}
</ul>
{% endunless %}
{% endif %}
</li>
{% endfor %}
</ul>
{% endif %}

View File

@@ -22,7 +22,7 @@
<div class="py-2 py-md-0 d-md-inline-block"> <div class="py-2 py-md-0 d-md-inline-block">
<h4 class="text-mono f5 text-normal color-text-secondary d-md-none">{% data ui.homepage.explore_by_product %}</h4> <h4 class="text-mono f5 text-normal color-text-secondary d-md-none">{% data ui.homepage.explore_by_product %}</h4>
<details class="dropdown-withArrow position-relative details details-reset d-md-none close-when-clicked-outside"> <details class="dropdown-withArrow position-relative details details-reset d-md-none close-when-clicked-outside">
<summary class="nav-desktop-productDropdownButton color-text-link-mktg py-2" role="button" aria-label="Toggle products list"> <summary class="nav-desktop-productDropdownButton color-text-link py-2" role="button" aria-label="Toggle products list">
<div id="current-product" class="d-flex flex-items-center flex-justify-between" style="padding-top: 2px;"> <div id="current-product" class="d-flex flex-items-center flex-justify-between" style="padding-top: 2px;">
<!-- Product switcher - GitHub.com, Enterprise Server, etc --> <!-- Product switcher - GitHub.com, Enterprise Server, etc -->
<!-- 404 and 500 error layouts are not real pages so we need to hardcode the name for those --> <!-- 404 and 500 error layouts are not real pages so we need to hardcode the name for those -->
@@ -35,7 +35,7 @@
{% for product in activeProducts %} {% for product in activeProducts %}
<a href="{% unless product.external %}/{{ currentLanguage }}{% endunless %}{{ product.href }}" <a href="{% unless product.external %}/{{ currentLanguage }}{% endunless %}{{ product.href }}"
class="d-block py-2 class="d-block py-2
{% if product.id == currentProduct %}color-text-link-mktg text-underline active{% elsif product.id == currentProduct.id %}color-text-link-mktg text-underline active{% else %}Link--primary no-underline{% endif %}"> {% if product.id == currentProduct %}color-text-link text-underline active{% elsif product.id == currentProduct.id %}color-text-link text-underline active{% else %}Link--primary no-underline{% endif %}">
{{ product.name }} {{ product.name }}
{% if product.external %} {% if product.external %}
<span class="ml-1"><svg width="9" height="10" viewBox="0 0 9 10" fill="none" xmlns="http://www.w3.org/2000/svg"><path stroke="currentColor" d="M.646 8.789l8-8M8.5 9V1M1 .643h8"/></svg></span> <span class="ml-1"><svg width="9" height="10" viewBox="0 0 9 10" fill="none" xmlns="http://www.w3.org/2000/svg"><path stroke="currentColor" d="M.646 8.789l8-8M8.5 9V1M1 .643h8"/></svg></span>

View File

@@ -0,0 +1,46 @@
{% assign maxArticles = 10 %}
{% if currentProductTree.page.shortTitle and currentProductTree.page.shortTitle != '' %}{% assign productTitle = currentProductTree.page.shortTitle %}{% else %}{% assign productTitle = currentProductTree.page.title %}{% endif %}
<div class="py-6 all-articles-list">
<h2 class="font-mktg mb-4">All {{ productTitle }} docs</h2>
<div class="d-flex gutter flex-wrap">
{% for childPage in currentProductTree.childPages %}
{% if childPage.page.documentType == "article" %}{% assign standaloneCategory = true %}{% else %}{% assign standaloneCategory = false %}{% endif %}
{% unless standaloneCategory %}
<div class="col-12 col-lg-4 mb-6 height-full">
<h4 class="mb-3"><a href="{{ childPage.href }}">{{ childPage.page.title }}</a></h4>
{% if childPage.childPages and childPage.childPages[0].page.documentType == "mapTopic" %}
<ul class="list-style-none">
{% for grandchildPage in childPage.childPages %}
{% unless grandchildPage.page.hidden %}
{% assign numArticles = childPage.childPages | obj_size %}
<li class="mb-3 {% if forloop.index > maxArticles %}d-none{% endif %}">
<a href="{{ grandchildPage.href }}">
{{ grandchildPage.page.title }}
</a>
</li>
{% if numArticles > maxArticles %}
<button class="js-all-articles-show-more btn-link Link--secondary">Show {{ numArticles | minus: maxArticles }} more {% octicon "chevron-up" class="v-align-text-bottom" %}</button>
{% endif %}
{% endunless %}
{% endfor %}
</ul>
{% else %}
<ul class="list-style-none">
{% assign numArticles = childPage.childPages | obj_size %}
{% for grandchildPage in childPage.childPages %}
<li class="mb-3 {% if forloop.index > maxArticles %}d-none{% endif %}"><a href="{{ grandchildPage.href }}">{{ grandchildPage.page.title }}</a></li>
{% endfor %}
</ul>
{% if numArticles > maxArticles %}
<button class="js-all-articles-show-more btn-link Link--secondary">Show {{ numArticles | minus: maxArticles }} more {% octicon "chevron-up" class="v-align-text-bottom" %}</button>
{% endif %}
{% endif %}
</div>
{% endunless %}
{% endfor %}
</div>
</div>

View File

@@ -0,0 +1,74 @@
<!--
Styling note:
Categories, Maptopics, and Articles list items get a class of `active` when they correspond to content
hierarchy of the current page. If an item's URL is also the same as the current URL, the item
also gets an `is-current-page` class.
-->
{% include all-products-link %}
{% unless currentProductTree.page.hidden %}
{% if currentProductTree.renderedShortTitle %}{% assign productTitle = currentProductTree.renderedShortTitle %}{% else %}{% assign productTitle = currentProductTree.renderedFullTitle %}{% endif %}
<li title="" class="sidebar-product mb-2">
<a href="{{currentProductTree.href}}" class="pl-4 pr-5 pb-1 f4">{{ productTitle }}</a>
</li>
<li>
<ul class="sidebar-categories list-style-none">
{% for childPage in currentProductTree.childPages %}
{% if childPage.page.documentType == "article" %}{% assign standaloneCategory = true %}{% else %}{% assign standaloneCategory = false %}{% endif %}
<li class="sidebar-category py-1 {% if currentPath contains childPage.href %}active {% if currentPath == childPage.href %}is-current-page {% endif %}{% endif %}{% if standaloneCategory %}standalone-category{% endif %}">
{% if childPage.renderedShortTitle %}{% assign childTitle = childPage.renderedShortTitle %}{% else %}{% assign childTitle = childPage.renderedFullTitle %}{% endif %}
{% if standaloneCategory %}
<a href="{{childPage.href}}" class="pl-4 pr-2 py-2 f6 text-uppercase d-block flex-auto mr-3">{{ childTitle }}</a>
{% else %}
<details class="dropdown-withArrow details details-reset" {% if currentPath contains childPage.href or forloop.index < 4 %}open{% endif %}>
<summary>
<div class="d-flex flex-justify-between">
<a href="{{childPage.href}}" class="pl-4 pr-2 py-2 f6 text-uppercase d-block flex-auto mr-3">{{ childTitle }}</a>
{% if forloop.index < 4 %}
<svg xmlns="http://www.w3.org/2000/svg" class="octicon flex-shrink-0 arrow mr-3" style="margin-top:7px" viewBox="0 0 16 16" width="16" height="16"> <path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></svg>
{% endif %}
</div>
</summary>
{% endif %}
<!-- some categories have maptopics with child articles -->
{% if currentPath contains childPage.href or forloop.index < 4 %}
{% if childPage.childPages[0].page.documentType == "mapTopic" %}
<ul class="sidebar-topics list-style-none position-relative">
{% for grandchildPage in childPage.childPages %}
{% if grandchildPage.renderedShortTitle %}{% assign grandchildTitle = grandchildPage.renderedShortTitle %}{% else %}{% assign grandchildTitle = grandchildPage.renderedFullTitle %}{% endif %}
<li class="sidebar-maptopic {% if currentPath contains grandchildPage.href %}active {% if currentPath == grandchildPage.href %}is-current-page{% endif %}{% endif %}">
<a href="{{grandchildPage.href}}" class="pl-4 pr-5 py-2">{{ grandchildTitle }} </a>
<ul class="sidebar-articles my-2">
{% for greatgrandchildPage in grandchildPage.childPages %}
{% if greatgrandchildPage.renderedShortTitle %}{% assign greatgrandchildTitle = greatgrandchildPage.renderedShortTitle %}{% else %}{% assign greatgrandchildTitle = greatgrandchildPage.renderedFullTitle %}{% endif %}
<li class="sidebar-article {% if currentPath contains greatgrandchildPage.href %}active {% if currentPath == greatgrandchildPage.href %}is-current-page{% endif %}{% endif %}">
<a href="{{greatgrandchildPage.href}}" class="pl-6 pr-5 py-1{% if forloop.last %} pb-2{% endif %}">{{ greatgrandchildTitle }}</a>
</li>
{% endfor %}
</ul>
</li>
{% endfor %}
</ul>
<!-- some categories have no maptopics, only articles -->
{% elsif childPage.childPages[0].page.documentType == "article" %}
<ul class="sidebar-articles list-style-none">
{% for grandchildPage in childPage.childPages %}
{% if grandchildPage.renderedShortTitle %}{% assign grandchildTitle = grandchildPage.renderedShortTitle %}{% else %}{% assign grandchildTitle = grandchildPage.renderedFullTitle %}{% endif %}
<li class="sidebar-article {% if currentPath contains grandchildPage.href %}active {% if currentPath == grandchildPage.href %}is-current-page{% endif %}{% endif %}">
<a href="{{grandchildPage.href}}" class="pl-4 pr-5 py-1{% if forloop.last %} pb-2{% endif %}">{{ grandchildTitle }}</a>
</li>
{% endfor %}
</ul>
{% endif %}
{% endif %}
</details>
</li>
{% endfor %}
</ul>
</li>
{% endunless %}

View File

@@ -15,7 +15,11 @@
</ul> </ul>
{% else %} {% else %}
<ul class="sidebar-products"> <ul class="sidebar-products">
{% if FEATURE_NEW_SITETREE %}
{% include sidebar-product %}
{% else %}
{% include sidebar-specific-product %} {% include sidebar-specific-product %}
{% endif %}
</ul> </ul>
{% endif %} {% endif %}
</nav> </nav>

View File

@@ -0,0 +1,9 @@
<div class="my-6 pt-6">
<h2 class="mb-2 font-mktg h1">{% data ui.product_landing.sponsor_community %}</h2>
<div class="d-flex flex-wrap gutter">
{% render sponsors-community-card for productUserExamples as example %}
</div>
<a href="https://github.com/sponsors/community" class="btn btn-outline float-right">{% data ui.product_landing.explore_people_and_projects %} {% octicon "arrow-right" %}</a>
</div>

View File

@@ -0,0 +1,14 @@
<div class="col-12 col-xl-4 col-lg-6 mb-4 js-filter-card {% if forloop.index0 > 5 %}d-none{% endif %}" data-repo="{{ example.user }}" data-description="{{ example.description }}">
<a
class="Box d-flex height-full color-shadow-medium hover-shadow-large no-underline color-text-primary p-4"
href="https://github.com/sponsors/{{ example.user }}"
>
<div class="flex-shrink-0 mr-3">
<img src="https://github.com/{{ example.user | split: '/' | first }}.png" alt="{{ example.user }}" class="avatar avatar-8 circle">
</div>
<div class="flex-auto">
<h4>{{ example.user }}</h4>
<p class="mt-1 color-text-tertiary">{{ example.description }}</p>
</div>
</a>
</div>

View File

@@ -19,10 +19,12 @@ export default function cardsFilter () {
const showMoreButton = document.querySelector('.js-filter-card-show-more') const showMoreButton = document.querySelector('.js-filter-card-show-more')
const noResults = document.querySelector('.js-filter-card-no-results') const noResults = document.querySelector('.js-filter-card-no-results')
// if jsFilterCardMax not set, assume no limit (well, at 99) // if jsFilterCardMax not set, assume no limit (well, at 99)
const maxCards = showMoreButton ? parseInt(showMoreButton.dataset.jsFilterCardMax || 99) : null // some landing pages don't include the button because the number of
// guides is less than the max defined in includes/article-cards.html
const maxCards = showMoreButton ? parseInt(showMoreButton.dataset.jsFilterCardMax || 99) : 99
const noFilter = () => { const noFilter = () => {
showMoreButton.classList.remove('d-none') if (showMoreButton) showMoreButton.classList.remove('d-none')
for (let index = 0; index < cards.length; index++) { for (let index = 0; index < cards.length; index++) {
const card = cards[index] const card = cards[index]
// Hide all but the first n number of cards // Hide all but the first n number of cards
@@ -38,7 +40,7 @@ export default function cardsFilter () {
const { currentTarget } = evt const { currentTarget } = evt
const value = currentTarget.value const value = currentTarget.value
showMoreButton.classList.add('d-none') if (showMoreButton) showMoreButton.classList.add('d-none')
// Track whether or not we had at least one match // Track whether or not we had at least one match
let hasMatches = false let hasMatches = false

View File

@@ -125,6 +125,10 @@
{% include community-examples %} {% include community-examples %}
{% endif %} {% endif %}
{% if productUserExamples %}
{% include sponsor-examples %}
{% endif %}
{{ renderedPage }} {{ renderedPage }}
</div> </div>
@@ -146,11 +150,22 @@
{% endif %} {% endif %}
<div class="container-xl px-3 px-md-6 mt-6"> <div class="container-xl px-3 px-md-6 mt-6">
{% if FEATURE_NEW_SITETREE %}
{% if page.documentType == "category" %}
{% include category-articles-list %}
{% endif %}
{% if page.documentType == "product" %}
{% include product-articles-list %}
{% endif %}
{% endif %}
{% unless FEATURE_NEW_SITETREE %}
{% if currentCategory %} {% if currentCategory %}
{% include all-articles-category %} {% include all-articles-category %}
{% else %} {% else %}
{% include all-articles-product %} {% include all-articles-product %}
{% endif %} {% endif %}
{% endunless %}
</div> </div>
{% include support-section %} {% include support-section %}

View File

@@ -22,8 +22,9 @@
</header> </header>
<!-- Featured track --> <!-- Featured track -->
{% assign featuredTrack = page.learningTracks[0] %}
{% if featuredTrack %}
<div class="mb-6 position-relative overflow-hidden mr-n3 ml-n3 px-3"> <div class="mb-6 position-relative overflow-hidden mr-n3 ml-n3 px-3">
{% assign featuredTrack = page.learningTracks[0] %}
<ul class="list-style-none d-flex flex-nowrap overflow-x-scroll px-2 feature-track"> <ul class="list-style-none d-flex flex-nowrap overflow-x-scroll px-2 feature-track">
<li class="px-2 d-flex flex-shrink-0"> <li class="px-2 d-flex flex-shrink-0">
<div class="d-inline-block Box p-5 bg-gradient--blue-pink color-text-inverse"> <div class="d-inline-block Box p-5 bg-gradient--blue-pink color-text-inverse">
@@ -54,7 +55,10 @@
<div class="position-absolute top-0 bottom-0 left-0 ml-3 pl-3 fade-background-left"></div> <div class="position-absolute top-0 bottom-0 left-0 ml-3 pl-3 fade-background-left"></div>
<div class="position-absolute top-0 bottom-0 right-0 mr-3 pr-3 fade-background-right"></div> <div class="position-absolute top-0 bottom-0 right-0 mr-3 pr-3 fade-background-right"></div>
</div> </div>
{% endif %}
{% assign learningTracks = page.learningTracks %}
{% if learningTracks %}
<div class="border-top py-6"> <div class="border-top py-6">
<h2 class="mb-3 font-mktg">{% data ui.product_sublanding.learning_paths %}</h2> <h2 class="mb-3 font-mktg">{% data ui.product_sublanding.learning_paths %}</h2>
<div class="lead-mktg color-text-secondary f4 description-text">{% data ui.product_sublanding.learning_paths_desc %}</div> <div class="lead-mktg color-text-secondary f4 description-text">{% data ui.product_sublanding.learning_paths_desc %}</div>
@@ -100,6 +104,7 @@
{% endfor %} {% endfor %}
</div> </div>
</div> </div>
{% endif %}
</div> </div>
</div> </div>

View File

@@ -32,7 +32,7 @@ async function getChangelogItems (prefix, feed) {
// capitalize the first letter of the title // capitalize the first letter of the title
title: title.trim().charAt(0).toUpperCase() + title.slice(1), title: title.trim().charAt(0).toUpperCase() + title.slice(1),
date: item.isoDate, date: item.isoDate,
href: item.guid href: item.link
} }
}) })

View File

@@ -20,7 +20,7 @@ module.exports = async function createTree (originalPath, langObj) {
const localizedBasePath = path.posix.join(__dirname, '..', langObj.dir, 'content') const localizedBasePath = path.posix.join(__dirname, '..', langObj.dir, 'content')
// Initialize the Page! This is where the file reads happen. // Initialize the Page! This is where the file reads happen.
let page = await Page.init({ const page = await Page.init({
basePath: localizedBasePath, basePath: localizedBasePath,
relativePath, relativePath,
languageCode: langObj.code languageCode: langObj.code
@@ -29,17 +29,10 @@ module.exports = async function createTree (originalPath, langObj) {
if (!page) { if (!page) {
// Do not throw an error if Early Access is not available. // Do not throw an error if Early Access is not available.
if (relativePath.startsWith('early-access')) return if (relativePath.startsWith('early-access')) return
// If a translated path doesn't exist, fall back to the English so there is parity between // Do not throw an error if translated page is not available.
// the English tree and the translated trees. if (langObj.code !== 'en') return
if (langObj.code !== 'en') {
page = await Page.init({
basePath: basePath,
relativePath,
languageCode: langObj.code
})
}
if (!page) throw Error(`Cannot initialize page for ${filepath}`) throw Error(`Cannot initialize page for ${filepath} in ${langObj.code}`)
} }
// Create the root tree object on the first run, and create children recursively. // Create the root tree object on the first run, and create children recursively.

View File

@@ -12,16 +12,20 @@ const schema = {
properties: { properties: {
title: { title: {
type: 'string', type: 'string',
required: true required: true,
translatable: true
}, },
shortTitle: { shortTitle: {
type: 'string' type: 'string',
translatable: true
}, },
intro: { intro: {
type: 'string' type: 'string',
translatable: true
}, },
product: { product: {
type: 'string' type: 'string',
translatable: true
}, },
permissions: { permissions: {
type: 'string' type: 'string'

View File

@@ -63,7 +63,7 @@ Note that link tags will only render links that are available in the current pag
| `{% homepage_link_with_intro /href %}` | The linked page's title and intro, with homepage-specific styling. | `{% homepage_link_with_intro /href %}` | The linked page's title and intro, with homepage-specific styling.
| `{% link_in_list /href %}` | The linked page's title in a list item. | `{% link_in_list /href %}` | The linked page's title in a list item.
| `{% topic_link_in_list /href %}` | The linked map topic's title in a list item (used in category TOCs). | `{% topic_link_in_list /href %}` | The linked map topic's title in a list item (used in category TOCs).
| `{% indented_data_reference site.data.foo.bar spaces=NUMBER %}` | The data reference with the specified number of spaces prepended to each line. | `{% indented_data_reference foo.bar spaces=NUMBER %}` | A data reference with the specified number of spaces prepended to each line. Defaults to 2 spaces if no spaces included. For example: `{% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %}`
## Creating tags ## Creating tags

Some files were not shown because too many files have changed in this diff Show More