diff --git a/assets/images/help/images/overview-actions-result-navigate.png b/assets/images/help/images/overview-actions-result-navigate.png new file mode 100644 index 000000000000..819f0e75e7f3 Binary files /dev/null and b/assets/images/help/images/overview-actions-result-navigate.png differ diff --git a/assets/images/help/images/overview-actions-result-updated-2.png b/assets/images/help/images/overview-actions-result-updated-2.png new file mode 100644 index 000000000000..7035583127a4 Binary files /dev/null and b/assets/images/help/images/overview-actions-result-updated-2.png differ diff --git a/assets/images/help/images/workflow-graph-job.png b/assets/images/help/images/workflow-graph-job.png new file mode 100644 index 000000000000..7aafcb5d8992 Binary files /dev/null and b/assets/images/help/images/workflow-graph-job.png differ diff --git a/assets/images/help/images/workflow-graph.png b/assets/images/help/images/workflow-graph.png new file mode 100644 index 000000000000..ebd1b6a07ce7 Binary files /dev/null and b/assets/images/help/images/workflow-graph.png differ diff --git a/assets/images/help/organizations/update-profile-button.png b/assets/images/help/organizations/update-profile-button.png new file mode 100644 index 000000000000..bb701e7aed17 Binary files /dev/null and b/assets/images/help/organizations/update-profile-button.png differ diff --git a/assets/images/help/pull_requests/dependency-review-rich-diff.png b/assets/images/help/pull_requests/dependency-review-rich-diff.png new file mode 100644 index 000000000000..dd782e316888 Binary files /dev/null and b/assets/images/help/pull_requests/dependency-review-rich-diff.png differ diff --git a/assets/images/help/pull_requests/dependency-review-source-diff.png b/assets/images/help/pull_requests/dependency-review-source-diff.png new file mode 100644 index 000000000000..aa5e394d8128 Binary files /dev/null and b/assets/images/help/pull_requests/dependency-review-source-diff.png differ diff --git a/assets/images/help/pull_requests/dependency-review-vulnerability.png b/assets/images/help/pull_requests/dependency-review-vulnerability.png new file mode 100644 index 000000000000..9e69c9d0d5ea Binary files /dev/null and b/assets/images/help/pull_requests/dependency-review-vulnerability.png differ diff --git a/assets/images/help/pull_requests/file-filter-menu-json.png b/assets/images/help/pull_requests/file-filter-menu-json.png new file mode 100644 index 000000000000..f37475293bd2 Binary files /dev/null and b/assets/images/help/pull_requests/file-filter-menu-json.png differ diff --git a/assets/images/help/pull_requests/pull-request-tabs-changed-files.png b/assets/images/help/pull_requests/pull-request-tabs-changed-files.png index a5ca74c433be..34f5f6fc16df 100644 Binary files a/assets/images/help/pull_requests/pull-request-tabs-changed-files.png and b/assets/images/help/pull_requests/pull-request-tabs-changed-files.png differ diff --git a/assets/images/help/repository/actions-delete-artifact-updated.png b/assets/images/help/repository/actions-delete-artifact-updated.png new file mode 100644 index 000000000000..b84fc77bd482 Binary files /dev/null and b/assets/images/help/repository/actions-delete-artifact-updated.png differ diff --git a/assets/images/help/repository/actions-failed-pester-test-updated.png b/assets/images/help/repository/actions-failed-pester-test-updated.png new file mode 100644 index 000000000000..022a0a5370ef Binary files /dev/null and b/assets/images/help/repository/actions-failed-pester-test-updated.png differ diff --git a/assets/images/help/repository/artifact-drop-down-updated.png b/assets/images/help/repository/artifact-drop-down-updated.png new file mode 100644 index 000000000000..6ddc426fec81 Binary files /dev/null and b/assets/images/help/repository/artifact-drop-down-updated.png differ diff --git a/assets/images/help/repository/cancel-check-suite-updated.png b/assets/images/help/repository/cancel-check-suite-updated.png new file mode 100644 index 000000000000..533a2bcb5ebc Binary files /dev/null and b/assets/images/help/repository/cancel-check-suite-updated.png differ diff --git a/assets/images/help/repository/copy-link-button-updated-2.png b/assets/images/help/repository/copy-link-button-updated-2.png new file mode 100644 index 000000000000..dfa0bab265c2 Binary files /dev/null and b/assets/images/help/repository/copy-link-button-updated-2.png differ diff --git a/assets/images/help/repository/delete-all-logs-updated-2.png b/assets/images/help/repository/delete-all-logs-updated-2.png new file mode 100644 index 000000000000..a902b47f6027 Binary files /dev/null and b/assets/images/help/repository/delete-all-logs-updated-2.png differ diff --git a/assets/images/help/repository/docker-action-workflow-run-updated.png b/assets/images/help/repository/docker-action-workflow-run-updated.png new file mode 100644 index 000000000000..ae31b91911a8 Binary files /dev/null and b/assets/images/help/repository/docker-action-workflow-run-updated.png differ diff --git a/assets/images/help/repository/download-logs-drop-down-updated-2.png b/assets/images/help/repository/download-logs-drop-down-updated-2.png new file mode 100644 index 000000000000..128d39211379 Binary files /dev/null and b/assets/images/help/repository/download-logs-drop-down-updated-2.png differ diff --git a/assets/images/help/repository/in-progress-run.png b/assets/images/help/repository/in-progress-run.png new file mode 100644 index 000000000000..0419dc492965 Binary files /dev/null and b/assets/images/help/repository/in-progress-run.png differ diff --git a/assets/images/help/repository/javascript-action-workflow-run-updated-2.png b/assets/images/help/repository/javascript-action-workflow-run-updated-2.png new file mode 100644 index 000000000000..b60a7536fd4a Binary files /dev/null and b/assets/images/help/repository/javascript-action-workflow-run-updated-2.png differ diff --git a/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png b/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png new file mode 100644 index 000000000000..c49802802456 Binary files /dev/null and b/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png differ diff --git a/assets/images/help/repository/rerun-checks-drop-down-updated.png b/assets/images/help/repository/rerun-checks-drop-down-updated.png new file mode 100644 index 000000000000..4d769074eea3 Binary files /dev/null and b/assets/images/help/repository/rerun-checks-drop-down-updated.png differ diff --git a/assets/images/help/repository/search-log-box-updated-2.png b/assets/images/help/repository/search-log-box-updated-2.png new file mode 100644 index 000000000000..9ab228e44cbf Binary files /dev/null and b/assets/images/help/repository/search-log-box-updated-2.png differ diff --git a/assets/images/help/repository/super-linter-workflow-results-updated-2.png b/assets/images/help/repository/super-linter-workflow-results-updated-2.png new file mode 100644 index 000000000000..6bdde69b112a Binary files /dev/null and b/assets/images/help/repository/super-linter-workflow-results-updated-2.png differ diff --git a/assets/images/help/repository/superlinter-lint-code-base-job-updated.png b/assets/images/help/repository/superlinter-lint-code-base-job-updated.png new file mode 100644 index 000000000000..80ee94d0ceb7 Binary files /dev/null and b/assets/images/help/repository/superlinter-lint-code-base-job-updated.png differ diff --git a/assets/images/help/repository/upload-build-test-artifact.png b/assets/images/help/repository/upload-build-test-artifact.png deleted file mode 100644 index 8739bf119209..000000000000 Binary files a/assets/images/help/repository/upload-build-test-artifact.png and /dev/null differ diff --git a/assets/images/help/repository/view-run-billable-time.png b/assets/images/help/repository/view-run-billable-time.png index 9f1b8643f928..c627f398b373 100644 Binary files a/assets/images/help/repository/view-run-billable-time.png and b/assets/images/help/repository/view-run-billable-time.png differ diff --git a/assets/images/help/repository/workflow-run-kebab-horizontal-icon-updated-2.png b/assets/images/help/repository/workflow-run-kebab-horizontal-icon-updated-2.png new file mode 100644 index 000000000000..952e86f57601 Binary files /dev/null and b/assets/images/help/repository/workflow-run-kebab-horizontal-icon-updated-2.png differ diff --git a/assets/images/help/settings/appearance-tab.png b/assets/images/help/settings/appearance-tab.png index 5e5e97589171..dcd3422ac651 100644 Binary files a/assets/images/help/settings/appearance-tab.png and b/assets/images/help/settings/appearance-tab.png differ diff --git a/assets/images/help/settings/theme-settings-radio-buttons.png b/assets/images/help/settings/theme-settings-radio-buttons.png new file mode 100644 index 000000000000..32c87156c70a Binary files /dev/null and b/assets/images/help/settings/theme-settings-radio-buttons.png differ diff --git a/assets/images/help/settings/update-theme-preference-button.png b/assets/images/help/settings/update-theme-preference-button.png new file mode 100644 index 000000000000..19fd375fe131 Binary files /dev/null and b/assets/images/help/settings/update-theme-preference-button.png differ diff --git a/assets/images/help/sponsors/billing-account-switcher.png b/assets/images/help/sponsors/billing-account-switcher.png new file mode 100644 index 000000000000..d3240f358a2a Binary files /dev/null and b/assets/images/help/sponsors/billing-account-switcher.png differ diff --git a/assets/images/help/sponsors/edit-sponsorship-payment-button.png b/assets/images/help/sponsors/edit-sponsorship-payment-button.png index 36d2c51e497a..369165c851d0 100644 Binary files a/assets/images/help/sponsors/edit-sponsorship-payment-button.png and b/assets/images/help/sponsors/edit-sponsorship-payment-button.png differ diff --git a/assets/images/help/sponsors/link-account-button.png b/assets/images/help/sponsors/link-account-button.png new file mode 100644 index 000000000000..c8d699273086 Binary files /dev/null and b/assets/images/help/sponsors/link-account-button.png differ diff --git a/assets/images/help/sponsors/manage-your-sponsorship-button.png b/assets/images/help/sponsors/manage-your-sponsorship-button.png index 3c094ea2fcf4..d6a7ad78bc9f 100644 Binary files a/assets/images/help/sponsors/manage-your-sponsorship-button.png and b/assets/images/help/sponsors/manage-your-sponsorship-button.png differ diff --git a/assets/images/help/sponsors/organization-update-email-textbox.png b/assets/images/help/sponsors/organization-update-email-textbox.png new file mode 100644 index 000000000000..2e5c3fdfc19e Binary files /dev/null and b/assets/images/help/sponsors/organization-update-email-textbox.png differ diff --git a/assets/images/help/sponsors/pay-prorated-amount-link.png b/assets/images/help/sponsors/pay-prorated-amount-link.png new file mode 100644 index 000000000000..6d73469e510c Binary files /dev/null and b/assets/images/help/sponsors/pay-prorated-amount-link.png differ diff --git a/assets/images/help/sponsors/select-an-account-drop-down.png b/assets/images/help/sponsors/select-an-account-drop-down.png new file mode 100644 index 000000000000..8cbe763af74a Binary files /dev/null and b/assets/images/help/sponsors/select-an-account-drop-down.png differ diff --git a/assets/images/help/sponsors/sponsor-as-drop-down-menu.png b/assets/images/help/sponsors/sponsor-as-drop-down-menu.png new file mode 100644 index 000000000000..0f9419d47f32 Binary files /dev/null and b/assets/images/help/sponsors/sponsor-as-drop-down-menu.png differ diff --git a/assets/images/help/sponsors/sponsoring-as-drop-down-menu.png b/assets/images/help/sponsors/sponsoring-as-drop-down-menu.png new file mode 100644 index 000000000000..1ee7126df30d Binary files /dev/null and b/assets/images/help/sponsors/sponsoring-as-drop-down-menu.png differ diff --git a/assets/images/help/sponsors/sponsoring-settings-button.png b/assets/images/help/sponsors/sponsoring-settings-button.png new file mode 100644 index 000000000000..ce20577af95e Binary files /dev/null and b/assets/images/help/sponsors/sponsoring-settings-button.png differ diff --git a/assets/images/help/sponsors/sponsoring-tab.png b/assets/images/help/sponsors/sponsoring-tab.png new file mode 100644 index 000000000000..0c62587deb58 Binary files /dev/null and b/assets/images/help/sponsors/sponsoring-tab.png differ diff --git a/assets/images/help/sponsors/update-checkbox-manage.png b/assets/images/help/sponsors/update-checkbox-manage.png new file mode 100644 index 000000000000..8fe85c0aa941 Binary files /dev/null and b/assets/images/help/sponsors/update-checkbox-manage.png differ diff --git a/content/actions/creating-actions/creating-a-docker-container-action.md b/content/actions/creating-actions/creating-a-docker-container-action.md index a51ab9b2ca7c..ba06a3a93813 100644 --- a/content/actions/creating-actions/creating-a-docker-container-action.md +++ b/content/actions/creating-actions/creating-a-docker-container-action.md @@ -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" %} +![A screenshot of using your action in a workflow](/assets/images/help/repository/docker-action-workflow-run-updated.png) +{% else %} ![A screenshot of using your action in a workflow](/assets/images/help/repository/docker-action-workflow-run.png) +{% endif %} diff --git a/content/actions/creating-actions/creating-a-javascript-action.md b/content/actions/creating-actions/creating-a-javascript-action.md index e2987d0d15fd..d738d7cd433b 100644 --- a/content/actions/creating-actions/creating-a-javascript-action.md +++ b/content/actions/creating-actions/creating-a-javascript-action.md @@ -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" %} +![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated-2.png) +{% elsif currentVersion ver_gt "enterprise-server@2.22" %} ![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated.png) {% else %} ![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run.png) diff --git a/content/actions/guides/about-packaging-with-github-actions.md b/content/actions/guides/about-packaging-with-github-actions.md index 020c8e636fb2..aba20c17f66e 100644 --- a/content/actions/guides/about-packaging-with-github-actions.md +++ b/content/actions/guides/about-packaging-with-github-actions.md @@ -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" %} +![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down-updated.png) +{% else %} ![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down.png) +{% 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. diff --git a/content/actions/guides/building-and-testing-powershell.md b/content/actions/guides/building-and-testing-powershell.md index ccfa14b9901c..be50ffc52f09 100644 --- a/content/actions/guides/building-and-testing-powershell.md +++ b/content/actions/guides/building-and-testing-powershell.md @@ -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" %} + ![Failed Pester test](/assets/images/help/repository/actions-failed-pester-test-updated.png) + {% else %} ![Failed Pester test](/assets/images/help/repository/actions-failed-pester-test.png) + {% 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: ``` diff --git a/content/actions/guides/storing-workflow-data-as-artifacts.md b/content/actions/guides/storing-workflow-data-as-artifacts.md index 5b8e0e7189e7..cf0932f8793f 100644 --- a/content/actions/guides/storing-workflow-data-as-artifacts.md +++ b/content/actions/guides/storing-workflow-data-as-artifacts.md @@ -108,8 +108,6 @@ jobs: path: output/test/code-coverage.html ``` -![Image of workflow upload artifact workflow run](/assets/images/help/repository/upload-build-test-artifact.png) - {% 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" %} +![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png) +{% else %} ![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow.png) +{% endif %} {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/actions/learn-github-actions/introduction-to-github-actions.md b/content/actions/learn-github-actions/introduction-to-github-actions.md index eecfa6589aec..455cac19cfa0 100644 --- a/content/actions/learn-github-actions/introduction-to-github-actions.md +++ b/content/actions/learn-github-actions/introduction-to-github-actions.md @@ -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 ![Screenshot of workflow results](/assets/images/help/images/learn-github-actions-workflow.png) 1. Under "Workflow runs", click the name of the run you want to see. ![Screenshot of workflow runs](/assets/images/help/images/learn-github-actions-run.png) -{% 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. + ![Select job](/assets/images/help/images/overview-actions-result-navigate.png) +{% endif %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +1. View the results of each step. + ![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result-updated-2.png) +{% elsif currentVersion ver_gt "enterprise-server@2.22" %} 1. Click on the job name to see the results of each step. ![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result-updated.png) {% else %} diff --git a/content/actions/managing-workflow-runs/canceling-a-workflow.md b/content/actions/managing-workflow-runs/canceling-a-workflow.md index 20b9ba1cb4dd..153659d966a7 100644 --- a/content/actions/managing-workflow-runs/canceling-a-workflow.md +++ b/content/actions/managing-workflow-runs/canceling-a-workflow.md @@ -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. +![Name of workflow run](/assets/images/help/repository/in-progress-run.png) 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" %} + ![Cancel check suite button](/assets/images/help/repository/cancel-check-suite-updated.png) +{% else %} ![Cancel check suite button](/assets/images/help/repository/cancel-check-suite.png) +{% endif %} ### Steps {% data variables.product.prodname_dotcom %} takes to cancel a workflow run diff --git a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md index 22d5651efe6e..11843c3cec93 100644 --- a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md +++ b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md @@ -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" %} + ![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down-updated.png) + {% else %} ![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down.png) + {% endif %} diff --git a/content/actions/managing-workflow-runs/index.md b/content/actions/managing-workflow-runs/index.md index 5096b761c732..8905d8b08742 100644 --- a/content/actions/managing-workflow-runs/index.md +++ b/content/actions/managing-workflow-runs/index.md @@ -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 %} diff --git a/content/actions/managing-workflow-runs/re-running-a-workflow.md b/content/actions/managing-workflow-runs/re-running-a-workflow.md index 61590387dbf4..323ebab2d31f 100644 --- a/content/actions/managing-workflow-runs/re-running-a-workflow.md +++ b/content/actions/managing-workflow-runs/re-running-a-workflow.md @@ -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**. - ![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down.png) +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" %}![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down-updated.png){% else %}![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down.png){% endif %} diff --git a/content/actions/managing-workflow-runs/removing-workflow-artifacts.md b/content/actions/managing-workflow-runs/removing-workflow-artifacts.md index 9c7e96fe7914..33595a42cfb0 100644 --- a/content/actions/managing-workflow-runs/removing-workflow-artifacts.md +++ b/content/actions/managing-workflow-runs/removing-workflow-artifacts.md @@ -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" %} + ![Delete artifact drop-down menu](/assets/images/help/repository/actions-delete-artifact-updated.png) + {% else %} ![Delete artifact drop-down menu](/assets/images/help/repository/actions-delete-artifact.png) + {% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} ### Setting the retention period for an artifact diff --git a/content/actions/managing-workflow-runs/using-the-visualization-graph.md b/content/actions/managing-workflow-runs/using-the-visualization-graph.md new file mode 100644 index 000000000000..2fe6753a3031 --- /dev/null +++ b/content/actions/managing-workflow-runs/using-the-visualization-graph.md @@ -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. + ![Workflow graph](/assets/images/help/images/workflow-graph.png) + +2. Click on a job to view the job log. + ![Workflow graph](/assets/images/help/images/workflow-graph-job.png) diff --git a/content/actions/managing-workflow-runs/using-workflow-run-logs.md b/content/actions/managing-workflow-runs/using-workflow-run-logs.md index 92ad242d9cd4..9cffb45bc3d6 100644 --- a/content/actions/managing-workflow-runs/using-workflow-run-logs.md +++ b/content/actions/managing-workflow-runs/using-workflow-run-logs.md @@ -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" %} + ![Search box to search logs](/assets/images/help/repository/search-log-box-updated-2.png) +{% else %} ![Search box to search logs](/assets/images/help/repository/search-log-box-updated.png) +{% endif %} {% else %} 1. To expand each step you want to include in your search, click the step. ![Step name](/assets/images/help/repository/failed-check-step.png) @@ -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" %} + ![Download logs drop-down menu](/assets/images/help/repository/download-logs-drop-down-updated-2.png) + {% else %} ![Download logs drop-down menu](/assets/images/help/repository/download-logs-drop-down-updated.png) + {% endif %} {% else %} 1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select **Download log archive**. ![Download logs drop-down menu](/assets/images/help/repository/download-logs-drop-down.png) @@ -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" %} + ![Kebab-horizontal icon](/assets/images/help/repository/workflow-run-kebab-horizontal-icon-updated-2.png) + {% else %} ![Kebab-horizontal icon](/assets/images/help/repository/workflow-run-kebab-horizontal-icon-updated.png) + {% 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" %} + ![Delete all logs](/assets/images/help/repository/delete-all-logs-updated-2.png) + {% else %} ![Delete all logs](/assets/images/help/repository/delete-all-logs-updated.png) + {% 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" %}. diff --git a/content/actions/managing-workflow-runs/viewing-job-execution-time.md b/content/actions/managing-workflow-runs/viewing-job-execution-time.md index 5b4d222793e6..e1b7bd9ac007 100644 --- a/content/actions/managing-workflow-runs/viewing-job-execution-time.md +++ b/content/actions/managing-workflow-runs/viewing-job-execution-time.md @@ -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**. ![Run and billable time details link](/assets/images/help/repository/view-run-billable-time.png) {% note %} diff --git a/content/actions/quickstart.md b/content/actions/quickstart.md index 77e87524809f..812f317f0324 100644 --- a/content/actions/quickstart.md +++ b/content/actions/quickstart.md @@ -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. + ![Lint code base job](/assets/images/help/repository/superlinter-lint-code-base-job-updated.png) +{% else %} 1. In the left sidebar, click the **Lint code base** job. ![Lint code base job](/assets/images/help/repository/superlinter-lint-code-base-job.png) +{% endif %} {% data reusables.repositories.view-failed-job-results-superlinter %} ### More starter workflows diff --git a/content/discussions/index.md b/content/discussions/index.md index 9dff7d00d392..66dca4f270e2 100644 --- a/content/discussions/index.md +++ b/content/discussions/index.md @@ -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: '*' diff --git a/content/discussions/quickstart.md b/content/discussions/quickstart.md index 7625961cdb82..2bdf5404256f 100644 --- a/content/discussions/quickstart.md +++ b/content/discussions/quickstart.md @@ -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)." diff --git a/content/github/authenticating-to-github/reviewing-your-security-log.md b/content/github/authenticating-to-github/reviewing-your-security-log.md index 3727bef92979..7882fef91524 100644 --- a/content/github/authenticating-to-github/reviewing-your-security-log.md +++ b/content/github/authenticating-to-github/reviewing-your-security-log.md @@ -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)") diff --git a/content/github/collaborating-with-issues-and-pull-requests/index.md b/content/github/collaborating-with-issues-and-pull-requests/index.md index 234ce781cd5b..ae4915c00270 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/index.md +++ b/content/github/collaborating-with-issues-and-pull-requests/index.md @@ -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 %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md new file mode 100644 index 000000000000..364fc8048c97 --- /dev/null +++ b/content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md @@ -0,0 +1,74 @@ +--- +title: Reviewing dependency changes in a pull request +intro: 'If a pull request contains changes to dependencies, you can view a summary of what has changed and whether there are known vulnerabilities in any of the dependencies.' +versions: + free-pro-team: '*' +--- + +{% note %} + +**Note:** Dependency review is currently in beta and subject to change. + +{% endnote %} + +### About dependency review + +If a pull request targets your repository's default branch and contains changes to package manifests or lock files, you can display a dependency review to see what has changed. The dependency review includes details of changes to indirect dependencies in lock files, and it tells you if any of the added or updated dependencies contain known vulnerabilities. + +Dependency review is available in: + +* All public repositories. +* Private repositories owned by organizations with an {% data variables.product.prodname_advanced_security %} license that have the dependency graph enabled. For more information, see "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)." + +Sometimes you might just want to update the version of one dependency in a manifest and generate a pull request. However, if the updated version of this direct dependency also has updated dependencies, your pull request may have more changes than you expected. The dependency review for each manifest and lock file provides an easy way to see what has changed, and whether any of the new dependency versions contain known vulnerabilities. + +By checking the dependency reviews in a pull request, and changing any dependencies that are flagged as vulnerable, you can avoid vulnerabilities being added to your project. {% data variables.product.prodname_dependabot_alerts %} will find vulnerabilities that are already in your dependencies, but it's much better to avoid introducing potential problems than to fix them at some later date. For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)." + +Dependency review supports the same languages and package management ecosystems as the dependency graph. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)." + +### Reviewing dependencies in a pull request + +{% data reusables.repositories.sidebar-pr %} +{% data reusables.repositories.choose-pr-review %} +{% data reusables.repositories.changed-files %} + +1. If the pull request contains many files, use the **File filter** drop-down menu to collapse all files that don't record dependencies. This will make it easier to focus your review on the dependency changes. + + ![The file filter menu](/assets/images/help/pull_requests/file-filter-menu-json.png) + +1. On the right of the header for a manifest or lock file, display the dependency review by clicking the rich diff button. + + ![The rich diff button](/assets/images/help/pull_requests/dependency-review-rich-diff.png) + + {% note %} + + **Note:** The dependency review provides a clearer view of what has changed in large lock files, where the source diff is not rendered by default. + + {% endnote %} + +1. Check the dependencies listed in the dependency review. + + ![Vulnerability warnings in a dependency review](/assets/images/help/pull_requests/dependency-review-vulnerability.png) + + Any added or changed dependencies that have vulnerabilities are listed first, ordered by severity and then by dependency name. This means that the highest severity dependencies are always at the top of a dependency review. Other dependencies are listed alphabetically by dependency name. + + The icon beside each dependency indicates whether the dependency has been added ({% octicon "diff-added" aria-label="Dependency added icon" %}), updated ({% octicon "diff-modified" aria-label="Dependency modified icon" %}), or removed ({% octicon "diff-removed" aria-label="Dependency removed icon" %}) in this pull request. + + Other information includes: + + * The version, or version range, of the new, updated, or deleted dependency. + * For a specific version of a dependency: + * The age of that release of the dependency. + * The number of projects that are dependent on this software. This information is taken from the dependency graph. Checking the number of dependents can help you avoid accidentally adding the wrong dependency. + * The license used by this dependency, if this information is available. This is useful if you want to avoid code with certain licenses being used in your project. + + Where a dependency has a known vulnerability, the warning message includes: + + * A brief description of the vulnerability. + * A Common Vulnerabilities and Exposures (CVE) or {% data variables.product.prodname_security_advisories %} (GHSA) identification number. You can click this ID to find out more about the vulnerability. + * The severity of the vulnerability. + * The version of the dependency in which the vulnerability was fixed. If you are reviewing a pull request for someone, you might ask the contributor to update the dependency to the patched version, or a later release. + +1. You can return to the original view of the file by clicking the source diff button. + + ![The source diff button](/assets/images/help/pull_requests/dependency-review-source-diff.png) diff --git a/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md index b69a71eb46ee..883e41571f6c 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md @@ -30,6 +30,18 @@ Before you submit your review, your line comments are _pending_ and only visible ![Cancel review button](/assets/images/help/pull_requests/cancel-review-button.png) +{% if currentVersion == "free-pro-team@latest" %} +### Reviewing dependency changes + +If the pull request contains changes to dependencies you can use the dependency review for a manifest or lock file to see what has changed and check whether the changes introduce security vulnerabilities. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)." + +{% data reusables.repositories.changed-files %} + +1. On the right of the header for a manifest or lock file, display the dependency review by clicking the rich diff button. + + ![The rich diff button](/assets/images/help/pull_requests/dependency-review-rich-diff.png) +{% endif %} + ### Marking a file as viewed After you finish reviewing a file, you can mark the file as viewed, and the file will collapse. If the file changes after you view the file, it will be unmarked as viewed. @@ -56,8 +68,5 @@ After you've finished reviewing all the files you want in the pull request, subm ### Further reading -- "[About pull request reviews](/articles/about-pull-request-reviews)" -- "[About required reviews for pull requests](/articles/about-required-reviews-for-pull-requests)" -- "[Approving a pull request with required reviews](/articles/approving-a-pull-request-with-required-reviews)" -- "[Commenting on a pull request](/articles/commenting-on-a-pull-request)" -- "[Filtering pull requests by review status](/articles/filtering-pull-requests-by-review-status)" +- "[About required reviews for pull requests](/github/administering-a-repository/about-required-reviews-for-pull-requests)" +- "[Filtering pull requests by review status](/github/managing-your-work-on-github/filtering-pull-requests-by-review-status)" diff --git a/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md b/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md index a628b146fd7f..67f9613edb32 100644 --- a/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md +++ b/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md @@ -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 "Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}."{% 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 %} diff --git a/content/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies.md b/content/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies.md new file mode 100644 index 000000000000..9041daa8dee3 --- /dev/null +++ b/content/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies.md @@ -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)." diff --git a/content/github/managing-security-vulnerabilities/index.md b/content/github/managing-security-vulnerabilities/index.md index 14e9fc90c330..9afde0213a9a 100644 --- a/content/github/managing-security-vulnerabilities/index.md +++ b/content/github/managing-security-vulnerabilities/index.md @@ -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 %} diff --git a/content/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository.md b/content/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository.md index 0dea3bd05c25..532fddecb57e 100644 --- a/content/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository.md +++ b/content/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository.md @@ -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 diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md index fec21f3ab71b..f5cb3931230f 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md @@ -9,6 +9,8 @@ versions: {% data reusables.sponsors.sponsorship-details %} +{% data reusables.sponsors.no-fees %} + {% data reusables.dotcom_billing.view-all-subscriptions %} ### Further reading diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-a-sponsorship.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-a-sponsorship.md index 5ec6dafb61d3..4d9595814cb5 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-a-sponsorship.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-a-sponsorship.md @@ -7,25 +7,24 @@ versions: free-pro-team: '*' --- -### Downgrading a sponsorship +{% data reusables.sponsors.org-sponsors-release-phase %} -When you downgrade a sponsorship, the change will become effective on your next billing date. {% data reusables.sponsors.no-refunds %} +### About sponsorship downgrades -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.billing %} -{% data reusables.user_settings.subscriptions-tab %} -{% data reusables.sponsors.change-tier %} -4. On the right side of the page, next to your selected tier, click **Edit**. - ![Edit tier button](/assets/images/help/billing/edit-tier-button.png) +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 + +{% data reusables.sponsors.navigate-to-sponsored-account %} +{% data reusables.sponsors.sponsorship-dashboard %} {% data reusables.sponsors.select-a-tier %} {% data reusables.sponsors.update-sponsorship %} ### Canceling a sponsorship -When you cancel a sponsorship, the change will become effective on your next billing date. {% data reusables.sponsors.no-refunds %} - {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.billing %} +{% data reusables.sponsors.billing-switcher %} {% data reusables.user_settings.subscriptions-tab %} 3. Under "{% data variables.product.prodname_sponsors %}", to the right of the sponsored open source contributor, click {% octicon "triangle-down" aria-label="The down triangle octicon" %} next to your sponsored amount, then click **Cancel sponsorship**. ![Cancel sponsorship button](/assets/images/help/billing/edit-sponsor-billing.png) diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-a-sponsorship.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-a-sponsorship.md index 7637a1e68b3a..cd65d50f26b1 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-a-sponsorship.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-a-sponsorship.md @@ -7,13 +7,15 @@ versions: free-pro-team: '*' --- +{% data reusables.sponsors.org-sponsors-release-phase %} + +### About sponsorship upgrades + When you upgrade your sponsorship tier, the change will become effective immediately. {% data reusables.sponsors.prorated-sponsorship %} -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.billing %} -{% data reusables.user_settings.subscriptions-tab %} -{% data reusables.sponsors.change-tier %} -4. On the right side of the page, next to your selected tier, click **Edit**. - ![Edit tier button](/assets/images/help/billing/edit-tier-button.png) +### Upgrading a sponsorship + +{% data reusables.sponsors.navigate-to-sponsored-account %} +{% data reusables.sponsors.sponsorship-dashboard %} {% data reusables.sponsors.select-a-tier %} -{% data reusables.sponsors.update-sponsorship %} +{% data reusables.sponsors.update-sponsorship %} \ No newline at end of file diff --git a/content/github/setting-up-and-managing-organizations-and-teams/index.md b/content/github/setting-up-and-managing-organizations-and-teams/index.md index 7125ecac8d8d..d1c440e8c576 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/index.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/index.md @@ -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 %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors.md new file mode 100644 index 000000000000..f60a66464441 --- /dev/null +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors.md @@ -0,0 +1,25 @@ +--- +title: Managing updates from accounts your organization sponsors +intro: You can manage the email address that receives updates from accounts your organization sponsors. +versions: + free-pro-team: '*' +permissions: Organization owners can manage updates from accounts the organization sponsors. +--- + +{% data reusables.sponsors.org-sponsors-release-phase %} + +The developers and organizations that your organization sponsors can send you updates about their work. You can manage the email address that receives these updates. + +You can also disable updates from accounts your organization sponsors. For more information, see "[Managing your sponsorship](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship#managing-email-updates-for-your-sponsorship)." + +{% data reusables.profile.access_profile %} +{% data reusables.profile.access_org %} +{% data reusables.organizations.org_settings %} +1. Under "Sponsors update email (Private)", type the email address you want to receive updates from accounts your organization sponsors. + ![Textbox to enter the email address to receive updates from sponsored accounts](/assets/images/help/sponsors/organization-update-email-textbox.png) +1. Click **Update profile**. + ![Update profile button](/assets/images/help/organizations/update-profile-button.png) + +### Further reading + +- "[Supporting the open source community with {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors)" \ No newline at end of file diff --git a/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md index 6b04032d743a..8add77b2f31e 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md @@ -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** | | | diff --git a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md index f069a691134b..fcb5bd5ba785 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md @@ -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" %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/index.md b/content/github/setting-up-and-managing-your-github-user-account/index.md index 6ce7743d9fb9..352849bd5716 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/index.md +++ b/content/github/setting-up-and-managing-your-github-user-account/index.md @@ -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 %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings.md b/content/github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings.md new file mode 100644 index 000000000000..37f6c586436a --- /dev/null +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings.md @@ -0,0 +1,24 @@ +--- +title: Managing your theme settings +intro: You can manage how {% data variables.product.product_name %} looks to you by setting a theme preference that either follows your system settings or always uses light mode or dark mode. +versions: + free-pro-team: '*' +--- + +{% note %} + +**Note:** Theme settings is currently in beta and subject to change. + +{% endnote %} + +For choice and flexibility in how and when you use {% data variables.product.product_name %}, you can configure theme settings to change how {% data variables.product.product_name %} looks to you. You can choose from two themes, light and dark, or you can configure {% data variables.product.product_name %} to follow your system settings. Some developers use dark theme for personal preference, to reduce power consumption on certain devices, or to reduce eye strain in low-light conditions. + +{% data reusables.user_settings.access_settings %} +1. In the user settings sidebar, click **Appearance**. + !["Apperance" tab in user settings sidebar](/assets/images/help/settings/appearance-tab.png) +1. Under "Theme", select a theme preference. + ![Radio buttons for theme settings](/assets/images/help/settings/theme-settings-radio-buttons.png) + +### Further reading + +- "[Setting a theme for {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/setting-a-theme-for-github-desktop)" diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md index f3297bfd7ebe..b3bb5af8c998 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md @@ -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)" diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization.md b/content/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization.md new file mode 100644 index 000000000000..993701f37cae --- /dev/null +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization.md @@ -0,0 +1,17 @@ +--- +title: Attributing sponsorships to your organization +intro: 'You can attribute the sponsorships paid by one of your organizations to another organization.' +versions: + free-pro-team: '*' +permissions: People who are organization owners of both organizations can attribute one organization's sponsorships to another organization. +--- + +1. Navigate to the organization whose sponsorships you want to attribute to another organization. +1. Under your organization name, click {% octicon "heart" aria-label="The heart icon" %} **Sponsoring**. + !["Sponsoring" tab](/assets/images/help/sponsors/sponsoring-tab.png) +1. In the upper-right corner, click {% octicon "gear" aria-label="The gear icon" %} **Settings**. + !["Settings" button](/assets/images/help/sponsors/sponsoring-settings-button.png) +1. Under "Link sponsorships to another account", use the drop-down menu, then click the organization you want this organization's sponsorships to be attributed to. + ![Drop-down menu to select account](/assets/images/help/sponsors/select-an-account-drop-down.png) +1. Click **Link account**. + !["Link account" button](/assets/images/help/sponsors/link-account-button.png) \ No newline at end of file diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers.md b/content/github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers.md index 4bed524e3cda..f9b176f55d0f 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers.md @@ -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-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-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 %} \ No newline at end of file diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md b/content/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md index f73cfc6f93f6..0cae836a8f2c 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md @@ -5,25 +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 %} -{% 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 %} - -### Managing webhooks for your sponsored organization - -Organization owners can configure webhooks for a sponsored organization. +### Managing webhooks for events in your sponsored account -{% data reusables.sponsors.navigate-to-org-sponsors-dashboard %} +{% 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 %} @@ -31,4 +19,4 @@ Organization owners can configure webhooks for a sponsored organization. {% 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 %} \ No newline at end of file diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md index 80e23f3cf58b..640d96544813 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md @@ -7,22 +7,15 @@ versions: free-pro-team: '*' --- -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)." +### About sponsorship updates -### Contacting your user account's sponsors +Your sponsors can choose whether they receive email updates about your work. For more information, see "[Managing your sponsorship](/articles/managing-your-sponsorship)." -{% 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 %} +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 organization's sponsors +### Contacting your 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 %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors.md index e841276f04cb..53004b7463db 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors.md @@ -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-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-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 %} \ No newline at end of file diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/index.md b/content/github/supporting-the-open-source-community-with-github-sponsors/index.md index def51bcb47e8..48892ef8f233 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/index.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/index.md @@ -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 %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors.md index 295daca88896..abfed9bd2c98 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors.md @@ -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 %} \ No newline at end of file diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md index 07a67e1a88a9..a4d3bdc206c9 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md @@ -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 %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship.md b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship.md index 17c1100ced0d..ad0e8d461d65 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship.md @@ -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 %} -{% data reusables.sponsors.update-sponsorship %} - -### Managing email updates from a sponsored developer +You can choose whether an account you sponsor can send you email updates about their work. The sponsored account will not have access to your email address. -You can choose whether 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.manage-updates-for-orgs %} -{% data reusables.sponsors.navigate-to-sponsored-developer %} -{% data reusables.sponsors.manage-developer-sponsorship %} -{% data reusables.sponsors.developer-sponsored-choose-updates %} +{% 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 organization +### Further reading -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)" \ No newline at end of file diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md index 41edca34c234..3d15b436627b 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md @@ -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 %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md index ac0981e3369f..5b14699adcf3 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md @@ -26,7 +26,7 @@ If you have a bank account in a supported region, {% data variables.product.prod After {% data variables.product.prodname_dotcom %} reviews your application, you can set up your sponsored developer profile so that people can start sponsoring you. -{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %} +{% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.navigate-to-profile-tab %} {% data reusables.sponsors.short-bio %} {% data reusables.sponsors.add-introduction %} @@ -40,7 +40,7 @@ After {% data variables.product.prodname_dotcom %} reviews your application, you {% data reusables.sponsors.maximum-tier %} -{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %} +{% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.navigate-to-sponsor-tiers-tab %} {% data reusables.sponsors.click-add-tier %} {% data reusables.sponsors.tier-price-description %} @@ -54,14 +54,14 @@ If you live in a supported region, you can follow these instructions to submit y {% data reusables.sponsors.double-check-stripe-info %} -{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %} +{% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.create-stripe-account %} ### Submitting your tax information {% data reusables.sponsors.tax-form-information-dev %} -{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %} +{% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.settings-tab %} {% data reusables.sponsors.country-of-residence %} {% data reusables.sponsors.overview-tab %} @@ -73,7 +73,7 @@ Before you can become a sponsored developer, you must enable 2FA on your {% data ### Submitting your application to {% data variables.product.prodname_dotcom %} for approval -{% data reusables.sponsors.navigate-to-dev-sponsors-dashboard %} +{% data reusables.sponsors.navigate-to-sponsors-dashboard %} 4. Click **Request approval**. ![Request approval button](/assets/images/help/sponsors/request-approval-button.png) diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md b/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md index 05d3f4c10502..b985f949c269 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md @@ -7,17 +7,32 @@ redirect_from: - /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-a-developer versions: free-pro-team: '*' +permissions: Anyone can sponsor accounts on behalf of their own user account. Organization owners and billing managers can sponsor accounts on behalf of their organization. --- -### About sponsoring developers and organizations +{% data reusables.sponsors.org-sponsors-release-phase %} -{% data reusables.sponsors.sponsorship-details %} {% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)." +### About sponsorships -When you sponsor an open source contributor, the change will become effective immediately. {% data reusables.sponsors.prorated-sponsorship %} +{% data reusables.sponsors.sponsorship-details %} -If the sponsored open source contributor retires your tier, the tier will remain in place for you until you choose a different tier or cancel your subscription. For more information, see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)." +You can sponsor an account on behalf of your user account to invest in projects that you personally benefit from. You can sponsor an account on behalf of your organization for many reasons. +- Sustaining specific libraries that your organization's work depends on +- Investing in the ecosystem you rely on as a organization (such as blockchain) +- Developing brand awareness as an organization that values open source +- Thanking open source developers for building libraries that complement the product your organization offers -If the open source contributor you want to sponsor does not have a sponsored developer or organization profile, you can encourage the contributor to create a sponsored developer or organization profile. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)." +You can use a credit card to sponsor an account on {% data variables.product.product_name %}. If your organization wants to be invoiced, [contact us](https://support.github.com/contact/org-sponsors-waitlist). + +{% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)." + +When you sponsor an account using a credit card, the change will become effective immediately. {% data reusables.sponsors.prorated-sponsorship %} + +{% data reusables.sponsors.manage-updates-for-orgs %} + +If the sponsored account retires your tier, the tier will remain in place for you until you choose a different tier or cancel your subscription. For more information, see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)." + +If the account you want to sponsor does not have a profile on {% data variables.product.prodname_sponsors %}, you can encourage the account to join. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)." {% data reusables.sponsors.sponsorships-not-tax-deductible %} @@ -27,34 +42,23 @@ If the open source contributor you want to sponsor does not have a sponsored dev {% endnote %} -### Sponsoring a developer +### Sponsoring an account -Before you can sponsor a developer, you must have a verified email address. For more information, see "[Verifying your email address](/github/getting-started-with-github/verifying-your-email-address)." +Before you can sponsor an account, you must have a verified email address. For more information, see "[Verifying your email address](/github/getting-started-with-github/verifying-your-email-address)." -1. On {% data variables.product.product_name %}, navigate to the profile of the person you want to sponsor. -2. Under the developer's name, click **Sponsor**. - ![Sponsor button](/assets/images/help/profile/sponsor-button.png) +1. On {% data variables.product.product_name %}, navigate to the profile of the user or organization you want to sponsor. +1. Navigate to your sponsorship dashboard for the account. + - To sponsor a developer, under the developer's name, click **Sponsor**. + ![Sponsor button](/assets/images/help/profile/sponsor-button.png) + - To sponsor an organization, to the right of the the organization's name, click **Sponsor**. + ![Sponsor button](/assets/images/help/sponsors/sponsor-org-button.png) +1. Optionally, on the right side of the page, to sponsor the account on behalf of your organization, use the **Sponsor as** drop-down menu, and click the organization. + ![Drop-down menu to choose the account you'll sponsor as](/assets/images/help/sponsors/sponsor-as-drop-down-menu.png) {% data reusables.sponsors.select-a-tier %} +{% data reusables.sponsors.pay-prorated-amount %} {% data reusables.sponsors.select-sponsorship-billing %} ![Edit payment button](/assets/images/help/sponsors/edit-sponsorship-payment-button.png) {% data reusables.sponsors.who-can-see-your-sponsorship %} ![Radio buttons to choose who can see your sponsorship](/assets/images/help/sponsors/who-can-see-sponsorship.png) -{% data reusables.sponsors.developer-sponsored-choose-updates %} -7. Click **Sponsor _DEVELOPER_**. - ![Sponsor developer button](/assets/images/help/sponsors/sponsor-developer-button.png) - -### Sponsoring an organization - -Before you can sponsor an organization, you must have a verified email address. For more information, see "[Verifying your email address](/github/getting-started-with-github/verifying-your-email-address)." - -1. On {% data variables.product.product_name %}, navigate to the page of the organization you want to sponsor. -2. Next to the organization's name, click **Sponsor**. - ![Sponsor button](/assets/images/help/sponsors/sponsor-org-button.png) -{% data reusables.sponsors.select-a-tier %} -{% data reusables.sponsors.select-sponsorship-billing %} - ![Edit payment button](/assets/images/help/sponsors/edit-org-sponsorship-payment-button.png) -{% data reusables.sponsors.who-can-see-your-sponsorship %} - ![Radio buttons to choose who can see your sponsorship](/assets/images/help/sponsors/who-can-see-org-sponsorship.png) -{% data reusables.sponsors.org-sponsored-choose-updates %} -7. Click **Sponsor _ORGANIZATION_**. - ![Sponsor organization button](/assets/images/help/sponsors/sponsor-org-confirm-button.png) +{% data reusables.sponsors.choose-updates %} +{% data reusables.sponsors.sponsor-account %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships.md b/content/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships.md index c00a06bca199..3eab334503cf 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships.md @@ -7,40 +7,29 @@ versions: free-pro-team: '*' --- -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. +### About sponsors and sponsorships -### Viewing your Sponsors dashboard - -1. In the upper-right corner of any page, click your profile photo, then click **{% data variables.product.prodname_sponsors %}**. -![{% data variables.product.prodname_sponsors %} button](/assets/images/help/sponsors/access-github-sponsors-dashboard.png) -2. In the list that's displayed, to the right of the account or organization whose Sponsors dashboard you want to view, click **Dashboard**. -![Developer sponsors dashboard button](/assets/images/help/sponsors/dev-sponsors-dashboard-button.png) +You can view analytics on your current and past sponsorships, the payments you've received from sponsors, and events, such as cancellations and sponsor tier changes for your sponsorships. You can also view activity such as new sponsorships, changes to sponsorships, and canceled sponsorships. You can filter the list of activities by date. You can also export sponsorship data for the account you're viewing in CSV or JSON format. ### Viewing your sponsors and sponsorships -1. Go to your Sponsors dashboard, see [Viewing your Sponsors dashboard](#viewing-your-sponsors-dashboard). -{% data reusables.sponsors.navigate-to-sponsors-tab %} +{% data reusables.sponsors.navigate-to-sponsors-dashboard %} 1. Optionally, to filter your sponsors by tier, use the **Filter** drop-down menu, click **Active tiers** or **Retired tiers**, and select a tier. ![Drop-down menu to filter by tier](/assets/images/help/sponsors/filter-drop-down.png) ### Viewing recent sponsorship activity -1. Go to your Sponsors dashboard, see [Viewing your Sponsors dashboard](#viewing-your-sponsors-dashboard). +{% data reusables.sponsors.navigate-to-sponsors-dashboard %} 1. In the left sidebar, click **Activity**. ![Activity tab](/assets/images/help/sponsors/activity-tab.png) ### Exporting your sponsorship data -1. Go to your Sponsors dashboard, see [Viewing your Sponsors dashboard](#viewing-your-sponsors-dashboard). +If you have sponsors, you can export your sponsorship data. {% data variables.product.prodname_dotcom %} will send you an email with export data for all of your sponsors for the month you select. After the export is complete, you can export another month of data. You can export up to 10 sets of data per hour for any of your sponsored accounts. + +{% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.navigate-to-sponsors-tab %} 1. Click **Export all**. ![Export all button](/assets/images/help/sponsors/export-all.png) - - This button is not displayed if you don't have any sponsors. - 1. Choose a timeframe and a format for the data you'd like to export, then click **Start export**. - ![Options for data export](/assets/images/help/sponsors/export-your-sponsors.png) - - {% data variables.product.prodname_dotcom %} starts exporting data for all of your sponsors for the month you selected. You'll be emailed shortly with an attachment containing the data. After the export is complete you can export another month of data. You can export up to 10 sets of data an hour for any of your sponsored organizations or user accounts. + ![Options for data export](/assets/images/help/sponsors/export-your-sponsors.png) \ No newline at end of file diff --git a/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md b/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md index ee6e10f5bcb4..1a66878f1acd 100644 --- a/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md +++ b/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md @@ -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 diff --git a/content/packages/getting-started-with-github-container-registry/about-github-container-registry.md b/content/packages/getting-started-with-github-container-registry/about-github-container-registry.md deleted file mode 100644 index 15721dd10b37..000000000000 --- a/content/packages/getting-started-with-github-container-registry/about-github-container-registry.md +++ /dev/null @@ -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.
Can read package metadata. | -| Write | Can upload and download this package.
Can read and write package metadata. | -| Admin | Can upload, download, delete, and manage this package.
Can read and write package metadata.
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. diff --git a/content/packages/getting-started-with-github-container-registry/index.md b/content/packages/getting-started-with-github-container-registry/index.md deleted file mode 100644 index f07fd0941c04..000000000000 --- a/content/packages/getting-started-with-github-container-registry/index.md +++ /dev/null @@ -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)." diff --git a/content/packages/guides/about-github-container-registry.md b/content/packages/guides/about-github-container-registry.md new file mode 100644 index 000000000000..7a6984309cf5 --- /dev/null +++ b/content/packages/guides/about-github-container-registry.md @@ -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.

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.
Can read package metadata. | +| Write | Can upload and download this package.
Can read and write package metadata. | +| Admin | Can upload, download, delete, and manage this package.
Can read and write package metadata.
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. diff --git a/content/packages/managing-container-images-with-github-container-registry/configuring-access-control-and-visibility-for-container-images.md b/content/packages/guides/configuring-access-control-and-visibility-for-container-images.md similarity index 97% rename from content/packages/managing-container-images-with-github-container-registry/configuring-access-control-and-visibility-for-container-images.md rename to content/packages/guides/configuring-access-control-and-visibility-for-container-images.md index 8779fdf8efde..bff3dfee0ca8 100644 --- a/content/packages/managing-container-images-with-github-container-registry/configuring-access-control-and-visibility-for-container-images.md +++ b/content/packages/guides/configuring-access-control-and-visibility-for-container-images.md @@ -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: '*' --- diff --git a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages.md b/content/packages/guides/configuring-apache-maven-for-use-with-github-packages.md similarity index 96% rename from content/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages.md rename to content/packages/guides/configuring-apache-maven-for-use-with-github-packages.md index 0d8c2df1cca7..62ffeb833cf9 100644 --- a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-apache-maven-for-use-with-github-packages.md @@ -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/)" diff --git a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages.md b/content/packages/guides/configuring-docker-for-use-with-github-packages.md similarity index 98% rename from content/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages.md rename to content/packages/guides/configuring-docker-for-use-with-github-packages.md index d31c4e2c4a77..ce7cedc3e8c9 100644 --- a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-docker-for-use-with-github-packages.md @@ -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' diff --git a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-dotnet-cli-for-use-with-github-packages.md b/content/packages/guides/configuring-dotnet-cli-for-use-with-github-packages.md similarity index 98% rename from content/packages/using-github-packages-with-your-projects-ecosystem/configuring-dotnet-cli-for-use-with-github-packages.md rename to content/packages/guides/configuring-dotnet-cli-for-use-with-github-packages.md index a5fa36cc7e53..1c1369de9ffe 100644 --- a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-dotnet-cli-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-dotnet-cli-for-use-with-github-packages.md @@ -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' diff --git a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-gradle-for-use-with-github-packages.md b/content/packages/guides/configuring-gradle-for-use-with-github-packages.md similarity index 98% rename from content/packages/using-github-packages-with-your-projects-ecosystem/configuring-gradle-for-use-with-github-packages.md rename to content/packages/guides/configuring-gradle-for-use-with-github-packages.md index 73502d9a8662..d84b907b011a 100644 --- a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-gradle-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-gradle-for-use-with-github-packages.md @@ -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' diff --git a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages.md b/content/packages/guides/configuring-npm-for-use-with-github-packages.md similarity index 99% rename from content/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages.md rename to content/packages/guides/configuring-npm-for-use-with-github-packages.md index 3ecb00119f7e..f96a8d68c694 100644 --- a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-npm-for-use-with-github-packages.md @@ -6,6 +6,7 @@ redirect_from: - /articles/configuring-npm-for-use-with-github-package-registry - /github/managing-packages-with-github-package-registry/configuring-npm-for-use-with-github-package-registry - /github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages + - /packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages versions: free-pro-team: '*' enterprise-server: '>=2.22' diff --git a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-rubygems-for-use-with-github-packages.md b/content/packages/guides/configuring-rubygems-for-use-with-github-packages.md similarity index 98% rename from content/packages/using-github-packages-with-your-projects-ecosystem/configuring-rubygems-for-use-with-github-packages.md rename to content/packages/guides/configuring-rubygems-for-use-with-github-packages.md index b0e21632a83e..98ab1d6cb999 100644 --- a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-rubygems-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-rubygems-for-use-with-github-packages.md @@ -6,6 +6,7 @@ redirect_from: - /articles/configuring-rubygems-for-use-with-github-package-registry - /github/managing-packages-with-github-package-registry/configuring-rubygems-for-use-with-github-package-registry - /github/managing-packages-with-github-packages/configuring-rubygems-for-use-with-github-packages + - /packages/using-github-packages-with-your-projects-ecosystem/configuring-rubygems-for-use-with-github-packages versions: free-pro-team: '*' enterprise-server: '>=2.22' diff --git a/content/packages/managing-container-images-with-github-container-registry/connecting-a-repository-to-a-container-image.md b/content/packages/guides/connecting-a-repository-to-a-container-image.md similarity index 96% rename from content/packages/managing-container-images-with-github-container-registry/connecting-a-repository-to-a-container-image.md rename to content/packages/guides/connecting-a-repository-to-a-container-image.md index 36623b8ecf9d..051f92283acb 100644 --- a/content/packages/managing-container-images-with-github-container-registry/connecting-a-repository-to-a-container-image.md +++ b/content/packages/guides/connecting-a-repository-to-a-container-image.md @@ -2,6 +2,8 @@ title: Connecting a repository to a container image intro: 'You can link a repository with a container image locally and on {% data variables.product.prodname_dotcom %}.' product: '{% data reusables.gated-features.packages %}' +redirect_from: + - /packages/managing-container-images-with-github-container-registry/connecting-a-repository-to-a-container-image versions: free-pro-team: '*' --- diff --git a/content/packages/guides/container-guides-for-github-packages.md b/content/packages/guides/container-guides-for-github-packages.md new file mode 100644 index 000000000000..31b8f63889a5 --- /dev/null +++ b/content/packages/guides/container-guides-for-github-packages.md @@ -0,0 +1,10 @@ +--- +title: Container guides for GitHub Packages +shortTitle: Container guides for GitHub Packages +intro: 'You can publish and retrieve Docker images using {% data variables.product.prodname_registry %}.' +mapTopic: true +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' +--- + diff --git a/content/packages/managing-container-images-with-github-container-registry/deleting-a-container-image.md b/content/packages/guides/deleting-a-container-image.md similarity index 94% rename from content/packages/managing-container-images-with-github-container-registry/deleting-a-container-image.md rename to content/packages/guides/deleting-a-container-image.md index 1ca7bff3fbdf..11c6cabf8168 100644 --- a/content/packages/managing-container-images-with-github-container-registry/deleting-a-container-image.md +++ b/content/packages/guides/deleting-a-container-image.md @@ -2,6 +2,8 @@ title: Deleting a container image intro: 'You can delete a version of a private container image using GraphQL or on {% data variables.product.prodname_dotcom %}.' product: '{% data reusables.gated-features.packages %}' +redirect_from: + - /packages/managing-container-images-with-github-container-registry/deleting-a-container-image versions: free-pro-team: '*' --- diff --git a/content/packages/getting-started-with-github-container-registry/enabling-improved-container-support.md b/content/packages/guides/enabling-improved-container-support.md similarity index 96% rename from content/packages/getting-started-with-github-container-registry/enabling-improved-container-support.md rename to content/packages/guides/enabling-improved-container-support.md index dbfccede7f4e..6b2aad74f0d5 100644 --- a/content/packages/getting-started-with-github-container-registry/enabling-improved-container-support.md +++ b/content/packages/guides/enabling-improved-container-support.md @@ -2,6 +2,8 @@ title: Enabling improved container support intro: 'To use {% data variables.product.prodname_github_container_registry %}, you must enable it for your user or organization account.' product: '{% data reusables.gated-features.packages %}' +redirect_from: + - /packages/getting-started-with-github-container-registry/enabling-improved-container-support versions: free-pro-team: '*' --- diff --git a/content/packages/guides/index.md b/content/packages/guides/index.md new file mode 100644 index 000000000000..fee52527360d --- /dev/null +++ b/content/packages/guides/index.md @@ -0,0 +1,33 @@ +--- +title: Guides +shortTitle: Guides +intro: 'These guides help you configure {% data variables.product.prodname_actions %} or your package client to work with {% data variables.product.prodname_registry %}.' +redirect_from: + - /github/managing-packages-with-github-packages/using-github-packages-with-your-projects-ecosystem + - /packages/using-github-packages-with-your-projects-ecosystem +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' +--- + +{% data reusables.package_registry.packages-ghes-release-stage %} + +### Table of Contents + +{% topic_link_in_list /package-client-guides-for-github-packages %} + {% link_in_list /using-github-packages-with-github-actions %} + {% link_in_list /configuring-apache-maven-for-use-with-github-packages %} + {% link_in_list /configuring-gradle-for-use-with-github-packages %} + {% link_in_list /configuring-npm-for-use-with-github-packages %} + {% link_in_list /configuring-dotnet-cli-for-use-with-github-packages %} + {% link_in_list /configuring-rubygems-for-use-with-github-packages %} +{% topic_link_in_list /container-guides-for-github-packages %} + {% link_in_list /configuring-docker-for-use-with-github-packages %} + {% link_in_list /about-github-container-registry %} + {% link_in_list /migrating-to-github-container-registry-for-docker-images %} + {% link_in_list /enabling-improved-container-support %} + {% link_in_list /configuring-access-control-and-visibility-for-container-images %} + {% link_in_list /connecting-a-repository-to-a-container-image %} + {% link_in_list /pushing-and-pulling-docker-images %} + {% link_in_list /deleting-a-container-image %} + diff --git a/content/packages/getting-started-with-github-container-registry/migrating-to-github-container-registry-for-docker-images.md b/content/packages/guides/migrating-to-github-container-registry-for-docker-images.md similarity index 98% rename from content/packages/getting-started-with-github-container-registry/migrating-to-github-container-registry-for-docker-images.md rename to content/packages/guides/migrating-to-github-container-registry-for-docker-images.md index 8f647b482509..239f2d6ae2f5 100644 --- a/content/packages/getting-started-with-github-container-registry/migrating-to-github-container-registry-for-docker-images.md +++ b/content/packages/guides/migrating-to-github-container-registry-for-docker-images.md @@ -2,6 +2,8 @@ title: Migrating to GitHub Container Registry for Docker images intro: 'If you''ve used the GitHub Packages Docker registry to store Docker images, you can migrate to the new {% data variables.product.prodname_container_registry %}.' product: '{% data reusables.gated-features.packages %}' +redirect_from: + - /packages/getting-started-with-github-container-registry/migrating-to-github-container-registry-for-docker-images versions: free-pro-team: '*' --- diff --git a/content/packages/guides/package-client-guides-for-github-packages.md b/content/packages/guides/package-client-guides-for-github-packages.md new file mode 100644 index 000000000000..6f77e8b9bd3e --- /dev/null +++ b/content/packages/guides/package-client-guides-for-github-packages.md @@ -0,0 +1,10 @@ +--- +title: Package client guides for GitHub Packages +shortTitle: Package client guides for GitHub Packages +intro: 'You can publish and retrieve package client images using {% data variables.product.prodname_registry %}.' +mapTopic: true +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' +--- + diff --git a/content/packages/managing-container-images-with-github-container-registry/pushing-and-pulling-docker-images.md b/content/packages/guides/pushing-and-pulling-docker-images.md similarity index 97% rename from content/packages/managing-container-images-with-github-container-registry/pushing-and-pulling-docker-images.md rename to content/packages/guides/pushing-and-pulling-docker-images.md index 5dd0f067e25a..8e38906fbdc7 100644 --- a/content/packages/managing-container-images-with-github-container-registry/pushing-and-pulling-docker-images.md +++ b/content/packages/guides/pushing-and-pulling-docker-images.md @@ -2,6 +2,8 @@ title: Pushing and pulling Docker images intro: 'You can store and manage Docker images in {% data variables.product.prodname_github_container_registry %}.' product: '{% data reusables.gated-features.packages %}' +redirect_from: + - /packages/managing-container-images-with-github-container-registry/pushing-and-pulling-docker-images versions: free-pro-team: '*' --- diff --git a/content/packages/using-github-packages-with-your-projects-ecosystem/using-github-packages-with-github-actions.md b/content/packages/guides/using-github-packages-with-github-actions.md similarity index 97% rename from content/packages/using-github-packages-with-your-projects-ecosystem/using-github-packages-with-github-actions.md rename to content/packages/guides/using-github-packages-with-github-actions.md index 8875879a16f7..bb4ed48ec696 100644 --- a/content/packages/using-github-packages-with-your-projects-ecosystem/using-github-packages-with-github-actions.md +++ b/content/packages/guides/using-github-packages-with-github-actions.md @@ -4,6 +4,7 @@ intro: 'You can configure a workflow in {% data variables.product.prodname_actio product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/managing-packages-with-github-packages/using-github-packages-with-github-actions + - /packages/using-github-packages-with-your-projects-ecosystem/using-github-packages-with-github-actions versions: free-pro-team: '*' enterprise-server: '>=2.22' diff --git a/content/packages/index.md b/content/packages/index.md index e00d89f22a59..da52606f5d38 100644 --- a/content/packages/index.md +++ b/content/packages/index.md @@ -2,31 +2,43 @@ title: GitHub Packages Documentation shortTitle: GitHub Packages intro: 'Learn to safely publish and consume packages, store your packages alongside your code, and share your packages privately with your team or publicly with the open source community. You can also automate your packages with {% data variables.product.prodname_actions %}.' +introLinks: + quickstart: /packages/quickstart + reference: /packages/manage-packages featuredLinks: - gettingStarted: - - /packages/publishing-and-managing-packages/about-github-packages - - /packages/getting-started-with-github-container-registry/about-github-container-registry - - /packages/getting-started-with-github-container-registry - - /packages/managing-container-images-with-github-container-registry/pushing-and-pulling-docker-images - - /packages/publishing-and-managing-packages/publishing-a-package - - /packages/publishing-and-managing-packages/installing-a-package + guides: + - /packages/learn-github-packages + - /packages/guides/using-github-packages-with-github-actions + - /packages/manage-packages/installing-a-package popular: - - /packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages - - /packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages - - /packages/managing-container-images-with-github-container-registry/pushing-and-pulling-docker-images - - /packages/using-github-packages-with-your-projects-ecosystem/using-github-packages-with-github-actions + - /packages/guides/configuring-npm-for-use-with-github-packages + - /packages/learn-github-packages/about-github-packages + - /packages/guides/configuring-apache-maven-for-use-with-github-packages + guideCards: + - /packages/guides/configuring-npm-for-use-with-github-packages + - /packages/guides/enabling-improved-container-support + - /packages/guides/configuring-rubygems-for-use-with-github-packages +changelog: + - title: Packages container support is an opt-in beta + date: '2020-11-17' + href: https://docs.github.com/packages/getting-started-with-github-container-registry/enabling-improved-container-support + - title: Organization admins access to containers + date: '2020-11-16' + href: https://github.blog/changelog/2020-11-16-packages-organization-admins-access-to-containers/ + - title: Packages now respects IP allow list settings + date: '2020-11-12' + href: https://github.blog/changelog/2020-11-12-packages-now-respects-ip-allow-list-settings/ redirect_from: - /github/managing-packages-with-github-packages - /categories/managing-packages-with-github-package-registry - /github/managing-packages-with-github-package-registry +layout: product-landing versions: free-pro-team: '*' enterprise-server: '>=2.22' --- -{% data reusables.package_registry.packages-ghes-release-stage %} - -{% link_with_intro /getting-started-with-github-container-registry %} -{% link_with_intro /managing-container-images-with-github-container-registry %} -{% link_with_intro /publishing-and-managing-packages %} -{% link_with_intro /using-github-packages-with-your-projects-ecosystem %} + + + + diff --git a/content/packages/publishing-and-managing-packages/about-github-packages.md b/content/packages/learn-github-packages/about-github-packages.md similarity index 72% rename from content/packages/publishing-and-managing-packages/about-github-packages.md rename to content/packages/learn-github-packages/about-github-packages.md index 433a30c1cf38..1e2ef5b46373 100644 --- a/content/packages/publishing-and-managing-packages/about-github-packages.md +++ b/content/packages/learn-github-packages/about-github-packages.md @@ -6,6 +6,7 @@ redirect_from: - /articles/about-github-package-registry - /github/managing-packages-with-github-package-registry/about-github-package-registry - /github/managing-packages-with-github-packages/about-github-packages + - /packages/publishing-and-managing-packages/about-github-packages versions: free-pro-team: '*' enterprise-server: '>=2.22' @@ -22,7 +23,7 @@ You can integrate {% data variables.product.prodname_registry %} with {% data va {% data variables.product.prodname_registry %} offers different package registries for commonly used packages, such as for Node, RubyGems, Apache Maven, Gradle, and Nuget. {% if currentVersion == "free-pro-team@latest" %} -{% data variables.product.prodname_registry %} also offers a {% data variables.product.prodname_container_registry %} designed to support the unique needs of container images. For more information, see "[About {% data variables.product.prodname_github_container_registry %}](/packages/getting-started-with-github-container-registry/about-github-container-registry)." +{% data variables.product.prodname_registry %} also offers a {% data variables.product.prodname_container_registry %} designed to support the unique needs of container images. For more information, see "[About {% data variables.product.prodname_github_container_registry %}](/packages/guides/about-github-container-registry)." {% data reusables.package_registry.container-registry-beta %} @@ -32,34 +33,16 @@ You can integrate {% data variables.product.prodname_registry %} with {% data va #### Viewing packages -You can review the package's README, some metadata like licensing, download statistics, version history, and more on {% data variables.product.product_name %}. For more information, see "[Viewing packages](/packages/publishing-and-managing-packages/viewing-packages)." +You can review the package's README, some metadata like licensing, download statistics, version history, and more on {% data variables.product.product_name %}. For more information, see "[Viewing packages](/packages/manage-packages/viewing-packages)." #### About package permissions and visibility -{% if currentVersion == "free-pro-team@latest" %} - -| | 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.

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. - -{% else %} | | Package registries | |----|----| | Hosting locations | You can host multiple packages in one repository. | | Permissions | Each package inherits the permissions of the repository where the package is hosted.

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. | | Visibility | {% data reusables.package_registry.public-or-private-packages %} | -{% endif %} - -{% if currentVersion == "free-pro-team@latest" %} - -For more information about permissions and visibility for {% data variables.product.prodname_github_container_registry %}, see "[Configuring access control and visibility for containers](/packages/managing-container-images-with-github-container-registry/configuring-access-control-and-visibility-for-container-images)." - -{% endif %} - {% if currentVersion == "free-pro-team@latest" %} ### About billing for {% data variables.product.prodname_registry %} @@ -71,19 +54,6 @@ For more information about permissions and visibility for {% data variables.prod ### Supported clients and formats {% data variables.product.prodname_registry %} uses the native package tooling commands you're already familiar with to publish and install package versions. - -{% if currentVersion == "free-pro-team@latest" %} -#### Support for {% data variables.product.prodname_github_container_registry %} - -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. | - -For more information about the container support offered by {% data variables.product.prodname_github_container_registry %}, see "[About {% data variables.product.prodname_github_container_registry %}](/packages/getting-started-with-github-container-registry/about-github-container-registry)." -{% endif %} - #### Support for package registries {% if currentVersion == "free-pro-team@latest" %} @@ -142,34 +112,22 @@ For more information about subdomain isolation, see "[Enabling subdomain isolati {% endif %} -For more information about configuring your package client for use with {% data variables.product.prodname_registry %}, see "[Using {% data variables.product.prodname_registry %} with your project's ecosystem](/packages/using-github-packages-with-your-projects-ecosystem)." +For more information about configuring your package client for use with {% data variables.product.prodname_registry %}, see "[Package client guides for {% data variables.product.prodname_registry %}](/packages/guides/package-client-guides-for-github-packages)." +{% if currentVersion == "free-pro-team@latest" %} +For more information about Docker and {% data variables.product.prodname_github_container_registry %}, see "[Container guides for {% data variables.product.prodname_registry %}](/packages/guides/container-guides-for-github-packages)." +{% endif %} ### Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -{% if currentVersion == "free-pro-team@latest" %} -### About scopes and permissions for {% data variables.product.prodname_github_container_registry %} - -| 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/managing-container-images-with-github-container-registry/deleting-a-container-image)." | - -To learn about available scopes and permissions for container images, see "[About {% data variables.product.prodname_github_container_registry %}](/packages/getting-started-with-github-container-registry/about-github-container-registry)" or "[Configuring access control and visibility for container images](/packages/managing-container-images-with-github-container-registry/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)." - -{% endif %} - ### About scopes and permissions for package registries 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. For example: - To download and install packages from a repository, your token must have the `read:packages` scope, and your user account must have read permissions for the repository. -- To delete a specified version of a private package on {% data variables.product.product_name %}, your token must have the `delete:packages` and `repo` scope. Public packages cannot be deleted. For more information, see "[Deleting a package](/packages/publishing-and-managing-packages/deleting-a-package)." +- To delete a specified version of a private package on {% data variables.product.product_name %}, your token must have the `delete:packages` and `repo` scope. Public packages cannot be deleted. For more information, see "[Deleting a package](/packages/manage-packages/deleting-a-package)." | Scope | Description | Repository permissions | | --- | --- | --- | @@ -187,7 +145,7 @@ For more information, see: ### Managing packages -You can delete a version of a private package on {% data variables.product.product_name %} or using the GraphQL API. When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting a package](/packages/publishing-and-managing-packages/deleting-a-package)" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." +You can delete a version of a private package on {% data variables.product.product_name %} or using the GraphQL API. When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting a package](/packages/manage-packages/deleting-a-package)" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." diff --git a/content/packages/getting-started-with-github-container-registry/core-concepts-for-github-container-registry.md b/content/packages/learn-github-packages/core-concepts-for-github-packages.md similarity index 77% rename from content/packages/getting-started-with-github-container-registry/core-concepts-for-github-container-registry.md rename to content/packages/learn-github-packages/core-concepts-for-github-packages.md index 0eb31c63278e..07b7774cd7fc 100644 --- a/content/packages/getting-started-with-github-container-registry/core-concepts-for-github-container-registry.md +++ b/content/packages/learn-github-packages/core-concepts-for-github-packages.md @@ -1,16 +1,15 @@ --- -title: Core concepts for GitHub Container Registry -intro: 'Below is a list of common {% data variables.product.prodname_github_container_registry %} terms we use across our sites and documentation.' +title: Core concepts for GitHub Packages +intro: 'Below is a list of common {% data variables.product.prodname_registry %} terms we use across our sites and documentation.' product: '{% data reusables.gated-features.packages %}' +redirect_from: + - /packages/getting-started-with-github-container-registry/core-concepts-for-github-container-registry versions: free-pro-team: '*' + enterprise-server: '>=2.22' --- -{% data reusables.package_registry.container-registry-beta %} - -### {% data variables.product.prodname_github_container_registry %} - -The {% data variables.product.prodname_github_container_registry %} is a registry for containers with support for Docker images. For more information, see "[About {% data variables.product.prodname_github_container_registry %}](/packages/getting-started-with-github-container-registry/about-github-container-registry)." +{% data reusables.package_registry.packages-ghes-release-stage %} ### Package diff --git a/content/packages/learn-github-packages/index.md b/content/packages/learn-github-packages/index.md new file mode 100644 index 000000000000..a21e10fe4cbc --- /dev/null +++ b/content/packages/learn-github-packages/index.md @@ -0,0 +1,16 @@ +--- +title: Learn GitHub Packages +shortTitle: Learn GitHub Packages +intro: 'You can find out more about GitHub Packages, including publishing new packages to {% data variables.product.prodname_registry %}.' +redirect_from: + - /packages/getting-started-with-github-container-registry +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' +--- + +{% data reusables.package_registry.packages-ghes-release-stage %} + +{% link_in_list /about-github-packages %} +{% link_in_list /core-concepts-for-github-packages %} +{% link_in_list /publishing-a-package %} diff --git a/content/packages/publishing-and-managing-packages/publishing-a-package.md b/content/packages/learn-github-packages/publishing-a-package.md similarity index 97% rename from content/packages/publishing-and-managing-packages/publishing-a-package.md rename to content/packages/learn-github-packages/publishing-a-package.md index e44f7a900084..9294af45b6b9 100644 --- a/content/packages/publishing-and-managing-packages/publishing-a-package.md +++ b/content/packages/learn-github-packages/publishing-a-package.md @@ -4,6 +4,7 @@ intro: 'You can publish a package to {% data variables.product.prodname_registry product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/managing-packages-with-github-packages/publishing-a-package + - /packages/publishing-and-managing-packages/publishing-a-package permissions: Anyone with write permissions for a repository can publish a package to that repository. versions: free-pro-team: '*' diff --git a/content/packages/publishing-and-managing-packages/deleting-a-package.md b/content/packages/manage-packages/deleting-a-package.md similarity index 96% rename from content/packages/publishing-and-managing-packages/deleting-a-package.md rename to content/packages/manage-packages/deleting-a-package.md index 3ac14a5879bc..b820d5f65afb 100644 --- a/content/packages/publishing-and-managing-packages/deleting-a-package.md +++ b/content/packages/manage-packages/deleting-a-package.md @@ -4,6 +4,7 @@ intro: 'You can delete a version of a private package using GraphQL or on {% dat product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/managing-packages-with-github-packages/deleting-a-package + - /packages/publishing-and-managing-packages/deleting-a-package versions: free-pro-team: '*' enterprise-server: '>=2.22' @@ -14,7 +15,7 @@ versions: {% if currentVersion == "free-pro-team@latest" %} ### About container image deletion -To delete a container image package on {% data variables.product.product_name %}, see "[Deleting a container image](/packages/managing-container-images-with-github-container-registry/deleting-a-container-image)." +To delete a container image package on {% data variables.product.product_name %}, see "[Deleting a container image](/packages/guides/deleting-a-container-image)." {% endif %} diff --git a/content/packages/publishing-and-managing-packages/index.md b/content/packages/manage-packages/index.md similarity index 75% rename from content/packages/publishing-and-managing-packages/index.md rename to content/packages/manage-packages/index.md index e69cc46f750f..7f313028a1b0 100644 --- a/content/packages/publishing-and-managing-packages/index.md +++ b/content/packages/manage-packages/index.md @@ -1,9 +1,11 @@ --- -title: Publishing and managing packages -shortTitle: Publishing and managing packages +title: Managing GitHub packages +shortTitle: Managing GitHub packages intro: 'You can publish new packages to {% data variables.product.prodname_registry %}, view and install existing packages, and, in special circumstances, delete existing packages.' redirect_from: - /github/managing-packages-with-github-packages/publishing-and-managing-packages + - /github/packages/publishing-and-managing-packages + - /packages/publishing-and-managing-packages versions: free-pro-team: '*' enterprise-server: '>=2.22' @@ -11,8 +13,6 @@ versions: {% data reusables.package_registry.packages-ghes-release-stage %} -{% link_in_list /about-github-packages %} -{% link_in_list /publishing-a-package %} {% link_in_list /viewing-packages %} {% link_in_list /installing-a-package %} {% link_in_list /deleting-a-package %} diff --git a/content/packages/publishing-and-managing-packages/installing-a-package.md b/content/packages/manage-packages/installing-a-package.md similarity index 96% rename from content/packages/publishing-and-managing-packages/installing-a-package.md rename to content/packages/manage-packages/installing-a-package.md index cb2b1f16ad28..007e34408996 100644 --- a/content/packages/publishing-and-managing-packages/installing-a-package.md +++ b/content/packages/manage-packages/installing-a-package.md @@ -4,6 +4,7 @@ intro: 'You can install a package from {% data variables.product.prodname_regist product: '{% data reusables.gated-features.packages %}' redirect_from: - /github/managing-packages-with-github-packages/installing-a-package + - /packages/publishing-and-managing-packages/installing-a-package permissions: Anyone with read permissions for a repository can install a package from that repository. versions: free-pro-team: '*' diff --git a/content/packages/publishing-and-managing-packages/viewing-packages.md b/content/packages/manage-packages/viewing-packages.md similarity index 97% rename from content/packages/publishing-and-managing-packages/viewing-packages.md rename to content/packages/manage-packages/viewing-packages.md index 55ba29e41806..d61604627ea1 100644 --- a/content/packages/publishing-and-managing-packages/viewing-packages.md +++ b/content/packages/manage-packages/viewing-packages.md @@ -6,6 +6,7 @@ redirect_from: - /articles/viewing-a-repositorys-packages - /github/managing-packages-with-github-packages/publishing-and-managing-packages/viewing-a-repositorys-packages - /github/managing-packages-with-github-packages/viewing-packages + - /packages/publishing-and-managing-packages/viewing-packages permissions: Anyone with read permissions to a repository can view the repository's packages. versions: free-pro-team: '*' diff --git a/content/packages/managing-container-images-with-github-container-registry/index.md b/content/packages/managing-container-images-with-github-container-registry/index.md deleted file mode 100644 index c556ba7b516c..000000000000 --- a/content/packages/managing-container-images-with-github-container-registry/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Managing container images with GitHub Container Registry -intro: 'Learn how to manage container images using a supported CLI or on {% data variables.product.prodname_dotcom %}.' -versions: - free-pro-team: '*' ---- - -{% link_in_list /configuring-access-control-and-visibility-for-container-images %} -{% link_in_list /connecting-a-repository-to-a-container-image %} -{% link_in_list /pushing-and-pulling-docker-images %} -{% link_in_list /deleting-a-container-image %} diff --git a/content/packages/quickstart.md b/content/packages/quickstart.md new file mode 100644 index 000000000000..cf353a4d1b54 --- /dev/null +++ b/content/packages/quickstart.md @@ -0,0 +1,109 @@ +--- +title: Quickstart for GitHub Packages +intro: 'Publish to {% data variables.product.prodname_registry %} in 5 minutes or less with {% data variables.product.prodname_actions %}.' +allowTitleToDifferFromFilename: true +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' +--- + +### Introduction + +You only need an existing {% data variables.product.prodname_dotcom %} repository to publish a package to {% data variables.product.prodname_registry %}. In this guide, you'll create a {% data variables.product.prodname_actions %} workflow to test your code and then publish it to {% data variables.product.prodname_registry %}. Feel free to create a new repository for this Quickstart. You can use it to test this and future {% data variables.product.prodname_actions %} workflows. + +### Publishing your package + +1. Create a new repository on {% data variables.product.prodname_dotcom %}, adding the `.gitignore` for Node. Create a private repository if you’d like to delete this package later, public packages cannot be deleted. For more information, see "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)." +2. Clone the repository to your local machine. + {% raw %} + ```shell + $ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git + $ cd YOUR-REPOSITORY + ``` + {% endraw %} +3. Create an `index.js` file and add a basic alert to say "Hello world!" + {% raw %} + ```javascript{:copy} + alert("Hello, World!"); + ``` + {% endraw %} +4. Initialize an npm package. In the package initialization wizard, enter your package with the name: _`@YOUR-USERNAME/YOUR-REPOSITORY`_, and set the test script to `exit 0` if you do not have any tests. Commit your changes and push them to {% data variables.product.prodname_dotcom %}. + {% raw %} + ```shell + $ npm init + ... + package name: @YOUR-USERNAME/YOUR-REPOSITORY + ... + test command: exit 0 + ... + + $ npm install + $ git add index.js package.json package-lock.json + $ git commit -m "initialize npm package" + $ git push + ``` + {% endraw %} +5. From your repository on {% data variables.product.prodname_dotcom %}, create a new file in the `.github/workflows` directory named `release-package.yml`. For more information, see "[Creating new files](/github/managing-files-in-a-repository/creating-new-files)." +6. Copy the following YAML content into the `release-package.yml` file. + {% raw %} + ```yaml{:copy} + name: Node.js Package + + on: + release: + types: [created] + + jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v1 + with: + node-version: 12 + - run: npm ci + - run: npm test + + publish-gpr: + needs: build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v1 + with: + node-version: 12 + registry-url: https://npm.pkg.github.com/ + - run: npm ci + - run: npm publish + env: + NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}} + ``` + {% endraw %} +7. Scroll to the bottom of the page and select **Create a new branch for this commit and start a pull request**. Then, to create a pull request, click **Propose new file**. +8. **Merge** the pull request. +9. Navigate to the **Code** tab and create a new release to test the workflow. For more information, see "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release)." + +Creating a new release in your repository triggers the workflow to build and test your code. If the tests pass, then the package will be published to {% data variables.product.prodname_registry %}. + +### Viewing your published package + +Packages are published at the repository level. You can see all the packages in a repository and search for a specific package. + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.package_registry.packages-from-code-tab %} +{% data reusables.package_registry.navigate-to-packages %} + + +### Installing a published package + +Now that you've published the package, you'll want to use it as a dependency across your projects. For more information, see "[Configuring npm for use with {% data variables.product.prodname_registry %}](/packages/guides/configuring-npm-for-use-with-github-packages#installing-a-package)." + +### Next steps + +The basic workflow you just added runs any time a new release is created in your repository. But, this is only the beginning of what you can do with {% data variables.product.prodname_registry %}. You can publish your package to multiple registries with a single workflow, trigger the workflow to run on different events such as a merged pull request, manage containers, and more. + +Combining {% data variables.product.prodname_registry %} and {% data variables.product.prodname_actions %} can help you automate nearly every aspect of your application development processes. Ready to get started? Here are some helpful resources for taking your next steps with {% data variables.product.prodname_registry %} and {% data variables.product.prodname_actions %}: + +- "[Learn {% data variables.product.prodname_registry %}](/packages/learn-github-packages)" for an in-depth tutorial on GitHub Packages +- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" for an in-depth tutorial on GitHub Actions +- "[Guides](/packages/guides)" for specific uses cases and examples diff --git a/content/packages/using-github-packages-with-your-projects-ecosystem/index.md b/content/packages/using-github-packages-with-your-projects-ecosystem/index.md deleted file mode 100644 index 02c88cf6323e..000000000000 --- a/content/packages/using-github-packages-with-your-projects-ecosystem/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Using GitHub Packages with your project's ecosystem -shortTitle: Using GitHub Packages with your project's ecosystem -intro: 'You can configure {% data variables.product.prodname_actions %} or your package client to work with {% data variables.product.prodname_registry %}.' -redirect_from: - - /github/managing-packages-with-github-packages/using-github-packages-with-your-projects-ecosystem -versions: - free-pro-team: '*' - enterprise-server: '>=2.22' ---- - -{% data reusables.package_registry.packages-ghes-release-stage %} - -{% link_in_list /using-github-packages-with-github-actions %} -{% link_in_list /configuring-docker-for-use-with-github-packages %} -{% link_in_list /configuring-apache-maven-for-use-with-github-packages %} -{% link_in_list /configuring-gradle-for-use-with-github-packages %} -{% link_in_list /configuring-npm-for-use-with-github-packages %} -{% link_in_list /configuring-dotnet-cli-for-use-with-github-packages %} -{% link_in_list /configuring-rubygems-for-use-with-github-packages %} diff --git a/content/rest/overview/resources-in-the-rest-api.md b/content/rest/overview/resources-in-the-rest-api.md index 30cc142a97e2..0dce11161924 100644 --- a/content/rest/overview/resources-in-the-rest-api.md +++ b/content/rest/overview/resources-in-the-rest-api.md @@ -301,18 +301,22 @@ gem: ### Pagination Requests that return multiple items will be paginated to 30 items by -default. You can specify further pages with the `?page` parameter. For some -resources, you can also set a custom page size up to 100 with the `?per_page` parameter. -Note that for technical reasons not all endpoints respect the `?per_page` parameter, +default. You can specify further pages with the `page` parameter. For some +resources, you can also set a custom page size up to 100 with the `per_page` parameter. +Note that for technical reasons not all endpoints respect the `per_page` parameter, see [events](/rest/reference/activity#events) for example. ```shell $ curl '{% data variables.product.api_url_pre %}/user/repos?page=2&per_page=100' ``` -Note that page numbering is 1-based and that omitting the `?page` +Note that page numbering is 1-based and that omitting the `page` parameter will return the first page. +Some endpoints use cursor-based pagination. A cursor is a string that points to a location in the result set. +With cursor-based pagination, there is no fixed concept of "pages" in the result set, so you can't navigate to a specific page. +Instead, you can traverse the results by using the `before` or `after` parameters. + For more information on pagination, check out our guide on [Traversing with Pagination][pagination-guide]. #### Link header @@ -323,13 +327,17 @@ For more information on pagination, check out our guide on [Traversing with Pagi {% endnote %} -The [Link header](http://tools.ietf.org/html/rfc5988) includes pagination information: +The [Link header](http://tools.ietf.org/html/rfc5988) includes pagination information. For example: Link: <{% data variables.product.api_url_code %}/user/repos?page=3&per_page=100>; rel="next", <{% data variables.product.api_url_code %}/user/repos?page=50&per_page=100>; rel="last" _The example includes a line break for readability._ +Or, if the endpoint uses cursor-based pagination: + + Link: <{% data variables.product.api_url_code %}/orgs/ORG/audit-log?after=MTYwMTkxOTU5NjQxM3xZbGI4VE5EZ1dvZTlla09uWjhoZFpR&before=>; rel="next", + This `Link` response header contains one or more [Hypermedia](/rest#hypermedia) link relations, some of which may require expansion as [URI templates](http://tools.ietf.org/html/rfc6570). The possible `rel` values are: diff --git a/content/rest/reference/enterprise-admin.md b/content/rest/reference/enterprise-admin.md index e95dc2be2a94..a35266becc0a 100644 --- a/content/rest/reference/enterprise-admin.md +++ b/content/rest/reference/enterprise-admin.md @@ -60,6 +60,16 @@ You can also read the current version by calling the [meta endpoint](/rest/refer {% endif %} +{% if currentVersion == "free-pro-team@latest" %} + +## Audit log + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'audit-log' %}{% include rest_operation %}{% endif %} +{% endfor %} + +{% endif %} + {% if currentVersion == "free-pro-team@latest" %} ## Billing diff --git a/data/reusables/actions/visualization-beta.md b/data/reusables/actions/visualization-beta.md new file mode 100644 index 000000000000..ee3ad11ef4b9 --- /dev/null +++ b/data/reusables/actions/visualization-beta.md @@ -0,0 +1,7 @@ +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% note %} + +**Note:** The workflow visualization graph for {% data variables.product.prodname_actions %} is currently in beta and subject to change. + +{% endnote %} +{% endif %} diff --git a/data/reusables/audit_log/audit-log-api-info.md b/data/reusables/audit_log/audit-log-api-info.md new file mode 100644 index 000000000000..55728a169240 --- /dev/null +++ b/data/reusables/audit_log/audit-log-api-info.md @@ -0,0 +1,5 @@ +* 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 {% data variables.product.prodname_github_app %} diff --git a/data/reusables/audit_log/audit-log-git-events-retention.md b/data/reusables/audit_log/audit-log-git-events-retention.md new file mode 100644 index 000000000000..3f1584bf91a2 --- /dev/null +++ b/data/reusables/audit_log/audit-log-git-events-retention.md @@ -0,0 +1 @@ +The audit log retains Git events for 7 days. This is shorter than other audit log events, which can be retained for 90 days. diff --git a/data/reusables/package_registry/billing-for-container-registry.md b/data/reusables/package_registry/billing-for-container-registry.md index 7cf8e2459f34..479e2d5b552b 100644 --- a/data/reusables/package_registry/billing-for-container-registry.md +++ b/data/reusables/package_registry/billing-for-container-registry.md @@ -1,3 +1,3 @@ -During the {% data variables.product.prodname_github_container_registry %} beta, both the new {% data variables.product.prodname_container_registry %} and existing {% data variables.product.prodname_registry %} Docker registry will be free. For more information about the {% data variables.product.prodname_registry %} Docker registry, see "[Configuring Docker for use with {% data variables.product.prodname_registry %}](/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages)." +During the {% data variables.product.prodname_github_container_registry %} beta, both the new {% data variables.product.prodname_container_registry %} and existing {% data variables.product.prodname_registry %} Docker registry will be free. For more information about the {% data variables.product.prodname_registry %} Docker registry, see "[Configuring Docker for use with {% data variables.product.prodname_registry %}](/packages/guides/configuring-docker-for-use-with-github-packages)." After the beta, the same billing and storage rates that other {% data variables.product.prodname_registry %} registries use will apply to the container registry. For more information, see "[About billing for {% data variables.product.prodname_registry %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages)." diff --git a/data/reusables/package_registry/container-registry-beta-billing-note.md b/data/reusables/package_registry/container-registry-beta-billing-note.md index ccc4fc14f879..f588ab6f9b12 100644 --- a/data/reusables/package_registry/container-registry-beta-billing-note.md +++ b/data/reusables/package_registry/container-registry-beta-billing-note.md @@ -1,5 +1,5 @@ {% note %} -**Billing update for container image storage:** During the beta phase of {% data variables.product.prodname_github_container_registry %}, Docker image storage and bandwidth are free for the old `docker.pkg.github.com` and new `ghcr.io` hosting services. For more information, see "[About {% data variables.product.prodname_github_container_registry %}](/packages/getting-started-with-github-container-registry/about-github-container-registry)." +**Billing update for container image storage:** During the beta phase of {% data variables.product.prodname_github_container_registry %}, Docker image storage and bandwidth are free for the old `docker.pkg.github.com` and new `ghcr.io` hosting services. For more information, see "[About {% data variables.product.prodname_github_container_registry %}](/packages/guides/about-github-container-registry)." {% endnote %} diff --git a/data/reusables/package_registry/container-registry-beta.md b/data/reusables/package_registry/container-registry-beta.md index 24313880baea..6bd738198e15 100644 --- a/data/reusables/package_registry/container-registry-beta.md +++ b/data/reusables/package_registry/container-registry-beta.md @@ -1,5 +1,5 @@ {% 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 preview. For more information, see "[About {% data variables.product.prodname_github_container_registry %}](/packages/getting-started-with-github-container-registry/about-github-container-registry)" and "[Enabling improved container support](/packages/getting-started-with-github-container-registry/enabling-improved-container-support)." +**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 preview. For more information, see "[About {% data variables.product.prodname_github_container_registry %}](/packages/guides/about-github-container-registry)" and "[Enabling improved container support](/packages/guides/enabling-improved-container-support)." {% endnote %} diff --git a/data/reusables/package_registry/docker_registry_deprecation_status.md b/data/reusables/package_registry/docker_registry_deprecation_status.md index 2df9364c317f..a23fdc598bc1 100644 --- a/data/reusables/package_registry/docker_registry_deprecation_status.md +++ b/data/reusables/package_registry/docker_registry_deprecation_status.md @@ -1,5 +1,5 @@ {% warning %} -**Note:** The {% data variables.product.prodname_registry %} Docker registry will be superseded by {% data variables.product.prodname_github_container_registry %}{% if enterpriseServerVersions contains currentVersion %} in a future {% data variables.product.product_name %} release{% endif %}.{% if currentVersion == "free-pro-team@latest" %} To learn how to migrate your existing Docker images and any workflows using them, see "[Migrating to {% data variables.product.prodname_github_container_registry %} for Docker images](/packages/getting-started-with-github-container-registry/migrating-to-github-container-registry-for-docker-images)" and "[Getting started with {% data variables.product.prodname_github_container_registry %}](/packages/getting-started-with-github-container-registry)."{% endif %} +**Note:** The {% data variables.product.prodname_registry %} Docker registry will be superseded by {% data variables.product.prodname_github_container_registry %}{% if enterpriseServerVersions contains currentVersion %} in a future {% data variables.product.product_name %} release{% endif %}.{% if currentVersion == "free-pro-team@latest" %} To learn how to migrate your existing Docker images and any workflows using them, see "[Migrating to {% data variables.product.prodname_github_container_registry %} for Docker images](/packages/guides/migrating-to-github-container-registry-for-docker-images)" and "[Container guides for {% data variables.product.prodname_registry %}](/packages/guides/container-guides-for-github-packages)."{% endif %} {% endwarning %} diff --git a/data/reusables/package_registry/feature-preview-for-container-registry.md b/data/reusables/package_registry/feature-preview-for-container-registry.md index b0cddc8bcb84..3b74dd6c780b 100644 --- a/data/reusables/package_registry/feature-preview-for-container-registry.md +++ b/data/reusables/package_registry/feature-preview-for-container-registry.md @@ -1,5 +1,5 @@ {% note %} -**Note:** Before you can 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)." +**Note:** Before you can 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 %} \ No newline at end of file diff --git a/data/reusables/package_registry/required-scopes.md b/data/reusables/package_registry/required-scopes.md index ec9748d65ac5..364cdccaef88 100644 --- a/data/reusables/package_registry/required-scopes.md +++ b/data/reusables/package_registry/required-scopes.md @@ -1 +1 @@ -You must use a personal access token with the appropriate scopes to publish and install packages in {% data variables.product.prodname_registry %}. For more information, see "[About {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)." +You must use a personal access token with the appropriate scopes to publish and install packages in {% data variables.product.prodname_registry %}. For more information, see "[About {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-github-packages#authenticating-to-github-packages)." diff --git a/data/reusables/package_registry/viewing-packages.md b/data/reusables/package_registry/viewing-packages.md index 7a16420a9777..131b04989a06 100644 --- a/data/reusables/package_registry/viewing-packages.md +++ b/data/reusables/package_registry/viewing-packages.md @@ -1 +1 @@ -After you publish a package, you can view the package on {% data variables.product.prodname_dotcom %}. For more information, see "[Viewing packages](/packages/publishing-and-managing-packages/viewing-packages)." +After you publish a package, you can view the package on {% data variables.product.prodname_dotcom %}. For more information, see "[Viewing packages](/packages/manage-packages/viewing-packages)." diff --git a/data/reusables/repositories/dependency-review.md b/data/reusables/repositories/dependency-review.md new file mode 100644 index 000000000000..0d33834eeccd --- /dev/null +++ b/data/reusables/repositories/dependency-review.md @@ -0,0 +1,3 @@ +{% if currentVersion == "free-pro-team@latest" %} +Additionally, {% data variables.product.prodname_dotcom %} can review any dependencies added, updated, or removed in a pull request made against the default branch of a repository, and flag any changes that would introduce a vulnerability into your project. This allows you to spot and deal with vulnerable dependencies before, rather than after, they reach your codebase. 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 %} \ No newline at end of file diff --git a/data/reusables/repositories/navigate-to-job-superlinter.md b/data/reusables/repositories/navigate-to-job-superlinter.md index d61e61031b9d..29a8d2e6f65e 100644 --- a/data/reusables/repositories/navigate-to-job-superlinter.md +++ b/data/reusables/repositories/navigate-to-job-superlinter.md @@ -1,7 +1,10 @@ -{% 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. + ![Lint code base job](/assets/images/help/repository/superlinter-lint-code-base-job-updated.png) +{% elsif currentVersion ver_gt "enterprise-server@2.22" %} 1. In the left sidebar, click the job you want to see. ![Lint code base job](/assets/images/help/repository/superlinter-lint-code-base-job.png) {% else %} 1. In the left sidebar, click the job you want to see. ![Select a workflow job](/assets/images/help/repository/workflow-job.png) -{% endif %} \ No newline at end of file +{% endif %} diff --git a/data/reusables/repositories/view-failed-job-results-superlinter.md b/data/reusables/repositories/view-failed-job-results-superlinter.md index 62430616893c..c8c23f7677e3 100644 --- a/data/reusables/repositories/view-failed-job-results-superlinter.md +++ b/data/reusables/repositories/view-failed-job-results-superlinter.md @@ -1,6 +1,8 @@ {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} 1. Any failed steps are automatically expanded to display the results. - ![Super linter workflow results](/assets/images/help/repository/super-linter-workflow-results-updated.png) + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} + ![Super linter workflow results](/assets/images/help/repository/super-linter-workflow-results-updated-2.png){% else %} + ![Super linter workflow results](/assets/images/help/repository/super-linter-workflow-results-updated.png){% endif %} {% else %} 1. Expand the **Run Super-Linter** step to view the results. ![Super linter workflow results](/assets/images/help/repository/super-linter-workflow-results.png) diff --git a/data/reusables/repositories/view-specific-line-superlinter.md b/data/reusables/repositories/view-specific-line-superlinter.md index bfffe68a9490..3dd5af281dd9 100644 --- a/data/reusables/repositories/view-specific-line-superlinter.md +++ b/data/reusables/repositories/view-specific-line-superlinter.md @@ -1,6 +1,10 @@ {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} 1. Optionally, to get a link to a specific line in the logs, click on the step's line number. You can then copy the link from the address bar of your web browser. + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} + ![Button to copy link](/assets/images/help/repository/copy-link-button-updated-2.png) + {% else %} ![Button to copy link](/assets/images/help/repository/copy-link-button-updated.png) + {% endif %} {% else %} 1. Optionally, to get a link to a specific line in the logs, click on the step's line number. You can then copy the link from the address bar of your web browser. ![Button to copy link](/assets/images/help/repository/copy-link-button.png) diff --git a/data/reusables/sponsors/billing-switcher.md b/data/reusables/sponsors/billing-switcher.md new file mode 100644 index 000000000000..0388b53d7fc1 --- /dev/null +++ b/data/reusables/sponsors/billing-switcher.md @@ -0,0 +1,2 @@ +1. Optionally, to manage your sponsorship on behalf of an organization, in the upper-left corner, use the **Personal settings** drop-down menu, and click the organization. + ![Drop-down menu to switch accounts for settings](/assets/images/help/sponsors/billing-account-switcher.png) diff --git a/data/reusables/sponsors/change-tier.md b/data/reusables/sponsors/change-tier.md index 6843e3f196b7..9f4b7be31e8d 100644 --- a/data/reusables/sponsors/change-tier.md +++ b/data/reusables/sponsors/change-tier.md @@ -1,2 +1,2 @@ -1. 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 **Change tier**. +1. Under "{% data variables.product.prodname_sponsors %}", to the right of the sponsored account, click {% octicon "triangle-down" aria-label="The down triangle octicon" %} next to your tier amount, then click **Change tier**. ![Change tier button](/assets/images/help/billing/edit-sponsor-billing.png) diff --git a/data/reusables/sponsors/choose-updates.md b/data/reusables/sponsors/choose-updates.md new file mode 100644 index 000000000000..0fbb1010cfc8 --- /dev/null +++ b/data/reusables/sponsors/choose-updates.md @@ -0,0 +1,2 @@ +4. Decide whether you want to receive email updates from the sponsored account, then select or unselect "Receive updates from _ACCOUNT_." + ![Checkbox to receive updates from sponsored account](/assets/images/help/sponsors/updates-checkbox-manage.png) diff --git a/data/reusables/sponsors/developer-sponsored-choose-updates.md b/data/reusables/sponsors/developer-sponsored-choose-updates.md deleted file mode 100644 index 5fcd5548e623..000000000000 --- a/data/reusables/sponsors/developer-sponsored-choose-updates.md +++ /dev/null @@ -1,2 +0,0 @@ -4. Decide whether you want to receive email updates from the sponsored developer, then select or unselect "Receive updates from _DEVELOPER_." - ![Checkbox to receive updates from sponsored developer](/assets/images/help/sponsors/updates-checkbox-manage.png) diff --git a/data/reusables/sponsors/manage-developer-sponsorship.md b/data/reusables/sponsors/manage-developer-sponsorship.md deleted file mode 100644 index a0aa74633919..000000000000 --- a/data/reusables/sponsors/manage-developer-sponsorship.md +++ /dev/null @@ -1,4 +0,0 @@ -1. Under the developer's name, click **Sponsoring**. - ![Sponsoring button](/assets/images/help/profile/sponsoring-button.png) -2. On the right side of the page, click **Manage your sponsorship**. - ![Manage your sponsorship button](/assets/images/help/sponsors/manage-your-sponsorship-button.png) diff --git a/data/reusables/sponsors/manage-org-sponsorship.md b/data/reusables/sponsors/manage-org-sponsorship.md deleted file mode 100644 index 9d79bfca658d..000000000000 --- a/data/reusables/sponsors/manage-org-sponsorship.md +++ /dev/null @@ -1,4 +0,0 @@ -1. Next to the organization's name, click **Sponsoring**. - ![Sponsoring button](/assets/images/help/sponsors/org-sponsoring-button.png) -2. On the right side of the page, click **Manage your sponsorship**. - ![Manage your sponsorship button](/assets/images/help/sponsors/manage-your-sponsorship-button.png) diff --git a/data/reusables/sponsors/manage-sponsorship.md b/data/reusables/sponsors/manage-sponsorship.md new file mode 100644 index 000000000000..f977c24446ad --- /dev/null +++ b/data/reusables/sponsors/manage-sponsorship.md @@ -0,0 +1,2 @@ +1. To the right of your current tier, click **Manage**. + ![Manage your sponsorship button](/assets/images/help/sponsors/manage-your-sponsorship-button.png) \ No newline at end of file diff --git a/data/reusables/sponsors/manage-updates-for-orgs.md b/data/reusables/sponsors/manage-updates-for-orgs.md new file mode 100644 index 000000000000..0cd08d538242 --- /dev/null +++ b/data/reusables/sponsors/manage-updates-for-orgs.md @@ -0,0 +1 @@ +You can designate which email address receives updates from the accounts your organization sponsors. For more information, see "[Managing updates from accounts your organization sponsors](/github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors)." diff --git a/data/reusables/sponsors/maximum-tier.md b/data/reusables/sponsors/maximum-tier.md index a787f1dd0a5f..803658fba463 100644 --- a/data/reusables/sponsors/maximum-tier.md +++ b/data/reusables/sponsors/maximum-tier.md @@ -1 +1 @@ -The maximum price is US$6000 per month. +The maximum price is US$12,000 per month. diff --git a/data/reusables/sponsors/navigate-to-org-sponsors-dashboard.md b/data/reusables/sponsors/navigate-to-org-sponsors-dashboard.md deleted file mode 100644 index 412a13fa2411..000000000000 --- a/data/reusables/sponsors/navigate-to-org-sponsors-dashboard.md +++ /dev/null @@ -1,4 +0,0 @@ -1. In the upper-right corner of any page, click your profile photo, then click **{% data variables.product.prodname_sponsors %}**. -![{% data variables.product.prodname_sponsors %} button](/assets/images/help/sponsors/access-github-sponsors-dashboard.png) -2. In the list of your sponsored and eligible accounts, to the right of the organization, click **Dashboard**. -![Organization sponsors dashboard button](/assets/images/help/sponsors/org-sponsors-dashboard-button.png) diff --git a/data/reusables/sponsors/navigate-to-sponsored-developer.md b/data/reusables/sponsors/navigate-to-sponsored-account.md similarity index 66% rename from data/reusables/sponsors/navigate-to-sponsored-developer.md rename to data/reusables/sponsors/navigate-to-sponsored-account.md index e983650eb5ae..def70f43f162 100644 --- a/data/reusables/sponsors/navigate-to-sponsored-developer.md +++ b/data/reusables/sponsors/navigate-to-sponsored-account.md @@ -1 +1 @@ -1. On {% data variables.product.product_name %}, navigate to the sponsored developer's profile. +1. On {% data variables.product.product_name %}, navigate to the sponsored account's profile. diff --git a/data/reusables/sponsors/navigate-to-sponsored-org.md b/data/reusables/sponsors/navigate-to-sponsored-org.md deleted file mode 100644 index 6acd162cfd4a..000000000000 --- a/data/reusables/sponsors/navigate-to-sponsored-org.md +++ /dev/null @@ -1 +0,0 @@ -1. On {% data variables.product.product_name %}, navigate to the sponsored organization's profile. diff --git a/data/reusables/sponsors/navigate-to-dev-sponsors-dashboard.md b/data/reusables/sponsors/navigate-to-sponsors-dashboard.md similarity index 86% rename from data/reusables/sponsors/navigate-to-dev-sponsors-dashboard.md rename to data/reusables/sponsors/navigate-to-sponsors-dashboard.md index 8ed7f17a33d8..639106087454 100644 --- a/data/reusables/sponsors/navigate-to-dev-sponsors-dashboard.md +++ b/data/reusables/sponsors/navigate-to-sponsors-dashboard.md @@ -1,4 +1,4 @@ 1. In the upper-right corner of any page, click your profile photo, then click **{% data variables.product.prodname_sponsors %}**. ![{% data variables.product.prodname_sponsors %} button](/assets/images/help/sponsors/access-github-sponsors-dashboard.png) -2. If a list of your sponsored and eligible accounts is shown, to the right of your account name, click **Dashboard**. +2. If a list of your sponsored and eligible accounts is shown, to the right of the account you want to manage, click **Dashboard**. ![Developer sponsors dashboard button](/assets/images/help/sponsors/dev-sponsors-dashboard-button.png) diff --git a/data/reusables/sponsors/no-fees.md b/data/reusables/sponsors/no-fees.md index a122d94bbbb1..dd829bafdc03 100644 --- a/data/reusables/sponsors/no-fees.md +++ b/data/reusables/sponsors/no-fees.md @@ -1 +1 @@ -{% data variables.product.prodname_sponsors %} does not charge any fees for sponsorships from user accounts, so 100% of these sponsorships go to the sponsored developer or organization. +{% data variables.product.prodname_sponsors %} does not charge any fees for sponsorships from user accounts, so 100% of these sponsorships go to the sponsored developer or organization. The 10% fee for sponsorships from organizations is waived during the beta. diff --git a/data/reusables/sponsors/org-sponsors-release-phase.md b/data/reusables/sponsors/org-sponsors-release-phase.md new file mode 100644 index 000000000000..75983073a400 --- /dev/null +++ b/data/reusables/sponsors/org-sponsors-release-phase.md @@ -0,0 +1,5 @@ +{% note %} + +**Note:** Sponsoring on behalf of an organization is currently in beta and subject to change. + +{% endnote %} \ No newline at end of file diff --git a/data/reusables/sponsors/pay-prorated-amount.md b/data/reusables/sponsors/pay-prorated-amount.md new file mode 100644 index 000000000000..969f672e6422 --- /dev/null +++ b/data/reusables/sponsors/pay-prorated-amount.md @@ -0,0 +1,2 @@ +1. Optionally, if you're sponsoring as an organization, to pay a prorated amount instead of making the full monthly payment, under "Due today", click **Pay prorated $X.XX today**. + ![Link to pay prorated amount](/assets/images/help/sponsors/pay-prorated-amount-link.png) \ No newline at end of file diff --git a/data/reusables/sponsors/prorated-sponsorship.md b/data/reusables/sponsors/prorated-sponsorship.md index f63d25e33910..56a047d86788 100644 --- a/data/reusables/sponsors/prorated-sponsorship.md +++ b/data/reusables/sponsors/prorated-sponsorship.md @@ -1 +1 @@ -You will immediately be charged a prorated amount for the time until your next regular billing date. +If you're sponsoring on behalf of your user account, you will immediately be charged a prorated amount for the time until your next regular billing date. If you're sponsoring on behalf of an organization, you can choose to pay the prorated amount or make the full monthly payment. diff --git a/data/reusables/sponsors/sponsor-account.md b/data/reusables/sponsors/sponsor-account.md new file mode 100644 index 000000000000..9c91a25539f8 --- /dev/null +++ b/data/reusables/sponsors/sponsor-account.md @@ -0,0 +1,2 @@ +1. Click **Sponsor _ACCOUNT_**. + ![Sponsor button](/assets/images/help/sponsors/sponsor-developer-button.png) \ No newline at end of file diff --git a/data/reusables/sponsors/sponsorship-dashboard.md b/data/reusables/sponsors/sponsorship-dashboard.md new file mode 100644 index 000000000000..20dc887fbeb0 --- /dev/null +++ b/data/reusables/sponsors/sponsorship-dashboard.md @@ -0,0 +1,7 @@ +1. Navigate to your sponsorship dashboard for the account. + - If you're sponsoring a user account, under the user's name, click **Sponsoring**. + ![Sponsoring button](/assets/images/help/profile/sponsoring-button.png) + - If you're sponsoring an organization, to the right of the organization's name, click **Sponsoring**. + ![Sponsoring button](/assets/images/help/sponsors/org-sponsoring-button.png) +1. Optionally, to manage a sponsorship on behalf of an organization, on the right side of the page, use the **Sponsoring as** drop-down menu, and click the organization. + ![Drop-down menu to choose the account you're sponsoring as](/assets/images/help/sponsors/sponsoring-as-drop-down-menu.png) diff --git a/data/reusables/sponsors/sponsorship-details.md b/data/reusables/sponsors/sponsorship-details.md index 55425b5c0af6..6542580736e1 100644 --- a/data/reusables/sponsors/sponsorship-details.md +++ b/data/reusables/sponsors/sponsorship-details.md @@ -1 +1 @@ -Anyone with a {% data variables.product.product_name %} account can sponsor anyone with a sponsored developer profile or sponsored organization profile through a recurring monthly payment. You can choose from multiple sponsorship tiers, with monthly payment amounts and benefits that are set by the sponsored developer or organization. Your sponsorship will share your account's existing billing date, payment method, and receipt. +You can sponsor anyone with a sponsored developer profile or sponsored organization profile on behalf of your user account or an organization. You can choose from multiple sponsorship tiers, with monthly payment amounts and benefits that are set by the sponsored account. Your sponsorship will share your account's existing billing date, payment method, and receipt. diff --git a/includes/all-articles.html b/includes/all-articles.html index 0754fef28260..d0cfe2054c5b 100644 --- a/includes/all-articles.html +++ b/includes/all-articles.html @@ -1,8 +1,8 @@ {% assign product = siteTree[currentLanguage][currentVersion].products[currentProduct] %} {% assign maxArticles = 10 %} -
-

