DOCSEARCHbyAlgolia
Submit Docs

Develocity Documentation

website·Indexed 32 days ago

https://docs.develocity.ai/

Comprehensive documentation for Develocity version 2026.3, including installation, administration, and operations. Features integration guides for build tools such as Gradle (4.6), Maven (2.6), sbt (1.4), Bazel, npm (4.1), and Python (0.10). Includes specialized manuals for Develocity Test Distribution (3.8), Edge (2.3), Build Cache Node (21.2), Artifact Cache CLI (1.7), Provenance Governor (1.9), and the Develocity CLI (1.24).

Tokens
39.9K
Snippets
152
Records
290
Agent score
69%

What's inside Develocity

  1. Overview of Develocity CLI (develocityctl)

    develocityctl is a command-line tool designed for administering both standalone and Kubernetes-hosted Develocity installations. It is used to automate administrative tasks, manage system operations, and handle configuration.

  2. Overview of Develocity for Gradle

    Develocity for Gradle is integrated via the Develocity Gradle plugin. It provides two primary functions: publishing Build Scans and connecting builds to a remote Build Cache.

    • Build Scans: Permanent, shareable records that capture console logs, test results, and performance insights. They are used for troubleshooting failures, analyzing dependency resolution, and comparing builds to determine why incremental builds or cache reuse failed.
    • Remote Build Cache: Accelerates build times by reusing task outputs across different developer machines and CI environments.

  3. Overview of the Develocity Reporting and Visualization Dashboard Bundle

    The Develocity Reporting and Visualization Dashboard Bundle is a collection of Gradle-built Grafana dashboard definitions used to visualize Develocity build data (including build volume, build environment, caching, and test acceleration). It is designed for users managing their own Grafana instances.

    The bundle is available in two variants that share the same dashboards but use different data sources:

    1. Reporting Kit Variant: Queries data through the Develocity Reporting Kit.
    2. Amazon Athena Variant: Queries data through Develocity Reporting via Amazon Athena. This variant additionally includes the required Amazon Athena schema statements and Terraform modules for provisioning Amazon Managed Grafana instances.

  4. Overview of Develocity Artifact Cache CLI

    The Develocity Artifact Cache CLI is a CI-platform agnostic tool that caches downloads required by build tools, package managers, test runners, and code analysis tools, as well as Gradle build initialization inputs, on Develocity Edge nodes. At the start of a CI job, the CLI restores these inputs from the nearest Edge node to prevent re-downloading dependencies from the WAN or re-running initialization steps.

    Key capabilities include:

    • Dependency Caching: Stores and restores downloads from Edge nodes to reduce WAN traffic.
    • Setup Cache: Caches compiled build scripts, resolved configurations, buildSrc, and included builds to reduce startup time on cold CI agents.
    • CI Agnostic: Operates via shell commands in any CI environment.
    • Develocity Integration: Reports metrics to Build Scan® using Common Custom User Data plugins.
    • Edge-native: Uses Develocity Edge nodes as the persistent cache layer with automatic discovery via access key.

  5. Overview of Develocity for npm

    Develocity for npm is a tool that automatically publishes a Build Scan to a Develocity instance for every npm invocation. These scans provide a permanent, shareable record containing console output, test results, and execution details, which are used to investigate failures and track build performance. Key capabilities include:

    • Capturing full console logs and shareable URLs for every invocation.
    • Inspecting test results, durations, and per-test execution details.
    • Searching and filtering Build Scan records by project, user, outcome, and start time.
    • Enriching scans with custom tags, values, and links (e.g., VCS commit IDs or CI run URLs).
    • Integration with Gradle builds that invoke npm tasks via the Develocity Gradle plugin.

  6. Overview of Develocity Test Distribution

    Develocity Test Distribution accelerates test execution by distributing existing test suites across remote agents. It uses historical test execution data from Develocity to create balanced partitions based on expected execution times. Tests and supporting files are transferred to agents, and results/logs are streamed back to the build in real time. If no remote agents are available, tests execute locally on the build machine.

  7. Overview of Develocity for sbt

    Develocity for sbt is a plugin that integrates with sbt builds to provide two primary functions: Build Scans and Build Caching.

    • Build Scans: Create permanent, shareable records of builds that capture console logs, test results, and performance insights. These are used for troubleshooting failures, analyzing performance, and sharing build data.
    • Build Cache: Implements both local and remote caching to speed up builds by reusing task outputs across different machines and users, avoiding redundant work.

  8. Overview of Develocity for Docker

    Develocity for Docker provides a long-running daemon agent that observes a Docker builder to automatically publish a Build Scan for every image build. Unlike other agents, it requires no modifications to Dockerfiles, build commands, or CI scripts. Each Build Scan captures build step timing, cache usage, console output, failures, and image dependencies.

    Note: Docker support is not enabled by default; you must contact Develocity support to enable it.

  9. Overview of Develocity for Bazel

    Develocity integrates with Bazel using the built-in Build Event Service (BES) and gRPC remote cache protocols. It provides three primary functions: publishing Build Scans (permanent records of console output, test results, and timelines), accelerating builds via a remote cache for artifact reuse, and providing centralized visibility for failure diagnosis and performance analysis across local and CI environments.

  10. Overview of Develocity for Python

    Develocity for Python allows developers to publish a Build Scan for supported Python tool invocations to a Develocity instance. Each Build Scan captures console output and execution details. For pytest runs, the agent specifically captures test results, durations, and per-test execution details. Build Scans can be enriched with custom tags, values, and links (e.g., VCS commit identifiers or CI run URLs) and can be searched/filtered by project, user, outcome, and start time.

  11. Overview of Develocity features

    Develocity provides a suite of tools for build observability, acceleration, and test optimization. Key features include:

    • Build Scan: Provides build insights and execution records.
    • Metadata Enrichment: Enables automatic build origin detection and organization-specific Build Scan annotations.
    • Build Cache: Facilitates local and distributed output reuse to increase build speed.
    • Predictive Test Selection: Uses intelligent selection to run only the tests affected by code changes.
    • Flaky Test Detection: Identifies non-deterministic tests both within a single build and across multiple builds.
    • Test Distribution: Allows parallel test execution across multiple build agents.

  12. Overview of Develocity IntelliJ Plugin capabilities

    The Develocity IntelliJ plugin integrates Gradle and Maven build performance and test history directly into IntelliJ IDEA. It allows developers to diagnose build and test issues without leaving the IDE by providing a live build timeline, inline historical test results, and seamless Build Scan publishing to develocity.ai or a private Develocity server.