Skip to content

Commit 88fefc5

Browse files
davidpiegzaisaacmbrownCopilot
authored
Add a section for deployment statuses describing data retention plan (#62262)
Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent 7647631 commit 88fefc5

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

content/rest/deployments/statuses.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ category:
1212
- Automate CI/CD workflows
1313
---
1414

15+
## About deployment statuses
1516

17+
Deployment statuses allow external services to mark deployments with an `error`, `failure`, `inactive`, `in_progress`, `queued`, `pending`, or `success` state. Systems listening to [`deployment_status` events](/webhooks/webhook-events-and-payloads#deployment_status) can consume and respond to these statuses. A deployment status can also include an optional `description` and `log_url`.
18+
19+
A deployment can accumulate multiple statuses over time as it progresses, for example from `pending` to `in_progress` to `success`. {% data variables.product.github %} tracks the most recent status for each deployment and uses it to display the deployment's current state.
20+
21+
### Data retention
22+
23+
{% data variables.product.github %} retains records of previous deployment statuses for **90 days**. Previous statuses older than 90 days are automatically deleted and are no longer returned by the REST API or GraphQL API.
24+
25+
This retention policy applies to all deployment status endpoints, including [List deployment statuses](#list-deployment-statuses) and [Get a deployment status](#get-a-deployment-status). The current status of a deployment is not affected, because it is stored on the deployment itself and remains available regardless of the deployment's age.
1626

1727
<!-- Content after this section is automatically generated -->

0 commit comments

Comments
 (0)