Skip to content

Commit e181c5e

Browse files
committed
line edits
1 parent 42d3965 commit e181c5e

File tree

1 file changed

+12
-12
lines changed
  • content/en/dora_metrics/change_failure_detection

1 file changed

+12
-12
lines changed

content/en/dora_metrics/change_failure_detection/_index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ A rollback occurs when a previously deployed version is redeployed to restore th
4141

4242
### How rollback classification works
4343

44-
A deployment is classified as a `rollback` when it deploys a version that matches a previously deployed version but differs from the immediately preceding deployment.
44+
A deployment is classified as a rollback when it deploys a version that matches a previously deployed version but differs from the immediately preceding deployment.
4545

4646
- If Git metadata is present, the match is based on the commit SHA.
4747
- If Git metadata is not present, the match is based on the version tag.
@@ -64,9 +64,9 @@ Rollforwards are detected through custom rules that match deployment metadata pa
6464

6565
## Custom rules
6666

67-
DORA Metrics lets you define custom rules to automatically classify rollforward deployments based on repository or release metadata. Rules can operate in two ways:
68-
- **Linking deployments**: Match deployments through shared variable values (for example, PR number and version)
69-
- **Static patterns**: Match metadata patterns without variables (for example, labels and branch names)
67+
You can define custom rules to automatically classify rollforward deployments based on repository or release metadata. Rules can operate in two ways:
68+
- **Linking deployments**: Match deployments through shared variable values (for example, PR number or version)
69+
- **Static patterns**: Match metadata patterns without variables (for example, labels or branch names)
7070

7171
### Rules linked to failed deployments
7272

@@ -81,7 +81,7 @@ You can enter regex rules that include one of these variables:
8181

8282
#### How variable-based classification works
8383

84-
When a rule matches:
84+
When a rule matches a deployment, the following actions occur:
8585
1. The variable value is extracted from the current deployment.
8686
2. The system finds the earlier deployment with the same extracted value.
8787
3. The current deployment is marked as a rollforward linked to that earlier deployment.
@@ -97,11 +97,11 @@ Revert pull requests are a common recovery pattern. For example, a PR titled `Re
9797
Revert "$pr_title"
9898
```
9999

100-
When a PR title matches this pattern:
101-
- The system extracts the original PR title from the revert PR (the value of `$pr_title`)
102-
- It finds the earlier deployment that included that original PR
103-
- The earlier deployment is marked as the change failure
104-
- The current deployment (with the revert) is marked as the rollforward
100+
When a PR title matches this pattern, the following actions occur:
101+
1. The system extracts the original PR title from the revert PR (the value of `$pr_title`).
102+
2. It finds the earlier deployment that includes that original PR title.
103+
3. The current deployment (with the revert) is marked as the rollforward.
104+
4. The earlier deployment is marked as the change failure.
105105

106106
**Note**: If the original PR isn't found in any prior deployment, or if both the original PR and its revert are in the same deployment, no classification is applied.
107107

@@ -121,7 +121,7 @@ You can define regex rules that match specific types of metadata. The following
121121

122122
#### How static rule classification works
123123

124-
When a static rule matches:
124+
When a static rule matches a deployment, the following actions occur:
125125
1. The current deployment is marked as a rollforward.
126126
2. The immediately preceding deployment is marked as the change failure.
127127

@@ -135,7 +135,7 @@ Datadog provides default rules that are automatically enabled:
135135
- **Revert PRs**: PR titles following revert naming conventions (for example, "Revert" referencing a prior PR) are treated as rollforwards. The earlier deployment containing the original change is marked as the change failure, using the variable-based linking rules described above.
136136
- **Hotfix indicators**: PR labels, titles, or branch names containing "hotfix" are treated as rollforwards, with the preceding deployment marked as the change failure.
137137

138-
These default rules are fully configurable in the [DORA Settings][1] page. They are intended as opinionated starting points that interpret common signals as likely rollforward activity. Teams are encouraged to adapt the patterns (for example, naming conventions, labels, or version tags) to reflect their own workflows and improve accuracy over time.
138+
These default rules are fully configurable in the [DORA metrics settings][1] page. They are intended as opinionated starting points that interpret common signals as likely rollforward activity. You should adapt the patterns (such as naming conventions, labels, or version tags) as needed to reflect your own workflows and improve accuracy over time.
139139

140140
## Further reading
141141

0 commit comments

Comments
 (0)