Merge branch 'main' into move-explorer-to-docs
BIN
assets/images/help/images/overview-actions-result-navigate.png
Normal file
|
After Width: | Height: | Size: 116 KiB |
BIN
assets/images/help/images/overview-actions-result-updated-2.png
Normal file
|
After Width: | Height: | Size: 150 KiB |
BIN
assets/images/help/images/workflow-graph-job.png
Normal file
|
After Width: | Height: | Size: 128 KiB |
BIN
assets/images/help/images/workflow-graph.png
Normal file
|
After Width: | Height: | Size: 135 KiB |
BIN
assets/images/help/organizations/update-profile-button.png
Normal file
|
After Width: | Height: | Size: 5.5 KiB |
BIN
assets/images/help/pull_requests/dependency-review-rich-diff.png
Normal file
|
After Width: | Height: | Size: 45 KiB |
|
After Width: | Height: | Size: 25 KiB |
|
After Width: | Height: | Size: 214 KiB |
BIN
assets/images/help/pull_requests/file-filter-menu-json.png
Normal file
|
After Width: | Height: | Size: 105 KiB |
|
Before Width: | Height: | Size: 5.5 KiB After Width: | Height: | Size: 28 KiB |
|
After Width: | Height: | Size: 45 KiB |
|
After Width: | Height: | Size: 122 KiB |
BIN
assets/images/help/repository/artifact-drop-down-updated.png
Normal file
|
After Width: | Height: | Size: 45 KiB |
BIN
assets/images/help/repository/cancel-check-suite-updated.png
Normal file
|
After Width: | Height: | Size: 54 KiB |
BIN
assets/images/help/repository/copy-link-button-updated-2.png
Normal file
|
After Width: | Height: | Size: 120 KiB |
BIN
assets/images/help/repository/delete-all-logs-updated-2.png
Normal file
|
After Width: | Height: | Size: 78 KiB |
|
After Width: | Height: | Size: 326 KiB |
|
After Width: | Height: | Size: 85 KiB |
BIN
assets/images/help/repository/in-progress-run.png
Normal file
|
After Width: | Height: | Size: 170 KiB |
|
After Width: | Height: | Size: 124 KiB |
|
After Width: | Height: | Size: 116 KiB |
BIN
assets/images/help/repository/rerun-checks-drop-down-updated.png
Normal file
|
After Width: | Height: | Size: 81 KiB |
BIN
assets/images/help/repository/search-log-box-updated-2.png
Normal file
|
After Width: | Height: | Size: 41 KiB |
|
After Width: | Height: | Size: 133 KiB |
|
After Width: | Height: | Size: 98 KiB |
|
Before Width: | Height: | Size: 128 KiB |
|
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 64 KiB |
|
After Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 7.5 KiB |
BIN
assets/images/help/settings/theme-settings-radio-buttons.png
Normal file
|
After Width: | Height: | Size: 40 KiB |
BIN
assets/images/help/settings/update-theme-preference-button.png
Normal file
|
After Width: | Height: | Size: 11 KiB |
BIN
assets/images/help/sponsors/billing-account-switcher.png
Normal file
|
After Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 18 KiB |
BIN
assets/images/help/sponsors/link-account-button.png
Normal file
|
After Width: | Height: | Size: 35 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 32 KiB |
|
After Width: | Height: | Size: 21 KiB |
BIN
assets/images/help/sponsors/pay-prorated-amount-link.png
Normal file
|
After Width: | Height: | Size: 14 KiB |
BIN
assets/images/help/sponsors/select-an-account-drop-down.png
Normal file
|
After Width: | Height: | Size: 35 KiB |
BIN
assets/images/help/sponsors/sponsor-as-drop-down-menu.png
Normal file
|
After Width: | Height: | Size: 17 KiB |
BIN
assets/images/help/sponsors/sponsoring-as-drop-down-menu.png
Normal file
|
After Width: | Height: | Size: 16 KiB |
BIN
assets/images/help/sponsors/sponsoring-settings-button.png
Normal file
|
After Width: | Height: | Size: 16 KiB |
BIN
assets/images/help/sponsors/sponsoring-tab.png
Normal file
|
After Width: | Height: | Size: 30 KiB |
BIN
assets/images/help/sponsors/update-checkbox-manage.png
Normal file
|
After Width: | Height: | Size: 7.9 KiB |
@@ -226,6 +226,10 @@ jobs:
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
From your repository, click the **Actions** tab, and select the latest workflow run. You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.
|
||||
From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
|
||||
@@ -261,9 +261,11 @@ jobs:
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
From your repository, click the **Actions** tab, and select the latest workflow run. You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.
|
||||
From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||

|
||||
{% elsif currentVersion ver_gt "enterprise-server@2.22" %}
|
||||

|
||||
{% else %}
|
||||

|
||||
|
||||
@@ -25,7 +25,11 @@ Creating a package at the end of a continuous integration workflow can help duri
|
||||
|
||||
Now, when reviewing a pull request, you'll be able to look at the workflow run and download the artifact that was produced.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
|
||||
This will let you run the code in the pull request on your machine, which can help with debugging or testing the pull request.
|
||||
|
||||
|
||||
@@ -60,7 +60,11 @@ jobs:
|
||||
* `run: Test-Path resultsfile.log` - Check whether a file called `resultsfile.log` is present in the repository's root directory.
|
||||
* `Should -Be $true` - Uses Pester to define an expected result. If the result is unexpected, then {% data variables.product.prodname_actions %} flags this as a failed test. For example:
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
|
||||
* `Invoke-Pester Unit.Tests.ps1 -Passthru` - Uses Pester to execute tests defined in a file called `Unit.Tests.ps1`. For example, to perform the same test described above, the `Unit.Tests.ps1` will contain the following:
|
||||
```
|
||||
|
||||
@@ -108,8 +108,6 @@ jobs:
|
||||
path: output/test/code-coverage.html
|
||||
```
|
||||
|
||||

