Repository navigation
docs(dora): relate an incident to its component's deployment - #840
Open
KennethWKZ wants to merge 1 commit into
Open
KennethWKZ wants to merge 1 commit into
KennethWKZ wants to merge 1 commit into
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
componentmatches one of the project's CI/CD scopes (by the scope's name, such asowner/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 thecomponentrow 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 incidentscomponentdescription 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.mdis stored with CRLF line endings, so the commit keeps them and the diff shows only the one changed line.