Skip to content

docs(dora): relate an incident to its component's deployment - #840

Open
KennethWKZ wants to merge 1 commit into
apache:mainfrom
KennethWKZ:docs/dora-incident-component
Open

KennethWKZ wants to merge 1 commit into
apache:mainfrom
KennethWKZ:docs/dora-incident-component

Conversation

@KennethWKZ

Copy link
Copy Markdown

Summary

apache/devlake#9413 changed how the DORA plugin relates an incident to a deployment. Until now an incident was always tied to the project's last successful production deployment before it. Now, when the incident's component matches one of the project's CI/CD scopes (by the scope's name, such as owner/repo, or its id, case-insensitive), only that scope's production deployments are considered. If the component matches no scope, or that scope has no earlier production deployment, the project-wide rule applies as before.

This updates the docs to match:

  • docs/Plugins/webhook.md: the Summary paragraph on how incidents relate to deployments explains the component rule, and the component row in the issues table, which was empty, says what to send.
  • docs/Metrics/CFR.md: one paragraph under "How is it calculated?" on how an incident is tied to a deployment, with the component rule.
  • docs/DataModels/DevLakeDomainLayerSchema.md: the incidents component description no longer says it only supports the GitHub plugin (webhook incidents can set it) and says DORA uses it.

Only docs/ (the next version) is changed; the change is not in a release yet, so the versioned docs stay as they are.

Does this close any open issues?

No. Requested in the review of apache/devlake#9413.

Screenshots

Not applicable (text only).

Other Information

DevLakeDomainLayerSchema.md is stored with CRLF line endings, so the commit keeps them and the diff shows only the one changed line.

Document apache/devlake#9413: when an incident's component matches a CI/CD scope of the project (by name such as owner/repo, or id, case-insensitive), DORA relates the incident to that scope's last production deployment before it; otherwise the project-wide rule applies. Updates the webhook plugin page, Change Failure Rate and the incidents table.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant