[GHES 3.8+] Retention policy for checks in management console (#34752)

Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
This commit is contained in:
Rachael Rose Renk 2023-03-03 10:57:12 -07:00 коммит произвёл GitHub
Родитель 2b2bad60ab
Коммит c8579c90fc
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
6 изменённых файлов: 33 добавлений и 3 удалений

Просмотреть файл

@ -21,3 +21,16 @@ You can choose the amount of time that {% data variables.location.product_locati
3. In the "Settings" sidebar, click **Applications**.
4. Under "Avatar image cache time (seconds)", type the number of seconds that you would like {% data variables.location.product_location %} to cache avatar images.
{% data reusables.enterprise_management_console.save-settings %}
{% ifversion status-check-retention %}
## Enabling retention policy for checks
You can enable a retention policy for checks, actions, and associated data by setting thresholds for archival and deletion. For more information about configuring actions, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises)."
{% data reusables.enterprise_site_admin_settings.access-settings %}
{% data reusables.enterprise_site_admin_settings.management-console %}
1. In the "Settings" sidebar, click **Checks**.
2. Select **Enable archiving of Checks-related data**.
3. Under "Archive threshold (days)", type the number of days for the archival threshhold. Checks older than this number of days will be archived.
4. Under "Delete threshold (days)", type the number of days for the deletion threshhold. Archived checks older than this number of days will be permanently deleted.
{% data reusables.enterprise_management_console.save-settings %}
{% endif %}

Просмотреть файл

@ -79,8 +79,9 @@ Alternatively, to skip or request _all_ checks for your commit, add one of the f
request-checks: true"
```
{% ifversion fpt or ghec %}
{% ifversion status-check-retention %}
### Retention of status checks
{% data reusables.pull_requests.retention-checks-data %}
{% endif %}

Просмотреть файл

@ -93,7 +93,7 @@ When a user clicks the button, {% data variables.product.prodname_dotcom %} send
For a detailed example of how to set up requested actions with the REST API, see "[AUTOTITLE](/apps/creating-github-apps/guides/creating-ci-tests-with-the-checks-api#part-2-creating-the-octo-rubocop-ci-test)."
{% ifversion fpt or ghec %}
{% ifversion status-check-retention %}
## Retention of checks data
{% data reusables.pull_requests.retention-checks-data %}

Просмотреть файл

@ -0,0 +1,4 @@
versions:
fpt: '*'
ghec: '*'
ghes: '>= 3.8'

Просмотреть файл

@ -27,6 +27,8 @@ sections:
# https://github.com/github/releases/issues/2759
- |
To establish or comply with internal policies, site administrators can use the Management Console to configure an instance's policy for retention of data related to checks, including checks data generated by GitHub Actions and the Statuses API. Administrators can enable or disable retention, set a custom retention threshold, or set a custom hard-delete threshold.
For more information, see "[Configuring applications](/admin/configuration/configuring-your-enterprise/configuring-applications)" [Updated: 2023-03-02]
# https://github.com/github/releases/issues/2814
- |

Просмотреть файл

@ -1 +1,11 @@
Checks data older than 400 days is archived. As part of the archiving process {% data variables.product.prodname_dotcom %} creates a rollup commit status representing the state of all of the checks for that commit. As a consequence, the merge box in any pull request with archived checks that are required will be in a blocked state and you will need to rerun the checks before you can merge the pull request.
{% ifversion fpt or ghec %}
{% data variables.location.product_location %} retains check data for 400 days. After 400 days, the data is archived.
{% elsif ghes %}
Site administrators can control the retention policy for checks data on {% data variables.location.product_location %}. For more information, see "[Configuring applications](/admin/configuration/configuring-your-enterprise/configuring-applications#enabling-retention-policy-for-checks)."
{% endif %}
For archived check data, a rollup commit status appears that represents the state of all of the checks for the commit. To merge a pull request with checks that are both required and archived, you must rerun the checks.