Adds content for Actions cache UI (#31738)
Co-authored-by: github-actions <github-actions@github.com> Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
This commit is contained in:
BIN
assets/images/help/repository/actions-cache-delete.png
Normal file
BIN
assets/images/help/repository/actions-cache-delete.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 104 KiB |
BIN
assets/images/help/repository/actions-cache-entry-list.png
Normal file
BIN
assets/images/help/repository/actions-cache-entry-list.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 92 KiB |
@@ -240,18 +240,68 @@ For example, if a pull request contains a `feature` branch and targets the defau
|
||||
|
||||
{% data variables.product.prodname_dotcom %} will remove any cache entries that have not been accessed in over 7 days. There is no limit on the number of caches you can store, but the total size of all caches in a repository is limited{% ifversion actions-cache-policy-apis %}. By default, the limit is 10 GB per repository, but this limit might be different depending on policies set by your enterprise owners or repository administrators.{% else %} to 10 GB.{% endif %}
|
||||
|
||||
{% data reusables.actions.cache-eviction-process %}
|
||||
{% data reusables.actions.cache-eviction-process %} {% ifversion actions-cache-ui %}The cache eviction process may cause cache thrashing, where caches are created and deleted at a high frequency. To reduce this, you can review the caches for a repository and take corrective steps, such as removing caching from specific workflows. For more information, see "[Managing caches](#managing-caches)."{% endif %}{% ifversion actions-cache-admin-ui %} You can also increase the cache size limit for a repository. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-cache-storage-for-a-repository)."
|
||||
|
||||
{% elsif actions-cache-policy-apis %}
|
||||
|
||||
{% ifversion actions-cache-policy-apis %}
|
||||
For information on changing the policies for the repository cache size limit, see "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-cache-storage-in-your-enterprise)" and "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-cache-storage-for-a-repository)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion actions-cache-management %}
|
||||
|
||||
## Managing caches
|
||||
|
||||
{% ifversion actions-cache-ui %}
|
||||
|
||||
To manage caches created from your workflows, you can:
|
||||
|
||||
- View a list of all cache entries for a repository.
|
||||
- Filter and sort the list of caches using specific metadata such as cache size, creation time, or last accessed time.
|
||||
- Delete cache entries from a repository.
|
||||
- Monitor aggregate cache usage for repositories and organizations.
|
||||
|
||||
There are multiple ways to manage caches for your repositories:
|
||||
|
||||
- Using the {% data variables.product.prodname_dotcom %} web interface, as shown below.
|
||||
- Using the REST API. For more information, see the "[{% data variables.product.prodname_actions %} Cache](/rest/actions/cache)" REST API documentation.
|
||||
- Installing a {% data variables.product.prodname_cli %} extension to manage your caches from the command line. For more information, see the [gh-actions-cache](https://github.com/actions/gh-actions-cache) extension.
|
||||
|
||||
{% else %}
|
||||
|
||||
You can use the {% data variables.product.product_name %} REST API to manage your caches. {% ifversion actions-cache-list-delete-apis %}You can use the API to list and delete cache entries, and see your cache usage.{% elsif actions-cache-management %}At present, you can use the API to see your cache usage, with more functionality expected in future updates.{% endif %} For more information, see the "[{% data variables.product.prodname_actions %} Cache](/rest/actions/cache)" REST API documentation.
|
||||
|
||||
You can also install a {% data variables.product.prodname_cli %} extension to manage your caches from the command line. For more information about the extension, see [the extension documentation](https://github.com/actions/gh-actions-cache#readme). For more information about {% data variables.product.prodname_cli %} extensions, see "[Using GitHub CLI extensions](/github-cli/github-cli/using-github-cli-extensions)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion actions-cache-ui %}
|
||||
|
||||
### Viewing cache entries
|
||||
|
||||
You can use the web interface to view a list of cache entries for a repository. In the cache list, you can see how much disk space each cache is using, when the cache was created, and when the cache was last used.
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.actions-tab %}
|
||||
{% data reusables.repositories.actions-cache-list %}
|
||||
1. Review the list of cache entries for the repository.
|
||||
|
||||
* To search for cache entries used for a specific branch, click the **Branch** dropdown menu and select a branch. The cache list will display all of the caches used for the selected branch.
|
||||
* To search for cache entries with a specific cache key, use the syntax `key: key-name` in the **Filter caches** field. The cache list will display caches from all branches where the key was used.
|
||||
|
||||

|
||||
|
||||
### Deleting cache entries
|
||||
|
||||
Users with `write` access to a repository can use the {% data variables.product.prodname_dotcom %} web interface to delete cache entries.
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.actions-tab %}
|
||||
{% data reusables.repositories.actions-cache-list %}
|
||||
1. To the right of the cache entry you want to delete, click {% octicon "trash" aria-label="The trash icon" %}.
|
||||
|
||||