|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
|
||||
### Configuring a custom artifact retention period
|
||||
|
||||
@@ -238,7 +236,12 @@ jobs:
|
||||
echo The result is $value
|
||||
```
|
||||
|
||||
The workflow run will archive any artifacts that it generated. For more information on downloading archived artifacts, see "[Downloading workflow artifacts](/actions/managing-workflow-runs/downloading-workflow-artifacts)."
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
|
||||
@@ -204,7 +204,7 @@ In this diagram, you can see the workflow file you just created and how the {% d
|
||||
|
||||
### Viewing the job's activity
|
||||
|
||||
Once your job has started running, you can view each step's activity on {% data variables.product.prodname_dotcom %}.
|
||||
Once your job has started running, you can {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}see a visualization graph of the run's progress and {% endif %}view each step's activity on {% data variables.product.prodname_dotcom %}.
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
1. Under your repository name, click **Actions**.
|
||||
@@ -213,7 +213,14 @@ Once your job has started running, you can view each step's activity on {% data
|
||||

|
||||
1. Under "Workflow runs", click the name of the run you want to see.
|
||||

|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||
1. Under **Jobs** or in the visualization graph, click the job you want to see.
|
||||

|
||||
{% endif %}
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||
1. View the results of each step.
|
||||

|
||||
{% elsif currentVersion ver_gt "enterprise-server@2.22" %}
|
||||
1. Click on the job name to see the results of each step.
|
||||

|
||||
{% else %}
|
||||
|
||||
@@ -17,9 +17,14 @@ versions:
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.actions-tab %}
|
||||
{% data reusables.repositories.navigate-to-workflow %}
|
||||
{% data reusables.repositories.view-run %}
|
||||
1. From the list of workflow runs, click the name of the `queued` or `in progress` run that you want to cancel.
|
||||

|
||||
1. In the upper-right corner of the workflow, click **Cancel workflow**.
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
|
||||
### Steps {% data variables.product.prodname_dotcom %} takes to cancel a workflow run
|
||||
|
||||
|
||||
@@ -20,4 +20,8 @@ versions:
|
||||
{% data reusables.repositories.navigate-to-workflow %}
|
||||
{% data reusables.repositories.view-run %}
|
||||
1. Under **Artifacts**, click the artifact you want to download.
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
|
||||
@@ -18,6 +18,7 @@ versions:
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}{% link_in_list /using-the-visualization-graph %}{% endif %}
|
||||
{% link_in_list /viewing-workflow-run-history %}
|
||||
{% link_in_list /using-workflow-run-logs %}
|
||||
{% link_in_list /manually-running-a-workflow %}
|
||||
|
||||
@@ -16,5 +16,4 @@ versions:
|
||||
{% data reusables.repositories.actions-tab %}
|
||||
{% data reusables.repositories.navigate-to-workflow %}
|
||||
{% data reusables.repositories.view-run %}
|
||||
1. In the upper-right corner of the workflow, use the **Re-run jobs** drop-down menu, and select **Re-run all jobs**.
|
||||

|
||||
1. In the upper-right corner of the workflow, use the **Re-run jobs** drop-down menu, and select **Re-run all jobs**.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}{% else %}{% endif %}
|
||||
|
||||
@@ -27,7 +27,11 @@ versions:
|
||||
{% data reusables.repositories.navigate-to-workflow %}
|
||||
{% data reusables.repositories.view-run %}
|
||||
1. Under **Artifacts**, click {% octicon "trashcan" aria-label="The trashcan icon" %} next to the artifact you want to remove.
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
|
||||
### Setting the retention period for an artifact
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title: Using the visualization graph
|
||||
intro: Every workflow run generates a real-time graph that illustrates the run progress. You can use this graph to monitor and debug workflows.
|
||||
product: '{% data reusables.gated-features.actions %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=3.1'
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
{% data reusables.actions.visualization-beta %}
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.actions-tab %}
|
||||
{% data reusables.repositories.navigate-to-workflow %}
|
||||
{% data reusables.repositories.view-run %}
|
||||
|
||||
1. The graph displays each job in the workflow. An icon to the left of the job name indicates the status of the job. Lines between jobs indicate dependencies.
|
||||

|
||||
|
||||
2. Click on a job to view the job log.
|
||||

|
||||
@@ -45,7 +45,11 @@ You can search the build logs for a particular step. When you search logs, only
|
||||
{% data reusables.repositories.navigate-to-job-superlinter %}
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
|
||||
1. In the upper-right corner of the log output, in the **Search logs** search box, type a search query.
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
{% else %}
|
||||
1. To expand each step you want to include in your search, click the step.
|
||||

|
||||
@@ -63,8 +67,12 @@ You can download the log files from your workflow run. You can also download a w
|
||||
{% data reusables.repositories.view-run-superlinter %}
|
||||
{% data reusables.repositories.navigate-to-job-superlinter %}
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
|
||||
1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select **Download log archive**.
|
||||
1. In the upper right corner, click {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}{% octicon "gear" aria-label="The gear icon" %}{% else %}{% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}{% endif %} and select **Download log archive**.
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
{% else %}
|
||||
1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select **Download log archive**.
|
||||

|
||||
@@ -80,9 +88,17 @@ You can delete the log files from your workflow run. {% data reusables.repositor
|
||||
{% data reusables.repositories.view-run-superlinter %}
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
|
||||
1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
2. To delete the log files, click the **Delete all logs** button and review the confirmation prompt.
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
After deleting logs, the **Delete all logs** button is removed to indicate that no log files remain in the workflow run.
|
||||
{% else %}
|
||||
1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.
|
||||
|
||||
@@ -15,7 +15,7 @@ Billable job execution minutes are only shown for jobs run on private repositori
|
||||
{% data reusables.repositories.actions-tab %}
|
||||
{% data reusables.repositories.navigate-to-workflow %}
|
||||
{% data reusables.repositories.view-run %}
|
||||
1. Under the job summary, you can view the job's execution time. To view the billable job execution time, click **Run and billable time details**.
|
||||
1. Under the job summary, you can view the job's execution time. To view details about the billable job execution time, click the time under **Billable time**.
|
||||

|
||||
|
||||
{% note %}
|
||||
|
||||
@@ -60,8 +60,13 @@ Committing the workflow file in your repository triggers the `push` event and ru
|
||||
{% data reusables.repositories.actions-tab %}
|
||||
{% data reusables.repositories.navigate-to-workflow-superlinter %}
|
||||
{% data reusables.repositories.view-run-superlinter %}
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||
1. Under **Jobs** or in the visualization graph, click the **Lint code base** job.
|
||||

|
||||
{% else %}
|
||||
1. In the left sidebar, click the **Lint code base** job.
|
||||

|
||||
{% endif %}
|
||||
{% data reusables.repositories.view-failed-job-results-superlinter %}
|
||||
|
||||
### More starter workflows
|
||||
|
||||
@@ -22,6 +22,7 @@ featuredLinks:
|
||||
- /discussions/guides/finding-discussions-across-multiple-repositories
|
||||
- /discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions
|
||||
- /discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository
|
||||
product_video: https://www.youtube-nocookie.com/embed/DbTWBP3_RbM
|
||||
layout: product-landing
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
|
||||
@@ -10,7 +10,7 @@ versions:
|
||||
|
||||
### Introduction
|
||||
|
||||
{% data variables.product.prodname_discussions %} {% data variables.product.prodname_discussions %} is a collaborative communication forum for the community around an open source project. Discussions are for conversations that need to be transparent and accessible but do not need to be tracked on a project board and are not related to code, unlike issues. Discussions enable fluid, open conversation in a public forum.
|
||||
{% data variables.product.prodname_discussions %} is a collaborative communication forum for the community around an open source project. Discussions are for conversations that need to be transparent and accessible but do not need to be tracked on a project board and are not related to code, unlike issues. Discussions enable fluid, open conversation in a public forum.
|
||||
|
||||
Discussions give a space for more collaborative conversations by connecting and giving a more centralized area to connect and find information.
|
||||
|
||||
@@ -57,4 +57,4 @@ People with triage permissions for a repository can help moderate a project's di
|
||||
|
||||
### Next steps
|
||||
|
||||
Once there is a clear path to scope work out and move an idea from concept to reality, you can create an issue and start tracking your progress. For more information on creating an issue from a discussion, see, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions)."
|
||||
Once there is a clear path to scope work out and move an idea from concept to reality, you can create an issue and start tracking your progress. For more information on creating an issue from a discussion, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions)."
|
||||
|
||||
@@ -179,7 +179,7 @@ An overview of some of the most common actions that are recorded as events in th
|
||||
| `repo_funding_link_button_toggle` | Triggered when you enable or disable a sponsor button in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
|
||||
| `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
|
||||
| `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
|
||||
| `sponsor_sponsorship_create` | Triggered when you sponsor a developer (see "[Sponsoring an open source contributor](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor#sponsoring-a-developer)")
|
||||
| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor)")
|
||||
| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/articles/managing-your-sponsorship)")
|
||||
| `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
|
||||
| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
|
||||
|
||||
@@ -52,6 +52,7 @@ versions:
|
||||
{% link_in_list /finding-changed-methods-and-functions-in-a-pull-request %}
|
||||
{% link_in_list /commenting-on-a-pull-request %}
|
||||
{% link_in_list /viewing-a-pull-request-review %}
|
||||
{% link_in_list /reviewing-dependency-changes-in-a-pull-request %}
|
||||
{% link_in_list /incorporating-feedback-in-your-pull-request %}
|
||||
{% link_in_list /approving-a-pull-request-with-required-reviews %}
|
||||
{% link_in_list /dismissing-a-pull-request-review %}
|
||||
|
||||
@@ -0,0 +1,74 @@
|
||||
---
|
||||
title: Reviewing dependency changes in a pull request
|
||||
intro: 'If a pull request contains changes to dependencies, you can view a summary of what has changed and whether there are known vulnerabilities in any of the dependencies.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Dependency review is currently in beta and subject to change.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
### About dependency review
|
||||
|
||||
If a pull request targets your repository's default branch and contains changes to package manifests or lock files, you can display a dependency review to see what has changed. The dependency review includes details of changes to indirect dependencies in lock files, and it tells you if any of the added or updated dependencies contain known vulnerabilities.
|
||||
|
||||
Dependency review is available in:
|
||||
|
||||
* All public repositories.
|
||||
* Private repositories owned by organizations with an {% data variables.product.prodname_advanced_security %} license that have the dependency graph enabled. For more information, see "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)."
|
||||
|
||||
Sometimes you might just want to update the version of one dependency in a manifest and generate a pull request. However, if the updated version of this direct dependency also has updated dependencies, your pull request may have more changes than you expected. The dependency review for each manifest and lock file provides an easy way to see what has changed, and whether any of the new dependency versions contain known vulnerabilities.
|
||||
|
||||
By checking the dependency reviews in a pull request, and changing any dependencies that are flagged as vulnerable, you can avoid vulnerabilities being added to your project. {% data variables.product.prodname_dependabot_alerts %} will find vulnerabilities that are already in your dependencies, but it's much better to avoid introducing potential problems than to fix them at some later date. For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."
|
||||
|
||||
Dependency review supports the same languages and package management ecosystems as the dependency graph. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)."
|
||||
|
||||
### Reviewing dependencies in a pull request
|
||||
|
||||
{% data reusables.repositories.sidebar-pr %}
|
||||
{% data reusables.repositories.choose-pr-review %}
|
||||
{% data reusables.repositories.changed-files %}
|
||||
|
||||
1. If the pull request contains many files, use the **File filter** drop-down menu to collapse all files that don't record dependencies. This will make it easier to focus your review on the dependency changes.
|
||||
|
||||

|
||||
|
||||
1. On the right of the header for a manifest or lock file, display the dependency review by clicking the rich diff button.
|
||||
|
||||

|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** The dependency review provides a clearer view of what has changed in large lock files, where the source diff is not rendered by default.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
1. Check the dependencies listed in the dependency review.
|
||||
|
||||

|
||||
|
||||
Any added or changed dependencies that have vulnerabilities are listed first, ordered by severity and then by dependency name. This means that the highest severity dependencies are always at the top of a dependency review. Other dependencies are listed alphabetically by dependency name.
|
||||
|
||||
The icon beside each dependency indicates whether the dependency has been added (<span style="color:#22863a">{% octicon "diff-added" aria-label="Dependency added icon" %}</span>), updated (<span style="color:#b08800">{% octicon "diff-modified" aria-label="Dependency modified icon" %}</span>), or removed (<span style="color:#cb2431">{% octicon "diff-removed" aria-label="Dependency removed icon" %}</span>) in this pull request.
|
||||
|
||||
Other information includes:
|
||||
|
||||
* The version, or version range, of the new, updated, or deleted dependency.
|
||||
* For a specific version of a dependency:
|
||||
* The age of that release of the dependency.
|
||||
* The number of projects that are dependent on this software. This information is taken from the dependency graph. Checking the number of dependents can help you avoid accidentally adding the wrong dependency.
|
||||
* The license used by this dependency, if this information is available. This is useful if you want to avoid code with certain licenses being used in your project.
|
||||
|
||||
Where a dependency has a known vulnerability, the warning message includes:
|
||||
|
||||
* A brief description of the vulnerability.
|
||||
* A Common Vulnerabilities and Exposures (CVE) or {% data variables.product.prodname_security_advisories %} (GHSA) identification number. You can click this ID to find out more about the vulnerability.
|
||||
* The severity of the vulnerability.
|
||||
* The version of the dependency in which the vulnerability was fixed. If you are reviewing a pull request for someone, you might ask the contributor to update the dependency to the patched version, or a later release.
|
||||
|
||||
1. You can return to the original view of the file by clicking the source diff button.
|
||||
|
||||

|
||||
@@ -30,6 +30,18 @@ Before you submit your review, your line comments are _pending_ and only visible
|
||||
|
||||