All {{ product.title }} docs

+
+

All {{ product.title }} docs

{% for category in product.categories %} diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index e2f389b736df..f5234c81ccac 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -5975,6 +5975,123 @@ "bodyParameters": [], "descriptionHTML": "

Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

" }, + { + "verb": "get", + "requestPath": "/enterprises/{enterprise}/audit-log", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" + }, + { + "name": "phrase", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

A search phrase. For more information, see Searching the audit log.

" + }, + { + "name": "include", + "description": "The event types to include:\n\n- `web` - returns web (non-Git) events\n- `git` - returns Git events\n- `all` - returns both web and Git events\n\nThe default is `web`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "web", + "git", + "all" + ] + }, + "descriptionHTML": "

The event types to include:

\n
    \n
  • web - returns web (non-Git) events
  • \n
  • git - returns Git events
  • \n
  • all - returns both web and Git events
  • \n
\n

The default is web.

" + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

" + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100)

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/audit-log", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/audit-log
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /enterprises/{enterprise}/audit-log', {\n enterprise: 'enterprise'\n})", + "html": "
await octokit.request('GET /enterprises/{enterprise}/audit-log', {\n  enterprise: 'enterprise'\n})\n
" + } + ], + "summary": "Get the audit log for an enterprise", + "description": "**Note:** The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub.\n\nGets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope.", + "operationId": "audit-log/get-audit-log", + "tags": [ + "audit-log" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#get-the-audit-log-for-an-enterprise" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "audit-log" + }, + "slug": "get-the-audit-log-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "audit-log", + "subcategoryLabel": "Audit log", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Note: The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub.