|
||||
|
||||
{% endif %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -168,9 +168,19 @@ By default, when you create a new enterprise, workflows are not allowed to creat
|
||||
|
||||
{% data reusables.actions.cache-default-size %} {% data reusables.actions.cache-eviction-process %}
|
||||
|
||||
However, you can set an enterprise policy to customize both the default total cache size for each repository, as well as the maximum total cache size allowed for a repository. For example, you might want the default total cache size for each repository to be 5 GB, but also allow repository administrators to configure a total cache size up to 15 GB if necessary.
|
||||
However, you can set an enterprise policy to customize both the default total cache size for each repository, as well as the maximum total cache size allowed for a repository. For example, you might want the default total cache size for each repository to be 5 GB, but also allow {% ifversion actions-cache-admin-ui %}organization owners and{% endif %} repository administrators to configure a total cache size up to 15 GB if necessary.
|
||||
|
||||
People with admin access to a repository can set a total cache size for their repository up to the maximum cache size allowed by the enterprise policy setting.
|
||||
{% ifversion actions-cache-admin-ui %}Organization owners can set a lower total cache size that applies to each repository in their organization. {% endif %}People with admin access to a repository can set a total cache size for their repository up to the maximum cache size allowed by the enterprise {% ifversion actions-cache-admin-ui %}or organization{% endif %} policy setting.
|
||||
|
||||
{% ifversion actions-cache-admin-ui %}
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-tab %}
|
||||
1. In the "Artifact, cache and log settings" section, under **Maximum cache size limit**, enter a value, then click **Save** to apply the setting.
|
||||
1. In the "Artifact, cache and log settings" section, under **Default cache size limit**, enter a value, then click **Save** to apply the setting.
|
||||
|
||||
{% else %}
|
||||
|
||||
The policy settings for {% data variables.product.prodname_actions %} cache storage can currently only be modified using the REST API:
|
||||
|
||||
@@ -180,3 +190,5 @@ The policy settings for {% data variables.product.prodname_actions %} cache stor
|
||||
{% data reusables.actions.cache-no-org-policy %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -154,3 +154,37 @@ By default, when you create a new organization, workflows are not allowed to {%
|
||||
1. Click **Save** to apply the settings.
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion actions-cache-org-ui %}
|
||||
|
||||
## Managing {% data variables.product.prodname_actions %} cache storage for your organization
|
||||
|
||||
Organization administrators can view {% ifversion actions-cache-admin-ui %}and manage {% endif %}{% data variables.product.prodname_actions %} cache storage for all repositories in the organization.
|
||||
|
||||
### Viewing {% data variables.product.prodname_actions %} cache storage by repository
|
||||
|
||||
For each repository in your organization, you can see how much cache storage a repository is using, the number of active caches, and if a repository is near the total cache size limit. For more information about the cache usage and eviction process, see "[Caching dependencies to speed up workflows](/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy)."
|
||||
|
||||
{% data reusables.profile.access_profile %}
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
1. In the left sidebar, click {% octicon "play" aria-label="The {% data variables.product.prodname_actions %} icon" %} **Actions**, then click **Caches**.
|
||||
1. Review the list of repositories for information about their {% data variables.product.prodname_actions %} caches. You can click on a repository name to see more detail about the repository's caches.
|
||||
|
||||
{% ifversion actions-cache-admin-ui %}
|
||||
|
||||
### Configuring {% data variables.product.prodname_actions %} cache storage for your organization
|
||||
|
||||
{% data reusables.actions.cache-default-size %}
|
||||
|
||||
You can configure the size limit for {% data variables.product.prodname_actions %} caches that will apply to each repository in your organization. The cache size limit for an organization cannot exceed the cache size limit set in the enterprise policy. Repository admins will be able to set a smaller limit in their repositories.
|
||||
|
||||
{% data reusables.profile.access_profile %}
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% data reusables.organizations.settings-sidebar-actions-general %}
|
||||
{% data reusables.actions.change-cache-size-limit %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -185,7 +185,16 @@ You can also define a custom retention period for a specific artifact created by
|
||||
|
||||
{% data reusables.actions.cache-default-size %} However, these default sizes might be different if an enterprise owner has changed them. {% data reusables.actions.cache-eviction-process %}
|
||||
|
||||
You can set a total cache storage size for your repository up to the maximum size allowed by the enterprise policy setting.
|
||||
You can set a total cache storage size for your repository up to the maximum size allowed by the {% ifversion actions-cache-admin-ui %}organization or{% endif %} enterprise policy setting{% ifversion actions-cache-admin-ui %}s{% endif %}.
|
||||
|
||||
{% ifversion actions-cache-admin-ui %}
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.repositories.settings-sidebar-actions-general %}
|
||||
{% data reusables.actions.change-cache-size-limit %}
|
||||
|
||||
{% else %}
|
||||
|
||||
The repository settings for {% data variables.product.prodname_actions %} cache storage can currently only be modified using the REST API:
|
||||
|
||||
@@ -195,3 +204,5 @@ The repository settings for {% data variables.product.prodname_actions %} cache
|
||||
{% data reusables.actions.cache-no-org-policy %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
6
data/features/actions-cache-admin-ui.yml
Normal file
6
data/features/actions-cache-admin-ui.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
# Reference: #8112
|
||||
# Documentation for GitHub Actions cache admin settings for repositories, organizations, and enterprises
|
||||
# Related feature flags include actions-cache-org-ui and actions-cache-ui
|
||||
# All features released at the same time, but have different versions
|
||||
versions:
|
||||
ghes: '>= 3.8'
|
||||
8
data/features/actions-cache-org-ui.yml
Normal file
8
data/features/actions-cache-org-ui.yml
Normal file
@@ -0,0 +1,8 @@
|
||||
# Reference: #8112
|
||||
# Documentation for the Actions cache list UI for organizations
|
||||
# Related feature flags are actions-cache-admin-ui and actions-cache-ui
|
||||
# All features released at the same time, but have different versions
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>= 3.8'
|
||||
8
data/features/actions-cache-ui.yml
Normal file
8
data/features/actions-cache-ui.yml
Normal file
@@ -0,0 +1,8 @@
|
||||
# Reference: #8112
|
||||
# Documentation for Actions cache management via the UI for repositories
|
||||
# Related feature flags are actions-cache-admin-ui and actions-cache-org-ui
|
||||
# All features released at the same time, but have different versions
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>= 3.8'
|
||||
2
data/reusables/actions/change-cache-size-limit.md
Normal file
2
data/reusables/actions/change-cache-size-limit.md
Normal file
@@ -0,0 +1,2 @@
|
||||
1. Under **Cache size limit**, enter a new value.
|
||||
1. Click **Save** to apply the change.
|
||||
1
data/reusables/repositories/actions-cache-list.md
Normal file
1
data/reusables/repositories/actions-cache-list.md
Normal file
@@ -0,0 +1 @@
|
||||
1. In the left sidebar, under the "Management" section, click {% octicon "cache" aria-label="The Cache icon" %} **Caches**.
|
||||
Reference in New Issue
Block a user