|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
### Reviewing dependency changes
|
||||
|
||||
If the pull request contains changes to dependencies you can use the dependency review for a manifest or lock file to see what has changed and check whether the changes introduce security vulnerabilities. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)."
|
||||
|
||||
{% data reusables.repositories.changed-files %}
|
||||
|
||||
1. On the right of the header for a manifest or lock file, display the dependency review by clicking the rich diff button.
|
||||
|
||||

|
||||
{% endif %}
|
||||
|
||||
### Marking a file as viewed
|
||||
|
||||
After you finish reviewing a file, you can mark the file as viewed, and the file will collapse. If the file changes after you view the file, it will be unmarked as viewed.
|
||||
@@ -56,8 +68,5 @@ After you've finished reviewing all the files you want in the pull request, subm
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[About pull request reviews](/articles/about-pull-request-reviews)"
|
||||
- "[About required reviews for pull requests](/articles/about-required-reviews-for-pull-requests)"
|
||||
- "[Approving a pull request with required reviews](/articles/approving-a-pull-request-with-required-reviews)"
|
||||
- "[Commenting on a pull request](/articles/commenting-on-a-pull-request)"
|
||||
- "[Filtering pull requests by review status](/articles/filtering-pull-requests-by-review-status)"
|
||||
- "[About required reviews for pull requests](/github/administering-a-repository/about-required-reviews-for-pull-requests)"
|
||||
- "[Filtering pull requests by review status](/github/managing-your-work-on-github/filtering-pull-requests-by-review-status)"
|
||||
|
||||
@@ -25,6 +25,8 @@ When your code depends on a package that has a security vulnerability, this vuln
|
||||
- New advisory data is synchronized to {% data variables.product.prodname_ghe_server %} each hour from {% data variables.product.prodname_dotcom_the_website %}. For more information about advisory data, see "<a href="/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database" class="dotcom-only">Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}</a>."{% endif %}
|
||||
- The dependency graph for a repository changes. For example, when a contributor pushes a commit to change the packages or versions it depends on{% if currentVersion == "free-pro-team@latest" %}, or when the code of one of the dependencies changes{% endif %}. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."
|
||||
|
||||
{% data reusables.repositories.dependency-review %}
|
||||
|
||||
For a list of the ecosystems that {% data variables.product.product_name %} can detect vulnerabilities and dependencies for, see "[Supported package ecosystems](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)."
|
||||
|
||||
{% note %}
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: About managing vulnerable dependencies
|
||||
intro: '{% data variables.product.prodname_dotcom %} helps you to avoid using third-party software that contains known vulnerabilities.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
{% data variables.product.prodname_dotcom %} provides the following tools for removing and avoiding vulnerable dependencies.
|
||||
|
||||
#### Dependency graph
|
||||
The dependency graph is a summary of the manifest and lock files stored in a repository. It shows you the ecosystems and packages your codebase depends on (its dependencies) and the repositories and packages that depend on your project (its dependents). The information in the dependency graph is used by dependency review and {% data variables.product.prodname_dependabot %}.
|
||||
For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."
|
||||
|
||||
#### Dependency review
|
||||
By checking the dependency reviews on pull requests you can avoid introducing vulnerabilities from dependencies into your codebase. If the pull requests adds a vulnerable dependency, or changes a dependency to a vulnerable version, this is highlighted in the dependency review. You can change the dependency to a patched version before merging the pull request. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)."
|
||||
|
||||
#### {% data variables.product.prodname_dependabot_alerts %}
|
||||
{% data variables.product.prodname_dotcom %} can create {% data variables.product.prodname_dependabot_alerts %} when it detects vulnerable dependencies in your repository. The alert is displayed on the Security tab for the repository. The alert includes a link to the affected file in the project, and information about a fixed version. {% data variables.product.prodname_dotcom %} also notifies the maintainers of the repository, according to their notification preferences. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
|
||||
#### {% data variables.product.prodname_dependabot_security_updates %}
|
||||
When {% data variables.product.prodname_dotcom %} generates a {% data variables.product.prodname_dependabot %} alert for a vulnerable dependency in your repository, {% data variables.product.prodname_dependabot %} can automatically try to fix it for you. {% data variables.product.prodname_dependabot_security_updates %} are automatically generated pull requests that update a vulnerable dependency to a fixed version. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
|
||||
|
||||
|
||||
#### {% data variables.product.prodname_dependabot_version_updates %}
|
||||
Enabling {% data variables.product.prodname_dependabot_version_updates %} takes the effort out of maintaining your dependencies. With {% data variables.product.prodname_dependabot_version_updates %}, whenever {% data variables.product.prodname_dotcom %} identifies an outdated dependency, it raises a pull request to update the manifest to the latest version of the dependency. By contrast, {% data variables.product.prodname_dependabot_security_updates %} only raises pull requests to fix vulnerable dependencies. For more information, see "[About Dependabot version updates](/github/administering-a-repository/about-dependabot-version-updates)."
|
||||
@@ -21,6 +21,7 @@ versions:
|
||||
{% link_in_list /editing-a-security-advisory %}
|
||||
{% link_in_list /withdrawing-a-security-advisory %}
|
||||
{% topic_link_in_list /managing-vulnerabilities-in-your-projects-dependencies %}
|
||||
{% link_in_list /about-managing-vulnerable-dependencies %}
|
||||
{% link_in_list /browsing-security-vulnerabilities-in-the-github-advisory-database %}
|
||||
{% link_in_list /about-alerts-for-vulnerable-dependencies %}
|
||||
{% link_in_list /configuring-notifications-for-vulnerable-dependencies %}
|
||||
|
||||
@@ -12,9 +12,11 @@ Your repository's {% data variables.product.prodname_dependabot %} alerts tab li
|
||||
|
||||
You can enable automatic security updates for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
|
||||
|
||||
{% data reusables.repositories.dependency-review %}
|
||||
|
||||
### About updates for vulnerable dependencies in your repository
|
||||
|
||||
{% data variables.product.product_name %} generates {% data variables.product.prodname_dependabot_alerts %} when we detect vulnerabilities affecting your repository. For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, when {% data variables.product.product_name %} detects a vulnerable dependency {% data variables.product.prodname_dependabot %} creates a pull request to fix it. The pull request will upgrade the dependency to the minimum possible secure version needed to avoid the vulnerability.
|
||||
{% data variables.product.product_name %} generates {% data variables.product.prodname_dependabot_alerts %} when we detect that your codebase is using dependencies with known vulnerabilities. For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, when {% data variables.product.product_name %} detects a vulnerable dependency in the default branch, {% data variables.product.prodname_dependabot %} creates a pull request to fix it. The pull request will upgrade the dependency to the minimum possible secure version needed to avoid the vulnerability.
|
||||
|
||||
### Viewing and updating vulnerable dependencies
|
||||
|
||||
|
||||
@@ -9,6 +9,8 @@ versions:
|
||||
|
||||
{% data reusables.sponsors.sponsorship-details %}
|
||||
|
||||
{% data reusables.sponsors.no-fees %}
|
||||
|
||||
{% data reusables.dotcom_billing.view-all-subscriptions %}
|
||||
|
||||
### Further reading
|
||||
|
||||
@@ -7,25 +7,24 @@ versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
{% data reusables.sponsors.org-sponsors-release-phase %}
|
||||
|
||||
### About sponsorship downgrades
|
||||
|
||||
When you downgrade or cancel a sponsorship, the change will become effective on your next billing date. {% data reusables.sponsors.no-refunds %}
|
||||
|
||||
### Downgrading a sponsorship
|
||||
|
||||
When you downgrade a sponsorship, the change will become effective on your next billing date. {% data reusables.sponsors.no-refunds %}
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.billing %}
|
||||
{% data reusables.user_settings.subscriptions-tab %}
|
||||
{% data reusables.sponsors.change-tier %}
|
||||
4. On the right side of the page, next to your selected tier, click **Edit**.
|
||||

|
||||
{% data reusables.sponsors.navigate-to-sponsored-account %}
|
||||
{% data reusables.sponsors.sponsorship-dashboard %}
|
||||
{% data reusables.sponsors.select-a-tier %}
|
||||
{% data reusables.sponsors.update-sponsorship %}
|
||||
|
||||
### Canceling a sponsorship
|
||||
|
||||
When you cancel a sponsorship, the change will become effective on your next billing date. {% data reusables.sponsors.no-refunds %}
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.billing %}
|
||||
{% data reusables.sponsors.billing-switcher %}
|
||||
{% data reusables.user_settings.subscriptions-tab %}
|
||||
3. Under "{% data variables.product.prodname_sponsors %}", to the right of the sponsored open source contributor, click {% octicon "triangle-down" aria-label="The down triangle octicon" %} next to your sponsored amount, then click **Cancel sponsorship**.
|
||||

|
||||
|
||||
@@ -7,13 +7,15 @@ versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
{% data reusables.sponsors.org-sponsors-release-phase %}
|
||||
|
||||
### About sponsorship upgrades
|
||||
|
||||
When you upgrade your sponsorship tier, the change will become effective immediately. {% data reusables.sponsors.prorated-sponsorship %}
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.billing %}
|
||||
{% data reusables.user_settings.subscriptions-tab %}
|
||||
{% data reusables.sponsors.change-tier %}
|
||||
4. On the right side of the page, next to your selected tier, click **Edit**.
|
||||