\n

Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the admin:enterprise scope.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"@timestamp\": 1606929874512,\n    \"action\": \"team.add_member\",\n    \"actor\": \"octocat\",\n    \"created_at\": 1606929874512,\n    \"org\": \"octo-corp\",\n    \"team\": \"octo-corp/example-team\",\n    \"user\": \"monalisa\"\n  },\n  {\n    \"@timestamp\": 1606507117008,\n    \"action\": \"org.create\",\n    \"actor\": \"octocat\",\n    \"created_at\": 1606507117008,\n    \"org\": \"octocat-test-org\"\n  },\n  {\n    \"@timestamp\": 1605719148837,\n    \"action\": \"repo.destroy\",\n    \"actor\": \"monalisa\",\n    \"created_at\": 1605719148837,\n    \"org\": \"mona-org\",\n    \"repo\": \"mona-org/mona-test-repo\",\n    \"visibility\": \"private\"\n  }\n]\n
" + } + ] + }, { "verb": "get", "requestPath": "/enterprises/{enterprise}/settings/billing/actions", @@ -14225,6 +14342,120 @@ "bodyParameters": [], "descriptionHTML": "

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

" }, + { + "verb": "get", + "requestPath": "/orgs/{org}/audit-log", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "phrase", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

A search phrase. For more information, see Searching the audit log.

