Skip to content

Commit

Permalink
Merge branch 'github:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexei Juárez authored Nov 1, 2024
2 parents ef342ad + 2dffa8d commit 239f174
Show file tree
Hide file tree
Showing 87 changed files with 483 additions and 147 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/desktop/appearance-tab-themes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/desktop/mac-select-git-pane.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/desktop/mac-select-integrations-pane.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ gh actions-importer ... --custom-transformers transformers/*.rb

{% note %}

**Note:** When you use custom transformers, the custom transformer files must reside in the same directory, or in subdirectores, from where the `gh actions-importer` command is run.
**Note:** When you use custom transformers, the custom transformer files must reside in the same directory, or in subdirectories, from where the `gh actions-importer` command is run.

{% endnote %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -338,11 +338,11 @@ Users with `write` access to a repository can use the {% data variables.product.

### Force deleting cache entries

Caches have branch scope restrictions in place, which means some caches have limited usage options. For more information on cache scope restrictions, see "[AUTOTITLE](/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache)." If caches limited to a specific branch are using a lot of storage quota, it may cause caches from the `default` branch to be created and deleted at a high frequency.
Caches have branch scope restrictions in place, which means some caches have limited usage options. For more information on cache scope restrictions, see "[Restrictions for accessing a cache](#restrictions-for-accessing-a-cache)," earlier in this article. If caches limited to a specific branch are using a lot of storage quota, it may cause caches from the `default` branch to be created and deleted at a high frequency.

For example, a repository could have many new pull requests opened, each with their own caches that are restricted to that branch. These caches could take up the majority of the cache storage for that repository. {% data reusables.actions.cache-eviction-policy %} In order to prevent cache thrashing when this happens, you can set up workflows to delete caches on a faster cadence than the cache eviction policy will. You can use the [`gh-actions-cache`](https://github.com/actions/gh-actions-cache/) CLI extension to delete caches for specific branches.
For example, a repository could have many new pull requests opened, each with their own caches that are restricted to that branch. These caches could take up the majority of the cache storage for that repository. {% data reusables.actions.cache-eviction-policy %} In order to prevent cache thrashing when this happens, you can set up workflows to delete caches on a faster cadence than the cache eviction policy will. You can use the {% data variables.product.prodname_cli %} to delete caches for specific branches.

The following example workflow uses `gh-actions-cache` to delete up to 100 caches created by a branch once a pull request is closed.
The following example workflow uses `gh cache` to delete up to 100 caches created by a branch once a pull request is closed.

To run the following example on cross-repository pull requests or pull requests from forks, you can trigger the workflow with the `pull_request_target` event. If you do use `pull_request_target` to trigger the workflow, there are security considerations to keep in mind. For more information, see "[AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#pull_request_target)."

Expand All @@ -359,22 +359,20 @@ jobs:
steps:
- name: Cleanup
run: |
gh extension install actions/gh-actions-cache
echo "Fetching list of cache key"
cacheKeysForPR=$(gh actions-cache list -R $REPO -B $BRANCH -L 100 | cut -f 1 )
cacheKeysForPR=$(gh cache list --ref $BRANCH --limit 100 --json id --jq '.[].id')
## Setting this to not fail the workflow while deleting cache keys.
set +e
echo "Deleting caches..."
for cacheKey in $cacheKeysForPR
do
gh actions-cache delete $cacheKey -R $REPO -B $BRANCH --confirm
gh cache delete $cacheKey
done
echo "Done"
env:
GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
REPO: {% raw %}${{ github.repository }}{% endraw %}
GH_REPO: {% raw %}${{ github.repository }}{% endraw %}
BRANCH: refs/pull/{% raw %}${{ github.event.pull_request.number }}{% endraw %}/merge
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ shortTitle: Enable for GHE.com
intro: 'Enable {% data variables.product.prodname_github_connect %} to share data between {% data variables.enterprise.data_residency_site %} and {% data variables.location.product_location %}.'
versions:
feature: ghecom-github-connect
redirect_from:
- /early-access/admin/preview-of-data-residency-for-github-enterprise/configuring-github-connect-during-the-preview-of-data-residency
- /early-access/admin/private-ga-of-data-residency-for-github-enterprise-cloud/configuring-github-connect-during-the-private-ga-of-data-residency
- /early-access/admin/data-residency-for-github-enterprise-cloud/configuring-github-connect-for-data-residency
---

You can access additional features and workflows on {% data variables.location.product_location %} by enabling {% data variables.product.prodname_github_connect %}. See "[AUTOTITLE](/admin/configuration/configuring-github-connect/about-github-connect)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ intro: "With {% data variables.product.prodname_ghe_cloud %}, you can have more
shortTitle: What is data residency?
versions:
ghec: '*'
redirect_from:
- /early-access/admin/using-a-data-local-enterprise-on-github/about-the-alpha-of-data-locality-for-github-enterprise-cloud
- /early-access/admin/using-a-data-local-enterprise-on-github/about-the-alpha-of-data-residency-for-github-enterprise-cloud
- /early-access/admin/preview-of-data-residency-for-github-enterprise/about-the-preview-of-data-residency-for-github-enterprise
- /early-access/admin/private-ga-of-data-residency-for-github-enterprise-cloud/about-the-private-ga-of-data-residency-for-github-enterprise-cloud
- /early-access/admin/data-residency-for-github-enterprise-cloud/about-data-residency-for-github-enterprise-cloud
---

By default, {% data variables.product.company_short %} stores data for {% data variables.product.prodname_dotcom_the_website %} in the USA. {% data reusables.data-residency.when-you-adopt-data-residency %} To learn how {% data variables.product.company_short %} handles data storage, see "[AUTOTITLE](/admin/data-residency/about-storage-of-your-data-with-data-residency)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ shortTitle: How is data stored?
intro: "Learn how your data is stored when you use {% data variables.enterprise.data_residency %}."
versions:
ghec: '*'
redirect_from:
- /early-access/admin/using-a-data-resident-enterprise-on-github/about-data-locality
- /early-access/admin/using-a-data-resident-enterprise-on-github/about-data-residency
- /early-access/admin/preview-of-data-residency-for-github-enterprise/about-data-residency-in-the-european-union
- /early-access/admin/private-ga-of-data-residency-for-github-enterprise-cloud/about-data-residency-in-the-european-union
- /early-access/admin/data-residency-for-github-enterprise-cloud/about-data-residency-in-the-european-union
---

{% data reusables.data-residency.when-you-adopt-data-residency %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ shortTitle: Which features are available?
intro: "Learn about the available features on {% data variables.enterprise.data_residency_site %}, plus features that work differently from {% data variables.product.prodname_dotcom_the_website %}."
versions:
ghec: '*'
redirect_from:
- /early-access/admin/data-residency-for-github-enterprise-cloud/feature-overview-for-github-enterprise-cloud-with-data-residency
---

{% data reusables.data-residency.data-resident-enterprise-feature-availability %} Some features work differently or require additional configuration compared to the equivalent feature on {% data variables.product.prodname_dotcom_the_website %}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ shortTitle: Get started
intro: "Set up your enterprise on {% data variables.enterprise.data_residency_site %} by onboarding users, enabling billing, and migrating data."
versions:
ghec: '*'
redirect_from:
- /early-access/admin/using-a-data-local-enterprise-on-github/getting-started-with-a-data-local-enterprise
- /early-access/admin/using-a-data-local-enterprise-on-github/getting-started-with-a-data-resident-enterprise
- /early-access/admin/preview-of-data-residency-for-github-enterprise/getting-started-with-the-preview-of-data-residency
- /early-access/admin/private-ga-of-data-residency-for-github-enterprise-cloud/getting-started-with-the-private-ga-of-data-residency
- /early-access/admin/data-residency-for-github-enterprise-cloud/getting-started-with-data-residency-for-github-enterprise-cloud
- /early-access/admin/preview-of-data-residency-for-github-enterprise/configuring-authentication-and-provisioning-for-your-enterprise
- /early-access/admin/private-ga-of-data-residency-for-github-enterprise-cloud/configuring-authentication-and-provisioning-for-your-enterprise
- /early-access/admin/data-residency-for-github-enterprise-cloud/configuring-authentication-and-provisioning-for-your-enterprise
---

When you adopt {% data variables.enterprise.data_residency %}, you can choose where your company's code and data are stored.
Expand Down
6 changes: 6 additions & 0 deletions content/admin/data-residency/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,10 @@ children:
- /getting-started-with-data-residency-for-github-enterprise-cloud
- /network-details-for-ghecom
- /resolving-issues-with-your-enterprise-on-ghecom
redirect_from:
- /early-access/admin/using-a-data-local-enterprise-on-github
- /early-access/admin/using-a-data-resident-enterprise-on-github
- /early-access/admin/preview-of-data-residency-for-github-enterprise
- /early-access/admin/private-ga-of-data-residency-for-github-enterprise-cloud
- /early-access/admin/data-residency-for-github-enterprise-cloud
---
4 changes: 4 additions & 0 deletions content/admin/data-residency/network-details-for-ghecom.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ shortTitle: Network details
intro: 'Ensure client systems can access your resources on {% data variables.enterprise.data_residency_site %}.'
versions:
ghec: '*'
redirect_from:
- /early-access/admin/preview-of-data-residency-for-github-enterprise/network-access-to-resources-on-ghecom
- /early-access/admin/private-ga-of-data-residency-for-github-enterprise-cloud/network-access-to-resources-on-ghecom
- /early-access/admin/data-residency-for-github-enterprise-cloud/network-access-to-resources-on-ghecom
---

To access your enterprise on {% data variables.enterprise.data_residency_site %}, client systems must:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ topics:
shortTitle: Manage organization invitations
permissions: Enterprise owners can manage invitations to organizations within their enterprise.
redirect_from:
- /admin/user-management/managing-users-in-your-enterprise/mmanaging-invitations-to-organizations-within-your-enterprise
- /admin/user-management/managing-users-in-your-enterprise/managing-invitations-to-organizations-within-your-enterprise
---

You can manage invitations to your enterprise or organizations within your enterprise.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ To upgrade an instance that comprises multiple nodes using an upgrade package, y
1. Upgrade the node by following the instructions in "[Upgrading a standalone instance using an upgrade package](#upgrading-a-standalone-instance-using-an-upgrade-package)."
{% data reusables.enterprise_installation.replica-ssh %}
{% data reusables.enterprise_installation.replica-verify %}
{% data reusables.enterprise_installation.start-replication %}{% ifversion ghes > 3.13 %} Alternatively, if there are mutliple replicas, run `ghe-repl-start-all` on the primary node instead, which will start replications in a single run.{% endif %}
{% data reusables.enterprise_installation.start-replication %}{% ifversion ghes > 3.13 %} Alternatively, if there are multiple replicas, run `ghe-repl-start-all` on the primary node instead, which will start replications in a single run.{% endif %}
{% data reusables.enterprise_installation.replication-status %} {% data reusables.enterprise_installation.replication-status-upgrade %}
{% data reusables.enterprise_installation.multiple-node-repeat-upgrade-process %}
{% data reusables.enterprise_installation.disable-maintenance-mode-after-replica-upgrade %}
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Ensure you have a recent, successful backup snapshot of your instance's primary

### Create a VM snapshot

If you're upgrading to a new feature release, a virtual machine (VM) snapshot is required. If you're ugprading to a patch release, you can attach the existing data disk.
If you're upgrading to a new feature release, a virtual machine (VM) snapshot is required. If you're upgrading to a patch release, you can attach the existing data disk.

Create a virtual machine (VM) snapshot of your instance's primary node immediately before upgrading, and only when maintenance mode has been enabled or the instance has been powered down. See "[AUTOTITLE](/admin/upgrading-your-instance/preparing-to-upgrade/taking-a-snapshot)".

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,6 @@ If the user account you used to sign into Azure does not have adequate permissio

> **Need admin approval**
>
> GitHub Inc needs permission to access resources in your organisation that only an admin can grant. Please ask an admin to grant permission to this app before you can use it.
> GitHub Inc needs permission to access resources in your organization that only an admin can grant. Please ask an admin to grant permission to this app before you can use it.
To avoid this message when you try again, you must either ensure that the Azure user can provide tenant-wide admin consent, or you must work with an Azure administrator to configure the admin consent workflow. For more information, review "[Prerequisites](#prerequisites)."
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ If you have access, there will be a {% octicon "credit-card" aria-hidden="true"

## Next steps

* To **get started with the new billing plaform**, see "[AUTOTITLE](/billing/using-the-new-billing-platform/getting-started-with-the-new-billing-platform)."
* To **get started with the new billing platform**, see "[AUTOTITLE](/billing/using-the-new-billing-platform/getting-started-with-the-new-billing-platform)."
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This error is reported if you try to run {% data variables.product.prodname_code
## Confirming the cause of the error

{% ifversion fpt %}
If you are on a free, pro, or team plan, you can only use {% data variables.product.prodname_code_scanning %} on repositories that are publically available. To enable {% data variables.product.prodname_code_scanning %} for private or internal repositories, you must upgrade to GitHub Enterprise with {% data variables.product.prodname_GH_advanced_security %} and enable {% data variables.product.prodname_GH_advanced_security %} for the repository. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-products#github-enterprise)" and "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security)."
If you are on a free, pro, or team plan, you can only use {% data variables.product.prodname_code_scanning %} on repositories that are publicly available. To enable {% data variables.product.prodname_code_scanning %} for private or internal repositories, you must upgrade to GitHub Enterprise with {% data variables.product.prodname_GH_advanced_security %} and enable {% data variables.product.prodname_GH_advanced_security %} for the repository. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-products#github-enterprise)" and "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security)."

{% else %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ versions:
---

{% ifversion fpt %}
If you are on a free, pro, or team plan, you can only use {% data variables.product.prodname_code_scanning %} on repositories that are publically available. To enable {% data variables.product.prodname_code_scanning %} for private or internal repositories, you must upgrade to GitHub Enterprise with {% data variables.product.prodname_GH_advanced_security %} and enable {% data variables.product.prodname_GH_advanced_security %} for the repository. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-products#github-enterprise)" and "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security)."
If you are on a free, pro, or team plan, you can only use {% data variables.product.prodname_code_scanning %} on repositories that are publicly available. To enable {% data variables.product.prodname_code_scanning %} for private or internal repositories, you must upgrade to GitHub Enterprise with {% data variables.product.prodname_GH_advanced_security %} and enable {% data variables.product.prodname_GH_advanced_security %} for the repository. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-products#github-enterprise)" and "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security)."

{% else %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,4 +106,4 @@ There are a few steps to fix this problem.

On top of fixing the code scanning configuration and removing or fixing the output of third-party tools, you will need to contact {% data variables.contact.contact_support %} to assist you in deleting the alerts for any offending configurations.

**There is no self-service method for deleting alerts at this time, so contacting customer support is neccessary before code-scanning can be re-enabled.**
**There is no self-service method for deleting alerts at this time, so contacting customer support is necessary before code-scanning can be re-enabled.**
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ If you opt in, {% data variables.product.company_short %} collects the following

* The identifiers of any {% data variables.product.prodname_codeql %}-related {% data variables.product.prodname_vscode_shortname %} commands that are run. For each command, these are: the timestamp, time taken, and whether or not the command completed successfully.

* Interactions with UI elements, including buttons, links, and other inputs. Intereacts that are not recorded are: link targets, text inputs, mouse movement, and mouse hovering.
* Interactions with UI elements, including buttons, links, and other inputs. Interacts that are not recorded are: link targets, text inputs, mouse movement, and mouse hovering.

* Occurrence of exceptions and errors. All sensitive information such as file paths and non-static exception message content are removed before uploading.

Expand Down
Loading

0 comments on commit 239f174

Please sign in to comment.