Skip to content

docs: add monorepo plugin documentation - #835

Open
itaispiegel wants to merge 1 commit into
apache:mainfrom
itaispiegel:docs/monorepo-plugin
Open

itaispiegel wants to merge 1 commit into
apache:mainfrom
itaispiegel:docs/monorepo-plugin

Conversation

@itaispiegel

Copy link
Copy Markdown

Companion to apache/devlake#9037 (Plugin for per-sub-project DORA metrics in a monorepo), which is merged on main.

What this adds

docs/Plugins/monorepo.md — a page for the new metric plugin covering:

  • how deployments are attributed to a sub-project by CI job name (regex against cicd_tasks.name) and pull requests by label
  • the per-project configuration on the project settings page, and the equivalent monorepo metric plugin option for the API / advanced mode
  • includeUnattributed, and the reserved unattributed / All names
  • that only Deployment Frequency and Lead Time for Changes are computed per sub-project — CFR and MTTR need incident data, which is not attributed
  • the tables the plugin writes, and the built-in Monorepo Sub-Projects Grafana dashboard

docs/DataModels/DevLakeDomainLayerSchema.md — documents the schema the PR added: the sub_project column on pull_requests, pull_request_commits and project_pr_metrics, plus the new cicd_deployment_subprojects table.

docs/DORA.md — a short "DORA for a monorepo" section pointing at the plugin.

Verification

npm run build passes for both locales with onBrokenLinks: 'throw', so every cross-reference and anchor resolves.

🤖 Generated with Claude Code

Companion to apache/devlake#9037 (Plugin for per-sub-project DORA metrics
in a monorepo).

Adds a Plugins/monorepo page covering how deployments are attributed by CI
job name and pull requests by label, the per-project configuration on the
project settings page and its equivalent metric plugin option, the
unattributed/All reserved names, what the plugin writes, and the built-in
Monorepo Sub-Projects dashboard. It also states that only Deployment
Frequency and Lead Time for Changes are computed per sub-project, since
incidents are not attributed.

Documents the new sub_project columns on pull_requests,
pull_request_commits and project_pr_metrics plus the new
cicd_deployment_subprojects table in the domain layer schema, and links to
the plugin from the DORA page.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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