" + }, + { + "name": "include", + "description": "The event types to include:\n\n- `web` - returns web (non-Git) events\n- `git` - returns Git events\n- `all` - returns both web and Git events\n\nThe default is `web`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "web", + "git", + "all" + ] + }, + "descriptionHTML": "

The event types to include:

\n
    \n
  • web - returns web (non-Git) events
  • \n
  • git - returns Git events
  • \n
  • all - returns both web and Git events
  • \n
\n

The default is web.

" + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

" + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100)

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/audit-log", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/audit-log
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/audit-log', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/audit-log', {\n  org: 'org'\n})\n
" + } + ], + "summary": "Get the audit log for an organization", + "description": "**Note:** The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub.\n\nGets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nTo use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint.", + "operationId": "orgs/get-audit-log", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#get-the-audit-log-for-an-organization" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": null + }, + "slug": "get-the-audit-log-for-an-organization", + "category": "orgs", + "categoryLabel": "Orgs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Note: The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub.

\n

Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"

\n

To use this endpoint, you must be an organization owner, and you must use an access token with the admin:org scope. GitHub Apps must have the organization_administration read permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"@timestamp\": 1606929874512,\n    \"action\": \"team.add_member\",\n    \"actor\": \"octocat\",\n    \"created_at\": 1606929874512,\n    \"org\": \"octo-corp\",\n    \"team\": \"octo-corp/example-team\",\n    \"user\": \"monalisa\"\n  },\n  {\n    \"@timestamp\": 1606507117008,\n    \"action\": \"org.create\",\n    \"actor\": \"octocat\",\n    \"created_at\": 1606507117008,\n    \"org\": \"octocat-test-org\"\n  },\n  {\n    \"@timestamp\": 1605719148837,\n    \"action\": \"repo.destroy\",\n    \"actor\": \"monalisa\",\n    \"created_at\": 1605719148837,\n    \"org\": \"mona-org\",\n    \"repo\": \"mona-org/mona-test-repo\",\n    \"visibility\": \"private\"\n  }\n]\n
" + } + ] + }, { "verb": "get", "requestPath": "/orgs/{org}/blocks", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 873643c5bcd5..7dbc79d26958 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -17051,6 +17051,254 @@ } } }, + "/enterprises/{enterprise}/audit-log": { + "get": { + "summary": "Get the audit log for an enterprise", + "description": "**Note:** The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub.\n\nGets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope.", + "operationId": "audit-log/get-audit-log", + "tags": [ + "audit-log" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#get-the-audit-log-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "phrase", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "include", + "description": "The event types to include:\n\n- `web` - returns web (non-Git) events\n- `git` - returns Git events\n- `all` - returns both web and Git events\n\nThe default is `web`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "web", + "git", + "all" + ] + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "@timestamp": { + "type": "integer", + "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "action": { + "type": "string", + "description": "The name of the action that was performed, for example `user.login` or `repo.create`." + }, + "active": { + "type": "boolean" + }, + "active_was": { + "type": "boolean" + }, + "actor": { + "type": "string", + "description": "The actor who performed the action." + }, + "blocked_user": { + "type": "string", + "description": "The username of the account being blocked." + }, + "business": { + "type": "string" + }, + "config": { + "type": "array" + }, + "config_was": { + "type": "array" + }, + "content_type": { + "type": "string" + }, + "created_at": { + "type": "integer", + "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "deploy_key_fingerprint": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "events": { + "type": "array" + }, + "events_were": { + "type": "array" + }, + "explanation": { + "type": "string" + }, + "fingerprint": { + "type": "string" + }, + "hook_id": { + "type": "integer" + }, + "limited_availability": { + "type": "boolean" + }, + "message": { + "type": "string" + }, + "name": { + "type": "string" + }, + "old_user": { + "type": "string" + }, + "openssh_public_key": { + "type": "string" + }, + "org": { + "type": "string" + }, + "previous_visibility": { + "type": "string" + }, + "read_only": { + "type": "boolean" + }, + "repo": { + "type": "string", + "description": "The name of the repository." + }, + "repository": { + "type": "string", + "description": "The name of the repository." + }, + "repository_public": { + "type": "boolean" + }, + "target_login": { + "type": "string" + }, + "team": { + "type": "string" + }, + "transport_protocol": { + "type": "integer", + "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "transport_protocol_name": { + "type": "string", + "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "user": { + "type": "string", + "description": "The user that was affected by the action performed (if available)." + }, + "visibility": { + "type": "string", + "description": "The repository visibility, for example `public` or `private`." + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "@timestamp": 1606929874512, + "action": "team.add_member", + "actor": "octocat", + "created_at": 1606929874512, + "org": "octo-corp", + "team": "octo-corp/example-team", + "user": "monalisa" + }, + { + "@timestamp": 1606507117008, + "action": "org.create", + "actor": "octocat", + "created_at": 1606507117008, + "org": "octocat-test-org" + }, + { + "@timestamp": 1605719148837, + "action": "repo.destroy", + "actor": "monalisa", + "created_at": 1605719148837, + "org": "mona-org", + "repo": "mona-org/mona-test-repo", + "visibility": "private" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "audit-log" + } + } + }, "/enterprises/{enterprise}/settings/billing/actions": { "get": { "summary": "Get GitHub Actions billing for an enterprise", @@ -49105,6 +49353,253 @@ } } }, + "/orgs/{org}/audit-log": { + "get": { + "summary": "Get the audit log for an organization", + "description": "**Note:** The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub.\n\nGets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nTo use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint.", + "operationId": "orgs/get-audit-log", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#get-the-audit-log-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "phrase", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "include", + "description": "The event types to include:\n\n- `web` - returns web (non-Git) events\n- `git` - returns Git events\n- `all` - returns both web and Git events\n\nThe default is `web`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "web", + "git", + "all" + ] + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "@timestamp": { + "type": "integer", + "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "action": { + "type": "string", + "description": "The name of the action that was performed, for example `user.login` or `repo.create`." + }, + "active": { + "type": "boolean" + }, + "active_was": { + "type": "boolean" + }, + "actor": { + "type": "string", + "description": "The actor who performed the action." + }, + "blocked_user": { + "type": "string", + "description": "The username of the account being blocked." + }, + "business": { + "type": "string" + }, + "config": { + "type": "array" + }, + "config_was": { + "type": "array" + }, + "content_type": { + "type": "string" + }, + "created_at": { + "type": "integer", + "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "deploy_key_fingerprint": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "events": { + "type": "array" + }, + "events_were": { + "type": "array" + }, + "explanation": { + "type": "string" + }, + "fingerprint": { + "type": "string" + }, + "hook_id": { + "type": "integer" + }, + "limited_availability": { + "type": "boolean" + }, + "message": { + "type": "string" + }, + "name": { + "type": "string" + }, + "old_user": { + "type": "string" + }, + "openssh_public_key": { + "type": "string" + }, + "org": { + "type": "string" + }, + "previous_visibility": { + "type": "string" + }, + "read_only": { + "type": "boolean" + }, + "repo": { + "type": "string", + "description": "The name of the repository." + }, + "repository": { + "type": "string", + "description": "The name of the repository." + }, + "repository_public": { + "type": "boolean" + }, + "target_login": { + "type": "string" + }, + "team": { + "type": "string" + }, + "transport_protocol": { + "type": "integer", + "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "transport_protocol_name": { + "type": "string", + "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "user": { + "type": "string", + "description": "The user that was affected by the action performed (if available)." + }, + "visibility": { + "type": "string", + "description": "The repository visibility, for example `public` or `private`." + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "@timestamp": 1606929874512, + "action": "team.add_member", + "actor": "octocat", + "created_at": 1606929874512, + "org": "octo-corp", + "team": "octo-corp/example-team", + "user": "monalisa" + }, + { + "@timestamp": 1606507117008, + "action": "org.create", + "actor": "octocat", + "created_at": 1606507117008, + "org": "octocat-test-org" + }, + { + "@timestamp": 1605719148837, + "action": "repo.destroy", + "actor": "monalisa", + "created_at": 1605719148837, + "org": "mona-org", + "repo": "mona-org/mona-test-repo", + "visibility": "private" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "orgs", + "subcategory": null + } + } + }, "/orgs/{org}/blocks": { "get": { "summary": "List users blocked by an organization", diff --git a/tests/content/featured-links.js b/tests/content/featured-links.js index c5b476153bcb..9829f1abd71a 100644 --- a/tests/content/featured-links.js +++ b/tests/content/featured-links.js @@ -45,8 +45,9 @@ describe('featuredLinks', () => { test('featured links respect versioning', async () => { const $ = await getDOM(`/en/enterprise/${enterpriseServerReleases.latest}/user/packages`) - const $featuredLinks = $('.featured-links a') + const $featuredLinks = $('.all-articles-list a') expect($featuredLinks.length).toBeGreaterThan(2) + expect($featuredLinks.text().includes('Package client guides for GitHub Packages')).toBe(true) // does not include dotcom-only links expect($featuredLinks.text().includes('About GitHub Container Registry')).toBe(false) expect($featuredLinks.text().includes('Getting started with GitHub Container Registry')).toBe(false)