Skip to content

Commit c8579c9

Browse files
[GHES 3.8+] Retention policy for checks in management console (github#34752)
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
1 parent 2b2bad6 commit c8579c9

File tree

6 files changed

+33
-3
lines changed

6 files changed

+33
-3
lines changed

content/admin/configuration/configuring-your-enterprise/configuring-applications.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,16 @@ You can choose the amount of time that {% data variables.location.product_locati
2121
3. In the "Settings" sidebar, click **Applications**.
2222
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.
2323
{% data reusables.enterprise_management_console.save-settings %}
24+
25+
{% ifversion status-check-retention %}
26+
## Enabling retention policy for checks
27+
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)."
28+
29+
{% data reusables.enterprise_site_admin_settings.access-settings %}
30+
{% data reusables.enterprise_site_admin_settings.management-console %}
31+
1. In the "Settings" sidebar, click **Checks**.
32+
2. Select **Enable archiving of Checks-related data**.
33+
3. Under "Archive threshold (days)", type the number of days for the archival threshhold. Checks older than this number of days will be archived.
34+
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.
35+
{% data reusables.enterprise_management_console.save-settings %}
36+
{% endif %}

content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,9 @@ Alternatively, to skip or request _all_ checks for your commit, add one of the f
7979
request-checks: true"
8080
```
8181

82-
{% ifversion fpt or ghec %}
82+
{% ifversion status-check-retention %}
8383
### Retention of status checks
8484

8585
{% data reusables.pull_requests.retention-checks-data %}
86+
8687
{% endif %}

content/rest/guides/using-the-rest-api-to-interact-with-checks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ When a user clicks the button, {% data variables.product.prodname_dotcom %} send
9393

9494
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)."
9595

96-
{% ifversion fpt or ghec %}
96+
{% ifversion status-check-retention %}
9797
## Retention of checks data
9898

9999
{% data reusables.pull_requests.retention-checks-data %}
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
versions:
2+
fpt: '*'
3+
ghec: '*'
4+
ghes: '>= 3.8'

data/release-notes/enterprise-server/3-8/0-rc1.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ sections:
2727
# https://github.com/github/releases/issues/2759
2828
- |
2929
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.
30+
For more information, see "[Configuring applications](/admin/configuration/configuring-your-enterprise/configuring-applications)" [Updated: 2023-03-02]
31+
3032

3133
# https://github.com/github/releases/issues/2814
3234
- |
Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1-
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.
1+
{% ifversion fpt or ghec %}
2+
3+
{% data variables.location.product_location %} retains check data for 400 days. After 400 days, the data is archived.
4+
5+
{% elsif ghes %}
6+
7+
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)."
8+
9+
{% endif %}
10+
11+
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.

0 commit comments

Comments
 (0)