Repository navigation
docs: document the DORA source branch pattern for lead time for changes - #836
Draft
chenwei791129 wants to merge 1 commit into
Draft
chenwei791129 wants to merge 1 commit into
chenwei791129 wants to merge 1 commit into
Conversation
Companion to apache/devlake#9229, which adds a DORA project setting that counts only merged pull requests whose source branch matches a regex. Adds a "Choose which pull requests count" section to the Lead Time for Changes page: why to use it, where to set it, how the pattern is matched, examples, which metrics it affects, and the equivalent dora metric plugin option. Links to it from the DORA page and the PR Cycle Time page.
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
Companion to apache/devlake#9229, which adds a DORA project setting, Source branch pattern (
prHeadRefPattern). When it is set, only merged pull requests whose source branch matches the regex count toward Lead Time for Changes. This PR is a draft until apache/devlake#9229 is merged, since the option may still change in review.docs/Metrics/LeadTimeForChanges.mdrefs/heads/prefix, empty and invalid values), examples, which metrics it affects, and the equivalentdorametric plugin option. A one-line pointer to it at the end of "How is it calculated?"docs/DORA.mddocs/Metrics/PRCycleTime.mdDoes this close any open issues?
Related: apache/devlake#9222 (closed by apache/devlake#9229).
Screenshots
N/A. Text only.
Other Information
v1.0.3-beta18release". I will update it if a new release ships before feat(dora): filter pull requests by source branch pattern in lead time for changes devlake#9229 is merged.Verification:
npm run buildpasses for both locales withonBrokenLinks: 'throw', and I checked the three pages withnpm run serve.