|
||||
### Upgrading a sponsorship
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsored-account %}
|
||||
{% data reusables.sponsors.sponsorship-dashboard %}
|
||||
{% data reusables.sponsors.select-a-tier %}
|
||||
{% data reusables.sponsors.update-sponsorship %}
|
||||
{% data reusables.sponsors.update-sponsorship %}
|
||||
@@ -92,6 +92,7 @@ versions:
|
||||
{% link_in_list /managing-default-labels-for-repositories-in-your-organization %}
|
||||
{% link_in_list /changing-the-visibility-of-your-organizations-dependency-insights %}
|
||||
{% link_in_list /managing-the-display-of-member-names-in-your-organization %}
|
||||
{% link_in_list /managing-updates-from-accounts-your-organization-sponsors %}
|
||||
{% link_in_list /disabling-publication-of-github-pages-sites-for-your-organization %}
|
||||
{% link_in_list /deleting-an-organization-account %}
|
||||
{% link_in_list /converting-an-organization-into-a-user %}
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: Managing updates from accounts your organization sponsors
|
||||
intro: You can manage the email address that receives updates from accounts your organization sponsors.
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
permissions: Organization owners can manage updates from accounts the organization sponsors.
|
||||
---
|
||||
|
||||
{% data reusables.sponsors.org-sponsors-release-phase %}
|
||||
|
||||
The developers and organizations that your organization sponsors can send you updates about their work. You can manage the email address that receives these updates.
|
||||
|
||||
You can also disable updates from accounts your organization sponsors. For more information, see "[Managing your sponsorship](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship#managing-email-updates-for-your-sponsorship)."
|
||||
|
||||
{% data reusables.profile.access_profile %}
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.organizations.org_settings %}
|
||||
1. Under "Sponsors update email (Private)", type the email address you want to receive updates from accounts your organization sponsors.
|
||||

|
||||
1. Click **Update profile**.
|
||||

