Plugin Development on Divekit

Authoring Guide

Mon, 01 Jan 0001 00:00:00 +0000

Authoring contracts are still experimental and may evolve.

This page is now only a stable pointer.

Source of Truth

Plugin authoring and CI conventions should be maintained in the plugin template repository:

divekit/plugins/divekit-plugin-template

That repository should define:

repository layout: manifest.json, job.yaml, Dockerfile, code under src/
the plugin image, derived from the suite’s build image
optional reusable feedback assets under feedback/
release-template usage
plugin artifact-writing conventions
FAQ artifact conventions
copyable examples for new plugin repositories

Stable Summary

A plugin is one repository inside its suite’s GitLab group, named after the plugin id. Every plugin repository provides:

Configuration Wizards

Mon, 01 Jan 0001 00:00:00 +0000

Plugins can expose their own CLI configuration flow with a declarative wizard. The plugin repository keeps the questions and the JSON shape its job reads; Divekit CLI provides the terminal UI and writes the result where the plugin job finds it.

The intended workflow for a course maintainer is:

divekit plugin add maven
divekit plugin configure maven

divekit plugin configure <suite> runs the wizards of the suite’s enabled plugins in one session, in plugin order; divekit plugin configure <suite>/<plugin> runs one of them. Divekit reads each wizard at the plugin release the course has locked, so the questions always match the plugin version that evaluates the answers. A plugin without a wizard simply contributes no questions.

Contract Reference

Mon, 01 Jan 0001 00:00:00 +0000

Use this as the current contract baseline for new plugins.

This page is now a short summary of the CLI-consumed plugin contract. The implementation-coupled source of truth belongs in the Divekit CLI repository.

Stable Summary

Plugins are organized in plugin suites. A suite owns one build ecosystem and its build stage (maven, gradle, the generic custom suite); a plugin is one analysis inside a suite. On GitLab a suite is a group under divekit/plugins/, its builder repository is the coordinator, and every plugin is one repository next to it. The CLI currently expects the following:

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

This page stays as a quick maintainer-facing checklist. Detailed contract and authoring rules live elsewhere.

Discovery Fails

Check:

divekit plugin source list
divekit plugin discover --verbose

Verify:

the source is configured and trusted
the suite’s builder repository exposes manifest.json with "kind": "plugin-suite" on its default branch
the plugin repository exposes manifest.json with "kind": "plugin" and is pinned in the suite manifest
the pinned range matches a published tag, and that tag has an image in the plugin’s container registry

Plugin Does Not Run

Check: