Skip to content

docs: document the DORA source branch pattern for lead time for changes - #836

Draft
chenwei791129 wants to merge 1 commit into
apache:mainfrom
chenwei791129:docs/dora-pr-head-ref-pattern
Draft

chenwei791129 wants to merge 1 commit into
apache:mainfrom
chenwei791129:docs/dora-pr-head-ref-pattern

Conversation

@chenwei791129

Copy link
Copy Markdown

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.

File Change
docs/Metrics/LeadTimeForChanges.md New section Choose which pull requests count (optional): why to use it, where to set it, how the pattern is matched (field, RE2 syntax, anchors, case, refs/heads/ prefix, empty and invalid values), examples, which metrics it affects, and the equivalent dora metric plugin option. A one-line pointer to it at the end of "How is it calculated?"
docs/DORA.md Short Count only some pull requests section linking to the new section, next to "DORA for a monorepo"
docs/Metrics/PRCycleTime.md One sentence noting that only matching PRs are measured when the pattern is set

Does this close any open issues?

Related: apache/devlake#9222 (closed by apache/devlake#9229).

Screenshots

N/A. Text only.

Other Information

Verification: npm run build passes for both locales with onBrokenLinks: 'throw', and I checked the three pages with npm run serve.

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.
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