|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Supporting the open source community with {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors)"
|
||||
@@ -55,6 +55,9 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late
|
||||
| Disable team discussions for an organization (see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)" for details) | **X** | | |{% if currentVersion == "free-pro-team@latest" %}
|
||||
| Manage viewing of organization dependency insights (see "[Changing the visibility of your organization's dependency insights](/articles/changing-the-visibility-of-your-organizations-dependency-insights)" for details) | **X** | | |{% endif %}
|
||||
| Set a team profile picture in **all teams** (see "[Setting your team's profile picture](/articles/setting-your-team-s-profile-picture)" for details) | **X** | | |
|
||||
| Sponsor accounts and manage the organization's sponsorships (see "[Sponsoring open-source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)" for details) | **X** | **X** | |
|
||||
| Manage email updates from sponsored accounts (see "[Managing updates from accounts your organization's sponsors](/github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors)" for details) | **X** | | |
|
||||
| Attribute your sponsorships to another organization (see "[Attributing sponsorships to your organization](/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization)" for details ) | **X** | | |
|
||||
| Disable publication of {% data variables.product.prodname_pages %} sites from repositories in the organization (see "[Disabling publication of {% data variables.product.prodname_pages %} sites for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-publication-of-github-pages-sites-for-your-organization)" for details) | **X** | | |
|
||||
| Manage security and analysis settings (see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" for details) | **X** | | |
|
||||
| Enable and enforce [SAML single sign-on](/articles/about-identity-and-access-management-with-saml-single-sign-on) | **X** | | |
|
||||
|
||||
@@ -107,25 +107,53 @@ Using the qualifier `country`, you can filter events in the audit log based on t
|
||||
{% data reusables.audit_log.exported-log-keys-and-values %}
|
||||
{% endif %}
|
||||
|
||||
### Using the Audit log API
|
||||
### Using the audit log API
|
||||
|
||||
You can interact with the audit log using the GraphQL API{% if currentVersion == "free-pro-team@latest" %} or the REST API{% endif %}.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
#### Using the GraphQL API
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: The Audit log API is available for organizations using {% data variables.product.prodname_enterprise %}. {% data reusables.gated-features.more-info-org-products %}
|
||||
**Note**: The audit log GraphQL API is available for organizations using {% data variables.product.prodname_enterprise %}. {% data reusables.gated-features.more-info-org-products %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
To ensure a secure IP and maintain compliance for your organization, you can use the Audit log API to keep copies of your audit log data and monitor:
|
||||
* Access to your organization or repository settings.
|
||||
* Changes in permissions.
|
||||
* Added or removed users in an organization, repository, or team.
|
||||
* Users being promoted to admin.
|
||||
* Changes to permissions of a GitHub App.
|
||||
To ensure a secure IP and maintain compliance for your organization, you can use the audit log GraphQL API to keep copies of your audit log data and monitor:
|
||||
{% data reusables.audit_log.audit-log-api-info %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
Note that you can't retrieve Git events using the GraphQL API.
|
||||
{% endif %}
|
||||
|
||||
The GraphQL response can include data for up to 90 to 120 days.
|
||||
|
||||
For example, you can make a GraphQL request to see all the new organization members added to your organization. For more information, see the "[GraphQL API Audit Log](/graphql/reference/interfaces#auditentry/)."
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
#### Using the REST API
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: The audit log REST API is available as a limited beta for users of {% data variables.product.prodname_ghe_cloud %} only. To join the beta, talk to your services or sales contact at {% data variables.product.company_short %}.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
To ensure a secure IP and maintain compliance for your organization, you can use the audit log REST API to keep copies of your audit log data and monitor:
|
||||
{% data reusables.audit_log.audit-log-api-info %}
|
||||
* Git events, such as cloning, fetching, and pushing
|
||||
|
||||
{% data reusables.audit_log.audit-log-git-events-retention %}
|
||||
|
||||
For more information about the audit log REST API, see "[Organizations](/rest/reference/orgs#get-the-audit-log-for-an-organization)" in the REST API documentation.
|
||||
|
||||
{% endif %}
|
||||
|
||||
### Audit log actions
|
||||
|
||||
An overview of some of the most common actions that are recorded as events in the audit log.
|
||||
@@ -215,6 +243,28 @@ An overview of some of the most common actions that are recorded as events in th
|
||||
| `update` | Triggered when [a reply to a team discussion post is edited](/articles/managing-disruptive-comments/#editing-a-comment).
|
||||
| `destroy` | Triggered when [a reply to a team discussion post is deleted](/articles/managing-disruptive-comments/#deleting-a-comment).
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
#### `git` category actions
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** To access Git events in the audit log, you must use the audit log REST API. This functionality is available as a limited beta for users of {% data variables.product.prodname_ghe_cloud %} only. To join the beta, talk to your services or sales contact at {% data variables.product.company_short %}.
|
||||
|
||||
For more information about the audit log REST API, see "[Organizations](/rest/reference/orgs#get-the-audit-log-for-an-organization)" in the REST API documentation.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% data reusables.audit_log.audit-log-git-events-retention %}
|
||||
|
||||
| Action | Description
|
||||
|---------|----------------------------
|
||||
| `clone` | Triggered when a repository is cloned.
|
||||
| `fetch` | Triggered when changes are fetched from a repository.
|
||||
| `push` | Triggered when changes are pushed to a repository.
|
||||
|
||||
{% endif %}
|
||||
|
||||
#### `hook` category actions
|
||||
|
||||
| Action | Description
|
||||
@@ -502,8 +552,20 @@ For more information, see "[Restricting publication of {% data variables.product
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| repo_funding_link_button_toggle | Triggered when you enable or disable a sponsor button in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
|
||||
| repo_funding_links_file_action | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
|
||||
| `repo_funding_link_button_toggle` | Triggered when you enable or disable a sponsor button in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
|
||||
| `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
|
||||
| `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
|
||||
| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor)")
|
||||
| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored account (see "[Managing your sponsorship](/articles/managing-your-sponsorship)")
|
||||
| `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
|
||||
| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)")
|
||||
| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your organizaion](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)")
|
||||
| `sponsored_developer_profile_update` | Triggered when you edit your sponsored organization profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors)")
|
||||
| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)")
|
||||
| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Changing your sponsorship tiers](/articles/changing-your-sponsorship-tiers)")
|
||||
| sponsored_developer_update_newsletter_send | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/articles/contacting-your-sponsors)")
|
||||
| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)")
|
||||
| `waitlist_join` | Triggered when you join the waitlist to become a sponsored organization (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)")
|
||||
{% endif %}
|
||||
|
||||
{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
|
||||
|
||||
@@ -14,6 +14,7 @@ versions:
|
||||
|
||||
{% topic_link_in_list /managing-user-account-settings %}
|
||||
{% link_in_list /about-your-personal-dashboard %}
|
||||
{% link_in_list /managing-your-theme-settings %}
|
||||
{% link_in_list /changing-your-github-username %}
|
||||
{% link_in_list /merging-multiple-user-accounts %}
|
||||
{% link_in_list /converting-a-user-into-an-organization %}
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: Managing your theme settings
|
||||
intro: You can manage how {% data variables.product.product_name %} looks to you by setting a theme preference that either follows your system settings or always uses light mode or dark mode.
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Theme settings is currently in beta and subject to change.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
For choice and flexibility in how and when you use {% data variables.product.product_name %}, you can configure theme settings to change how {% data variables.product.product_name %} looks to you. You can choose from two themes, light and dark, or you can configure {% data variables.product.product_name %} to follow your system settings. Some developers use dark theme for personal preference, to reduce power consumption on certain devices, or to reduce eye strain in low-light conditions.
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
1. In the user settings sidebar, click **Appearance**.
|
||||

|
||||
1. Under "Theme", select a theme preference.
|
||||

|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Setting a theme for {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/setting-a-theme-for-github-desktop)"
|
||||
@@ -9,7 +9,9 @@ versions:
|
||||
|
||||
### About {% data variables.product.prodname_sponsors %}
|
||||
|
||||
{% data reusables.sponsors.sponsorship-details %} {% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)."
|
||||
{% data reusables.sponsors.sponsorship-details %}
|
||||
|
||||
{% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)."
|
||||
|
||||
{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors)" and "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)."
|
||||
|
||||
@@ -25,7 +27,7 @@ When you become a sponsored developer or sponsored organization, additional term
|
||||
|
||||
{% endnote %}
|
||||
|
||||
The {% data variables.product.prodname_matching_fund %} aims to benefit members of the {% data variables.product.prodname_dotcom %} community who develop open source software that promotes the [{% data variables.product.prodname_dotcom %} Community Guidelines](/github/site-policy/github-community-guidelines). Sponsored organizations are not eligible for {% data variables.product.prodname_matching_fund %}.
|
||||
The {% data variables.product.prodname_matching_fund %} aims to benefit members of the {% data variables.product.prodname_dotcom %} community who develop open source software that promotes the [{% data variables.product.prodname_dotcom %} Community Guidelines](/github/site-policy/github-community-guidelines). Payments to sponsored organizations and payments from organizations are not eligible for {% data variables.product.prodname_matching_fund %}.
|
||||
|
||||
To be eligible for the {% data variables.product.prodname_matching_fund %}, you must create a profile that will attract a community that will sustain you for the long term. For more information about creating a strong profile, see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors)."
|
||||
|
||||
@@ -35,8 +37,6 @@ To be eligible for the {% data variables.product.prodname_matching_fund %}, you
|
||||
|
||||
This is just the beginning — we'd love your input to make sure {% data variables.product.prodname_sponsors %} serves your needs into the future. Please send us your feedback or suggestions by contacting [{% data variables.contact.github_support %}](https://support.github.com/contact?form%5Bsubject%5D=GitHub+Sponsors).
|
||||
|
||||
Currently, only individual users can sponsor developers and organizations. If your organization is interested in sponsoring developers, please let us know by contacting [{% data variables.contact.github_support %}](https://support.github.com/contact?form%5Bsubject%5D=GitHub+Sponsors).
|
||||
|
||||
### Further reading
|
||||
- "[Sponsoring open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)"
|
||||
- "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors)"
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
title: Attributing sponsorships to your organization
|
||||
intro: 'You can attribute the sponsorships paid by one of your organizations to another organization.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
permissions: People who are organization owners of both organizations can attribute one organization's sponsorships to another organization.
|
||||
---
|
||||
|
||||
1. Navigate to the organization whose sponsorships you want to attribute to another organization.
|
||||
1. Under your organization name, click {% octicon "heart" aria-label="The heart icon" %} **Sponsoring**.
|
||||

|
||||
1. In the upper-right corner, click {% octicon "gear" aria-label="The gear icon" %} **Settings**.
|
||||

|
||||
1. Under "Link sponsorships to another account", use the drop-down menu, then click the organization you want this organization's sponsorships to be attributed to.
|
||||

|
||||
1. Click **Link account**.
|
||||

|
||||
@@ -13,38 +13,20 @@ versions:
|
||||
|
||||
{% data reusables.sponsors.maximum-tier %}
|
||||
|
||||
### Adding a tier for your sponsored developer profile
|
||||
### Adding a tier
|
||||
|
||||
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsor-tiers-tab %}
|
||||
{% data reusables.sponsors.click-add-tier %}
|
||||
{% data reusables.sponsors.tier-price-description %}
|
||||
{% data reusables.sponsors.save-tier-draft %}
|
||||
{% data reusables.sponsors.review-and-publish-tier %}
|
||||
|
||||
### Adding a tier for your sponsored organization profile
|
||||
### Editing or retiring a tier
|
||||
|
||||
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsor-tiers-tab %}
|
||||
{% data reusables.sponsors.click-add-tier %}
|
||||
{% data reusables.sponsors.tier-price-description %}
|
||||
{% data reusables.sponsors.save-tier-draft %}
|
||||
{% data reusables.sponsors.review-and-publish-tier %}
|
||||
|
||||
### Editing or retiring a tier for your sponsored developer profile
|
||||
|
||||
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsor-tiers-tab %}
|
||||
{% data reusables.sponsors.edit-tier %}
|
||||
{% data reusables.sponsors.tier-price-description %}
|
||||
{% data reusables.sponsors.tier-update %}
|
||||
{% data reusables.sponsors.retire-tier %}
|
||||
|
||||
### Editing or retiring a tier for your sponsored organization profile
|
||||
|
||||
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsor-tiers-tab %}
|
||||
{% data reusables.sponsors.edit-tier %}
|
||||
{% data reusables.sponsors.tier-price-description %}
|
||||
{% data reusables.sponsors.tier-update %}
|
||||
{% data reusables.sponsors.retire-tier %}
|
||||
{% data reusables.sponsors.retire-tier %}
|
||||
@@ -5,11 +5,13 @@ versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
To monitor changes to your sponsorships, such as cancellations at the end of a pay period, you can create webhooks for your sponsored user or organization account. When you set up a webhook for your sponsored user or organization account, you'll receive updates when sponsorships are created, edited, or deleted. For more information, see the [`sponsorship` webhook event](/webhooks/event-payloads/#sponsorship).
|
||||
### About webhooks for events in your sponsored account
|
||||
|
||||
### Managing webhooks for your sponsored user account
|
||||
To monitor changes to your sponsorships, such as cancellations at the end of a pay period, you can create webhooks for your sponsored user or organization account. When you set up a webhook for your sponsored account, you'll receive updates when sponsorships are created, edited, or deleted. For more information, see the [`sponsorship` webhook event](/webhooks/event-payloads/#sponsorship).
|
||||
|
||||
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
|
||||
### Managing webhooks for events in your sponsored account
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-webhooks-tab %}
|
||||
{% data reusables.sponsors.add-webhook %}
|
||||
{% data reusables.sponsors.add-payload-url %}
|
||||
@@ -17,18 +19,4 @@ To monitor changes to your sponsorships, such as cancellations at the end of a p
|
||||
{% data reusables.sponsors.webhook-secret-token %}
|
||||
{% data reusables.sponsors.add-active-triggers %}
|
||||
{% data reusables.sponsors.confirm-add-webhook %}
|
||||
{% data reusables.sponsors.manage-existing-webhooks %}
|
||||
|
||||
### Managing webhooks for your sponsored organization
|
||||
|
||||
Organization owners can configure webhooks for a sponsored organization.
|
||||
|
||||
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-webhooks-tab %}
|
||||
{% data reusables.sponsors.add-webhook %}
|
||||
{% data reusables.sponsors.add-payload-url %}
|
||||
{% data reusables.sponsors.webhook-content-formatting %}
|
||||
{% data reusables.sponsors.webhook-secret-token %}
|
||||
{% data reusables.sponsors.add-active-triggers %}
|
||||
{% data reusables.sponsors.confirm-add-webhook %}
|
||||
{% data reusables.sponsors.manage-existing-webhooks %}
|
||||
{% data reusables.sponsors.manage-existing-webhooks %}
|
||||
@@ -7,22 +7,15 @@ versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
### About sponsorship updates
|
||||
|
||||
Your sponsors can choose whether they receive email updates about your work. For more information, see "[Managing your sponsorship](/articles/managing-your-sponsorship)."
|
||||
|
||||
The update will come from your user account's primary email address or organization account's `noreply@github.com` email address. If you've enabled email address privacy on your user account, the update will come from `noreply@github.com` instead. For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)."
|
||||
For sponsored developer accounts, the update will come from your user account's primary email address. If you've enabled email address privacy on your user account, the update will come from `noreply@github.com` instead. For sponsored organizations, the update will come from the organization's `noreply@github.com` email address. For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)."
|
||||
|
||||
### Contacting your user account's sponsors
|
||||
### Contacting your sponsors
|
||||
|
||||
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.sponsors-updates-tab %}
|
||||
{% data reusables.sponsors.draft-new-update %}
|
||||
{% data reusables.sponsors.send-update-to-sponsors %}
|
||||
{% data reusables.sponsors.write-sponsor-update %}
|
||||
{% data reusables.sponsors.publish-sponsor-update %}
|
||||
|
||||
### Contacting your organization's sponsors
|
||||
|
||||
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.sponsors-updates-tab %}
|
||||
{% data reusables.sponsors.draft-new-update %}
|
||||
{% data reusables.sponsors.send-update-to-sponsors %}
|
||||
|
||||
@@ -10,30 +10,17 @@ versions:
|
||||
|
||||
### About sponsor profiles
|
||||
|
||||
Your {% data variables.product.prodname_sponsors %} profile tells potential sponsors why they should support you. People see your sponsor profile when they click the **Sponsor** button on your personal or organization profile. We recommend including the following information.
|
||||
Your {% data variables.product.prodname_sponsors %} profile tells potential sponsors why they should support you. People see your sponsor profile when they click the **Sponsor** button on your profile. We recommend including the following information.
|
||||
|
||||
- Open source work that you contribute to.
|
||||
- Why you are committed to open source development.
|
||||
- Open source work that you contribute to
|
||||
- Why you are committed to open source development
|
||||
|
||||
You can also set goals to explain what different of levels of sponsorship will allow you to do for the community.
|
||||
### Editing your profile details
|
||||
|
||||
### Editing your sponsored developer profile
|
||||
|
||||
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-profile-tab %}
|
||||
{% data reusables.sponsors.short-bio %}
|
||||
{% data reusables.sponsors.add-introduction %}
|
||||
{% data reusables.sponsors.edit-featured-work %}
|
||||
{% data reusables.sponsors.opt-in-to-being-featured %}
|
||||
{% data reusables.sponsors.save-profile %}
|
||||
|
||||
### Editing your sponsored organization profile
|
||||
|
||||
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-profile-tab %}
|
||||
{% data reusables.sponsors.short-bio %}
|
||||
{% data reusables.sponsors.add-introduction %}
|
||||
{% data reusables.sponsors.meet-the-team %}
|
||||
{% data reusables.sponsors.edit-featured-work %}
|
||||
{% data reusables.sponsors.opt-in-to-being-featured %}
|
||||
{% data reusables.sponsors.save-profile %}
|
||||
{% data reusables.sponsors.save-profile %}
|
||||
@@ -16,6 +16,7 @@ versions:
|
||||
{% topic_link_in_list /sponsoring-open-source-contributors %}
|
||||
{% link_in_list /sponsoring-an-open-source-contributor %}
|
||||
{% link_in_list /managing-your-sponsorship %}
|
||||
{% link_in_list /attributing-sponsorships-to-your-organization %}
|
||||
{% topic_link_in_list /receiving-sponsorships-through-github-sponsors %}
|
||||
{% link_in_list /about-github-sponsors-for-open-source-contributors %}
|
||||
{% link_in_list /setting-up-github-sponsors-for-your-user-account %}
|
||||
|
||||
@@ -13,14 +13,8 @@ You can only manage your payouts from {% data variables.product.prodname_sponsor
|
||||
|
||||
{% data reusables.sponsors.payout-info %}
|
||||
|
||||
### Viewing and editing payout information for your sponsored user account
|
||||
### Viewing and editing payout information
|
||||
|
||||
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-payouts-tab %}
|
||||
{% data reusables.sponsors.edit-bank-information %}
|
||||
|
||||
### Viewing and editing payout information for your sponsored organization
|
||||
|
||||
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-payouts-tab %}
|
||||
{% data reusables.sponsors.edit-bank-information %}
|
||||
{% data reusables.sponsors.edit-bank-information %}
|
||||
@@ -1,27 +1,19 @@
|
||||
---
|
||||
title: Managing your sponsorship goal
|
||||
intro: You can set a goal for your sponsored developer or sponsored organization profile to help the community understand the impact of sponsoring you.
|
||||
intro: You can set a goal for your sponsored developer or sponsored organization account to help the community understand the impact of sponsoring you.
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
### About sponsorship goals
|
||||
|
||||
You can set a funding goal for your sponsored developer or organization profile and share the goal with your community. Goals help you understand the impact you have in the open source community and build up your presence in the {% data variables.product.prodname_sponsors %} program.
|
||||
You can set a funding goal for your sponsored account and share the goal with your community. Goals help you understand the impact you have in the open source community and build up your presence in the {% data variables.product.prodname_sponsors %} program.
|
||||
|
||||
Your goal can set a target for the number of sponsors you want to have or the amount of money you want to earn each month. You can only set one goal up at a time. After you reach a goal, you can set another goal.
|
||||
|
||||
### Setting a goal for a sponsored organization
|
||||
### Setting a goal
|
||||
|
||||
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-your-goals-tab %}
|
||||
{% data reusables.sponsors.set-a-goal %}
|
||||
{% data reusables.sponsors.select-goal-type %}
|
||||
{% data reusables.sponsors.publish-goal %}
|
||||
|
||||
### Setting a goal for a sponsored developer
|
||||
|
||||
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-your-goals-tab %}
|
||||
{% data reusables.sponsors.set-a-goal %}
|
||||
{% data reusables.sponsors.select-goal-type %}
|
||||
@@ -31,6 +23,7 @@ Your goal can set a target for the number of sponsors you want to have or the am
|
||||
|
||||
When you edit a goal, you can't choose a goal you've already achieved. For example, if you already have 5 sponsors, you can't edit your goal so that you're aiming for 4 sponsors.
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-your-goals-tab %}
|
||||
{% data reusables.sponsors.edit-goal %}
|
||||
{% data reusables.sponsors.select-goal-type %}
|
||||
@@ -40,6 +33,7 @@ When you edit a goal, you can't choose a goal you've already achieved. For examp
|
||||
|
||||
After you retire a goal, you won't be able to reactivate the goal. You must create a new goal instead.
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-your-goals-tab %}
|
||||
{% data reusables.sponsors.edit-goal %}
|
||||
{% data reusables.sponsors.retire-goal %}
|
||||
|
||||
@@ -1,42 +1,35 @@
|
||||
---
|
||||
title: Managing your sponsorship
|
||||
intro: You can manage who can see your sponsorship and whether you receive email updates from the sponsored open source contributor.
|
||||
intro: You can manage who can see your sponsorship and whether you receive email updates from the sponsored account.
|
||||
redirect_from:
|
||||
- /articles/managing-your-sponsorship
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
For information about changing your sponsorship tier, see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)."
|
||||
{% data reusables.sponsors.org-sponsors-release-phase %}
|
||||
|
||||
### Managing the privacy setting for your developer sponsorship
|
||||
### Managing the privacy setting for your sponsorship
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsored-developer %}
|
||||
{% data reusables.sponsors.manage-developer-sponsorship %}
|
||||
{% data reusables.sponsors.navigate-to-sponsored-account %}
|
||||
{% data reusables.sponsors.sponsorship-dashboard %}
|
||||
{% data reusables.sponsors.manage-sponsorship %}
|
||||
{% data reusables.sponsors.who-can-see-your-sponsorship %}
|
||||
{% data reusables.sponsors.update-sponsorship %}
|
||||
|
||||
### Managing the privacy setting for your organization sponsorship
|
||||
### Managing email updates for your sponsorship
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsored-org %}
|
||||
{% data reusables.sponsors.manage-org-sponsorship %}
|
||||
{% data reusables.sponsors.who-can-see-your-sponsorship %}
|
||||
You can choose whether an account you sponsor can send you email updates about their work. The sponsored account will not have access to your email address.
|
||||
|
||||
{% data reusables.sponsors.manage-updates-for-orgs %}
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsored-account %}
|
||||
{% data reusables.sponsors.sponsorship-dashboard %}
|
||||
{% data reusables.sponsors.manage-sponsorship %}
|
||||
{% data reusables.sponsors.choose-updates %}
|
||||
{% data reusables.sponsors.update-sponsorship %}
|
||||
|
||||
### Managing email updates from a sponsored developer
|
||||
### Further reading
|
||||
|
||||
You can choose whether a sponsored developer can send you email updates about their work. The sponsored developer will not have access to your email address.
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsored-developer %}
|
||||
{% data reusables.sponsors.manage-developer-sponsorship %}
|
||||
{% data reusables.sponsors.developer-sponsored-choose-updates %}
|
||||
{% data reusables.sponsors.update-sponsorship %}
|
||||
|
||||
### Managing email updates from a sponsored organization
|
||||
|
||||
You can choose whether a sponsored organization can send you email updates about their work. The sponsored organization will not have access to your email address.
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsored-org %}
|
||||
{% data reusables.sponsors.manage-org-sponsorship %}
|
||||
{% data reusables.sponsors.org-sponsored-choose-updates %}
|
||||
{% data reusables.sponsors.update-sponsorship %}
|
||||
- "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)"
|
||||
- "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)"
|
||||
@@ -25,7 +25,7 @@ To join {% data variables.product.prodname_sponsors %} as an individual contribu
|
||||
|
||||
### Completing your sponsored organization profile
|
||||
|
||||
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-profile-tab %}
|
||||
{% data reusables.sponsors.short-bio %}
|
||||
{% data reusables.sponsors.add-introduction %}
|
||||
@@ -40,7 +40,7 @@ To join {% data variables.product.prodname_sponsors %} as an individual contribu
|
||||
|
||||
{% data reusables.sponsors.maximum-tier %}
|
||||
|
||||
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsor-tiers-tab %}
|
||||
{% data reusables.sponsors.click-add-tier %}
|
||||
{% data reusables.sponsors.tier-price-description %}
|
||||
@@ -54,7 +54,7 @@ As a sponsored organization, you must receive payouts to a dedicated bank accoun
|
||||
|
||||
{% data reusables.sponsors.double-check-stripe-info %}
|
||||
|
||||
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.create-stripe-account %}
|
||||
|
||||
For more information about setting up Stripe Connect using Open Collective, see [Setting up {% data variables.product.prodname_sponsors %}](https://docs.opencollective.com/help/collectives/github-sponsors) in the Open Collective Docs.
|
||||
@@ -63,7 +63,7 @@ For more information about setting up Stripe Connect using Open Collective, see
|
||||
|
||||
{% data reusables.sponsors.tax-form-information-org %}
|
||||
|
||||
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.settings-tab %}
|
||||
{% data reusables.sponsors.country-of-residence %}
|
||||
{% data reusables.sponsors.overview-tab %}
|
||||
@@ -75,7 +75,7 @@ Before your organization can become a sponsored organization, you must enable 2F
|
||||
|
||||
### Submitting your application to {% data variables.product.prodname_dotcom %} for approval
|
||||
|
||||
{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.request-approval %}
|
||||
|
||||
{% data reusables.sponsors.github-review-app %}
|
||||
|
||||
@@ -26,7 +26,7 @@ If you have a bank account in a supported region, {% data variables.product.prod
|
||||
|
||||
After {% data variables.product.prodname_dotcom %} reviews your application, you can set up your sponsored developer profile so that people can start sponsoring you.
|
||||
|
||||
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-profile-tab %}
|
||||
{% data reusables.sponsors.short-bio %}
|
||||
{% data reusables.sponsors.add-introduction %}
|
||||
@@ -40,7 +40,7 @@ After {% data variables.product.prodname_dotcom %} reviews your application, you
|
||||
|
||||
{% data reusables.sponsors.maximum-tier %}
|
||||
|
||||
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsor-tiers-tab %}
|
||||
{% data reusables.sponsors.click-add-tier %}
|
||||
{% data reusables.sponsors.tier-price-description %}
|
||||
@@ -54,14 +54,14 @@ If you live in a supported region, you can follow these instructions to submit y
|
||||
|
||||
{% data reusables.sponsors.double-check-stripe-info %}
|
||||
|
||||
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.create-stripe-account %}
|
||||
|
||||
### Submitting your tax information
|
||||
|
||||
{% data reusables.sponsors.tax-form-information-dev %}
|
||||
|
||||
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.settings-tab %}
|
||||
{% data reusables.sponsors.country-of-residence %}
|
||||
{% data reusables.sponsors.overview-tab %}
|
||||
@@ -73,7 +73,7 @@ Before you can become a sponsored developer, you must enable 2FA on your {% data
|
||||
|
||||
### Submitting your application to {% data variables.product.prodname_dotcom %} for approval
|
||||
|
||||
{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
4. Click **Request approval**.
|
||||

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

|
||||
1. On {% data variables.product.product_name %}, navigate to the profile of the user or organization you want to sponsor.
|
||||
1. Navigate to your sponsorship dashboard for the account.
|
||||
- To sponsor a developer, under the developer's name, click **Sponsor**.
|
||||

|
||||
- To sponsor an organization, to the right of the the organization's name, click **Sponsor**.
|
||||

|
||||
1. Optionally, on the right side of the page, to sponsor the account on behalf of your organization, use the **Sponsor as** drop-down menu, and click the organization.
|
||||

|
||||
{% data reusables.sponsors.select-a-tier %}
|
||||
{% data reusables.sponsors.pay-prorated-amount %}
|
||||
{% data reusables.sponsors.select-sponsorship-billing %}
|
||||

|
||||
{% data reusables.sponsors.who-can-see-your-sponsorship %}
|
||||

|
||||
{% data reusables.sponsors.developer-sponsored-choose-updates %}
|
||||
7. Click **Sponsor _DEVELOPER_**.
|
||||

|
||||
|
||||
### Sponsoring an organization
|
||||
|
||||
Before you can sponsor an organization, you must have a verified email address. For more information, see "[Verifying your email address](/github/getting-started-with-github/verifying-your-email-address)."
|
||||
|
||||
1. On {% data variables.product.product_name %}, navigate to the page of the organization you want to sponsor.
|
||||
2. Next to the organization's name, click **Sponsor**.
|
||||

|
||||
{% data reusables.sponsors.select-a-tier %}
|
||||
{% data reusables.sponsors.select-sponsorship-billing %}
|
||||

|
||||
{% data reusables.sponsors.who-can-see-your-sponsorship %}
|
||||

|
||||
{% data reusables.sponsors.org-sponsored-choose-updates %}
|
||||
7. Click **Sponsor _ORGANIZATION_**.
|
||||

|
||||
{% data reusables.sponsors.choose-updates %}
|
||||
{% data reusables.sponsors.sponsor-account %}
|
||||
|
||||
@@ -7,40 +7,29 @@ versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
### About sponsors and sponsorships
|
||||
|
||||
You can view analytics on your current and past sponsorships, the payments you've received from sponsors, and events, such as cancellations and sponsor tier changes for your sponsorships. You can also view activity such as new sponsorships, changes to sponsorships, and canceled sponsorships. You can filter the list of activities by date. You can also export sponsorship data for the account you're viewing in CSV or JSON format.
|
||||
|
||||
You access all of this information from your Sponsors dashboard.
|
||||
|
||||
### Viewing your Sponsors dashboard
|
||||
|
||||
1. In the upper-right corner of any page, click your profile photo, then click **{% data variables.product.prodname_sponsors %}**.
|
||||

|
||||
2. In the list that's displayed, to the right of the account or organization whose Sponsors dashboard you want to view, click **Dashboard**.
|
||||

|
||||
|
||||
### Viewing your sponsors and sponsorships
|
||||
|
||||
1. Go to your Sponsors dashboard, see [Viewing your Sponsors dashboard](#viewing-your-sponsors-dashboard).
|
||||
{% data reusables.sponsors.navigate-to-sponsors-tab %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
1. Optionally, to filter your sponsors by tier, use the **Filter** drop-down menu, click **Active tiers** or **Retired tiers**, and select a tier.
|
||||

|
||||
|
||||
### Viewing recent sponsorship activity
|
||||
|
||||
1. Go to your Sponsors dashboard, see [Viewing your Sponsors dashboard](#viewing-your-sponsors-dashboard).
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
1. In the left sidebar, click **Activity**.
|
||||

|
||||
|
||||
### Exporting your sponsorship data
|
||||
|
||||
1. Go to your Sponsors dashboard, see [Viewing your Sponsors dashboard](#viewing-your-sponsors-dashboard).
|
||||
If you have sponsors, you can export your sponsorship data. {% data variables.product.prodname_dotcom %} will send you an email with export data for all of your sponsors for the month you select. After the export is complete, you can export another month of data. You can export up to 10 sets of data per hour for any of your sponsored accounts.
|
||||
|
||||
{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
|
||||
{% data reusables.sponsors.navigate-to-sponsors-tab %}
|
||||
1. Click **Export all**.
|
||||

|
||||
|
||||
This button is not displayed if you don't have any sponsors.
|
||||
|
||||
1. Choose a timeframe and a format for the data you'd like to export, then click **Start export**.
|
||||

|
||||
|
||||
{% data variables.product.prodname_dotcom %} starts exporting data for all of your sponsors for the month you selected. You'll be emailed shortly with an attachment containing the data. After the export is complete you can export another month of data. You can export up to 10 sets of data an hour for any of your sponsored organizations or user accounts.
|
||||

|
||||
@@ -21,6 +21,10 @@ The dependency graph is a summary of the manifest and lock files stored in a rep
|
||||
|
||||
When you push a commit to {% data variables.product.product_name %} that changes or adds a supported manifest or lock file to the default branch, the dependency graph is automatically updated.{% if currentVersion == "free-pro-team@latest" %} In addition, the graph is updated when anyone pushes a change to the repository of one of your dependencies.{% endif %} For information on the supported ecosystems and manifest files, see "[Supported package ecosystems](#supported-package-ecosystems)" below.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
When you create a pull request containing changes to dependencies that targets the default branch, {% data variables.product.prodname_dotcom %} uses the dependency graph to add dependency reviews to the pull request. These indicate whether the dependencies contain vulnerabilities and, if so, the version of the dependency in which the vulnerability was fixed. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)."
|
||||
{% endif %}
|
||||
|
||||
### Dependencies included
|
||||
|
||||
The dependency graph includes all the dependencies of a repository that are detailed in the manifest and lock files, or their equivalent, for supported ecosystems. This includes:
|
||||
@@ -41,7 +45,8 @@ You can use the dependency graph to:
|
||||
|
||||
- Explore the repositories your code depends on{% if currentVersion == "free-pro-team@latest" %}, and those that depend on it{% endif %}. For more information, see "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)." {% if currentVersion == "free-pro-team@latest" %}
|
||||
- View a summary of the dependencies used in your organization's repositories in a single dashboard. For more information, see "[Viewing insights for your organization](/articles/viewing-insights-for-your-organization#viewing-organization-dependency-insights)."{% endif %}
|
||||
- View and update vulnerable dependencies for your repository. The dependency graph lists vulnerable dependencies before other dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
- View and update vulnerable dependencies for your repository. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."{% if currentVersion == "free-pro-team@latest" %}
|
||||
- See information about vulnerable dependencies in pull requests. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)."{% endif %}
|
||||
|
||||
### Enabling the dependency graph
|
||||
|
||||
|
||||
@@ -1,58 +0,0 @@
|
||||
---
|
||||
title: About GitHub Container Registry
|
||||
intro: 'The {% data variables.product.prodname_github_container_registry %} allows you to seamlessly host and manage Docker container images in your organization or personal user account on {% data variables.product.prodname_dotcom %}. {% data variables.product.prodname_github_container_registry %} allows you to configure who can manage and access packages using fine-grained permissions.'
|
||||
product: '{% data reusables.gated-features.packages %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** {% data variables.product.prodname_github_container_registry %} is currently in public beta and subject to change. During the beta, storage and bandwidth are free. To use {% data variables.product.prodname_github_container_registry %}, you must enable the feature for your account. For more information, see "[Enabling improved container support](/packages/getting-started-with-github-container-registry/enabling-improved-container-support)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% data reusables.package_registry.container-registry-feature-highlights %}
|
||||
|
||||
To share context about your package's use, you can link a repository to your container image on {% data variables.product.prodname_dotcom %}. For more information, see "[Connecting a repository to a container image](/packages/managing-container-images-with-github-container-registry/connecting-a-repository-to-a-container-image)."
|
||||
|
||||
### Supported formats
|
||||
|
||||
The {% data variables.product.prodname_container_registry %} currently supports the following container image formats:
|
||||
|
||||
* [Docker Image Manifest V2, Schema 2](https://docs.docker.com/registry/spec/manifest-v2-2/)
|
||||
* [Open Container Initiative (OCI) Specifications](https://github.com/opencontainers/image-spec)
|
||||
|
||||
#### Manifest Lists/Image Indexes
|
||||
|
||||
{% data variables.product.prodname_github_container_registry %} also supports [Docker Manifest List](https://docs.docker.com/registry/spec/manifest-v2-2/#manifest-list)/[OCI Image Index](https://github.com/opencontainers/image-spec/blob/79b036d80240ae530a8de15e1d21c7ab9292c693/image-index.md) formats which are defined in the Docker V2, Schema 2 and OCI image specifications.
|
||||
|
||||
### Visibility and access permissions for container images
|
||||
|
||||
If you have admin permissions to a container image, you can set the container image to private or public. Public images allow anonymous access and can be pulled without authentication or signing in via the CLI.
|
||||
|
||||
As an admin, you can also grant access permissions for a container image that are separate from the permissions you've set at the organization and repository levels.
|
||||
|
||||
For container images published and owned by a user account, you can give any person an access role. For container images published and owned by an organization, you can give any person or team in the organization an access role.
|
||||
|
||||
| Permission role | Access description |
|
||||
|-----|----|
|
||||
| Read | Can download package. <br> Can read package metadata. |
|
||||
| Write | Can upload and download this package. <br> Can read and write package metadata. |
|
||||
| Admin | Can upload, download, delete, and manage this package. <br> Can read and write package metadata. <br> Can grant package permissions.
|
||||
|
||||
For more information, see "[Configuring access control and visibility for container images](/packages/managing-container-images-with-github-container-registry/configuring-access-control-and-visibility-for-container-images)."
|
||||
|
||||
### About billing for {% data variables.product.prodname_github_container_registry %}
|
||||
|
||||
{% data reusables.package_registry.billing-for-container-registry %}
|
||||
|
||||
### Contacting support
|
||||
|
||||
If you have feedback or feature requests for {% data variables.product.prodname_github_container_registry %}, use the [feedback form](https://support.github.com/contact/feedback?contact%5Bcategory%5D=packages).
|
||||
|
||||
Contact {% data variables.contact.github_support %} about {% data variables.product.prodname_github_container_registry %} using [our contact form](https://support.github.com/contact?form%5Bsubject%5D=Re:%20GitHub%20Packages) if:
|
||||
|
||||
* You experience anything that contradicts the documentation.
|
||||
* You encounter vague or unclear errors.
|
||||
* Your published package contains sensitive data, such as GDPR violations, API Keys, or personally-identifying information.
|
||||
@@ -1,15 +0,0 @@
|
||||
---
|
||||
title: Getting started with GitHub Container Registry
|
||||
intro: 'Learn about {% data variables.product.prodname_container_registry %} concepts and how to migrate your Docker images from {% data variables.product.prodname_registry %}.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
{% data reusables.package_registry.container-registry-beta %}
|
||||
|
||||
{% link_in_list /about-github-container-registry %}
|
||||
{% link_in_list /enabling-improved-container-support %}
|
||||
{% link_in_list /core-concepts-for-github-container-registry %}
|
||||
{% link_in_list /migrating-to-github-container-registry-for-docker-images %}
|
||||
|
||||
For more information about configuring, deleting, pushing, or pulling container images, see "[Managing container images with {% data variables.product.prodname_github_container_registry %}](/packages/managing-container-images-with-github-container-registry)."
|
||||
95
content/packages/guides/about-github-container-registry.md
Normal file
@@ -0,0 +1,95 @@
|
||||
---
|
||||
title: About GitHub Container Registry
|
||||
intro: 'You can use {% data variables.product.prodname_github_container_registry %} to seamlessly host and manage Docker container images in your organization or personal user account on {% data variables.product.prodname_dotcom %}. {% data variables.product.prodname_github_container_registry %} allows you to configure who can manage and access packages using fine-grained permissions.'
|
||||
product: '{% data reusables.gated-features.packages %}'
|
||||
redirect_from:
|
||||
- /packages/getting-started-with-github-container-registry/about-github-container-registry
|
||||
- /packages/managing-container-images-with-github-container-registry
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** {% data variables.product.prodname_github_container_registry %} is currently in public beta and subject to change. During the beta, storage and bandwidth are free. To use {% data variables.product.prodname_github_container_registry %}, you must enable the feature for your account. For more information, see "[Enabling improved container support](/packages/guides/enabling-improved-container-support)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
### About {% data variables.product.prodname_github_container_registry %}
|
||||
|
||||
{% data reusables.package_registry.container-registry-feature-highlights %}
|
||||
|
||||
To share context about your package's use, you can link a repository to your container image on {% data variables.product.prodname_dotcom %}. For more information, see "[Connecting a repository to a container image](/packages/guides/connecting-a-repository-to-a-container-image)."
|
||||
|
||||
{% data variables.product.prodname_github_container_registry %} has different hosting locations, permission, and visibility than other package registries.
|
||||
|
||||
| | Package registries | {% data variables.product.prodname_github_container_registry %} |
|
||||
|----|----|----|
|
||||
| Hosting locations | You can host multiple packages in one repository. | You can host multiple container images in one organization or user account. |
|
||||
| Permissions | Each package inherits the permissions of the repository where the package is hosted. <br> <br> For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version. | For each container image, you can choose the access level that others have. The permissions for container image access are separate from your organization and repository permissions.
|
||||
Visibility | {% data reusables.package_registry.public-or-private-packages %} | You can set the visibility of each of your container images. A private container image is only visible to people and teams who are given access within your organization. A public container image is visible to anyone. |
|
||||
Anonymous access | N/A | You can access public container images anonymously.
|
||||
|
||||
For more information, see "[About scopes and permissions for {% data variables.product.prodname_github_container_registry %}](#about-scopes-and-permissions-for-github-container-registry)."
|
||||
|
||||
### Supported formats
|
||||
|
||||
The {% data variables.product.prodname_container_registry %} currently supports the following container image formats:
|
||||
|
||||
* [Docker Image Manifest V2, Schema 2](https://docs.docker.com/registry/spec/manifest-v2-2/)
|
||||
* [Open Container Initiative (OCI) Specifications](https://github.com/opencontainers/image-spec)
|
||||
|
||||
The {% data variables.product.prodname_github_container_registry %} hosts containers at `ghcr.io/OWNER/IMAGE-NAME`.
|
||||
|
||||
| Package client | Language | Package format | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| Docker CLI | N/A | `Dockerfile` | Docker container support. |
|
||||
|
||||
|
||||
#### Manifest Lists/Image Indexes
|
||||
|
||||
{% data variables.product.prodname_github_container_registry %} also supports [Docker Manifest List](https://docs.docker.com/registry/spec/manifest-v2-2/#manifest-list)/[OCI Image Index](https://github.com/opencontainers/image-spec/blob/79b036d80240ae530a8de15e1d21c7ab9292c693/image-index.md) formats which are defined in the Docker V2, Schema 2 and OCI image specifications.
|
||||
|
||||
### Visibility and access permissions for container images
|
||||
|
||||
If you have admin permissions to a container image, you can set the container image to private or public. Public images allow anonymous access and can be pulled without authentication or signing in via the CLI.
|
||||
|
||||
As an admin, you can also grant access permissions for a container image that are separate from the permissions you've set at the organization and repository levels.
|
||||
|
||||
For container images published and owned by a user account, you can give any person an access role. For container images published and owned by an organization, you can give any person or team in the organization an access role.
|
||||
|
||||
| Permission role | Access description |
|
||||
|-----|----|
|
||||
| Read | Can download package. <br> Can read package metadata. |
|
||||
| Write | Can upload and download this package. <br> Can read and write package metadata. |
|
||||
| Admin | Can upload, download, delete, and manage this package. <br> Can read and write package metadata. <br> Can grant package permissions.
|
||||
|
||||
For more information, see "[Configuring access control and visibility for container images](/packages/guides/configuring-access-control-and-visibility-for-container-images)."
|
||||
|
||||
### About scopes and permissions for {% data variables.product.prodname_github_container_registry %}
|
||||
|
||||
To use or manage a package hosted by a package registry, you must use a token with the appropriate scope, and your user account must have appropriate permissions for that repository.
|
||||
|
||||
| Scope | Description |
|
||||
| --- | --- |
|
||||
|`read:packages`| Download and install container images from {% data variables.product.prodname_github_container_registry %} |
|
||||
|`write:packages`| Upload and publish container images to {% data variables.product.prodname_github_container_registry %} |
|
||||
| `delete:packages` | Delete specified versions of private or public container images from {% data variables.product.prodname_github_container_registry %}. For more information, see "[Deleting a container image](/packages/guides/deleting-a-container-image)." |
|
||||
|
||||
To learn about available scopes and permissions for container images, see "[Configuring access control and visibility for container images](/packages/guides/configuring-access-control-and-visibility-for-container-images)."
|
||||
|
||||
For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token/)" and "[Available scopes](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes)."
|
||||
|
||||
### About billing for {% data variables.product.prodname_github_container_registry %}
|
||||
|
||||
{% data reusables.package_registry.billing-for-container-registry %}
|
||||
|
||||
### Contacting support
|
||||
|
||||
If you have feedback or feature requests for {% data variables.product.prodname_github_container_registry %}, use the [feedback form](https://support.github.com/contact/feedback?contact%5Bcategory%5D=packages).
|
||||
|
||||
Contact {% data variables.contact.github_support %} about {% data variables.product.prodname_github_container_registry %} using [our contact form](https://support.github.com/contact?form%5Bsubject%5D=Re:%20GitHub%20Packages) if:
|
||||
|
||||
* You experience anything that contradicts the documentation.
|
||||
* You encounter vague or unclear errors.
|
||||
* Your published package contains sensitive data, such as GDPR violations, API Keys, or personally-identifying information.
|
||||
@@ -2,6 +2,8 @@
|
||||
title: Configuring access control and visibility for container images
|
||||
intro: 'Choose who has read, write, or admin access to your container image and the visibility of your container images on {% data variables.product.prodname_dotcom %}.'
|
||||
product: '{% data reusables.gated-features.packages %}'
|
||||
redirect_from:
|
||||
- /packages/managing-container-images-with-github-container-registry/configuring-access-control-and-visibility-for-container-images
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /articles/configuring-apache-maven-for-use-with-github-package-registry
|
||||
- /github/managing-packages-with-github-package-registry/configuring-apache-maven-for-use-with-github-package-registry
|
||||
- /github/managing-packages-with-github-packages/configuring-apache-maven-for-use-with-github-packages
|
||||
- /packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=2.22'
|
||||
@@ -188,5 +189,5 @@ To install an Apache Maven package from {% data variables.product.prodname_regis
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Configuring Gradle for use with {% data variables.product.prodname_registry %}](/packages/using-github-packages-with-your-projects-ecosystem/configuring-gradle-for-use-with-github-packages)"
|
||||
- "[Deleting a package](/packages/publishing-and-managing-packages/deleting-a-package/)"
|
||||
- "[Configuring Gradle for use with {% data variables.product.prodname_registry %}](/packages/guides/configuring-gradle-for-use-with-github-packages)"
|
||||
- "[Deleting a package](/packages/manage-packages/deleting-a-package/)"
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /articles/configuring-docker-for-use-with-github-package-registry
|
||||
- /github/managing-packages-with-github-package-registry/configuring-docker-for-use-with-github-package-registry
|
||||
- /github/managing-packages-with-github-packages/configuring-docker-for-use-with-github-packages
|
||||
- /packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=2.22'
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /github/managing-packages-with-github-package-registry/configuring-nuget-for-use-with-github-package-registry
|
||||
- /github/managing-packages-with-github-packages/configuring-nuget-for-use-with-github-packages
|
||||
- /github/managing-packages-with-github-packages/configuring-dotnet-cli-for-use-with-github-packages
|
||||
- /packages/using-github-packages-with-your-projects-ecosystem/configuring-dotnet-cli-for-use-with-github-packages
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=2.22'
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /articles/configuring-gradle-for-use-with-github-package-registry
|
||||
- /github/managing-packages-with-github-package-registry/configuring-gradle-for-use-with-github-package-registry
|
||||
- /github/managing-packages-with-github-packages/configuring-gradle-for-use-with-github-packages
|
||||
- /packages/using-github-packages-with-your-projects-ecosystem/configuring-gradle-for-use-with-github-packages
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=2.22'
|
||||