Docs/Getting Started/Deploys

Deploys

The Deploys setting lets you specify how to track deployment data to calculate the Deploy and DORA metrics.

Configuration:

Data Source

Select the source for tracking deployments:

  • Git Provider: Use this option if deployments are detected from tags or commits to a specific branch in your Git repository.
  • API: Choose this option if deployments are submitted directly to DevStats via the API as part of your CI/CD pipeline. This method provides more precise control and ensures all deployments are accounted for.

Deploy Type

Define how deployments are identified:

  • Tag: Track deployments by a tag.
  • Branch: Track deployments by a branch.

Deploy Branch

Select which branch you want DevStats to consider for deployments.

Changing this setting will recalculate the deployment data, which may take time depending on the size of your repository.

Apply to

Control whether deployment settings are applied globally or only to specific repositories:

  • All Repositories: Apply the configuration to every repository.
  • Selected Repositories: Apply the configuration only to chosen repositories. Use the search and checkboxes to select repositories, each showing the configured deploy branch.

Data Sources

Choose how DevStats should collect deployment information:

Git Provider

  • Deployments are detected from tags or commits to a specified branch in your Git repository.
  • Best for teams that manage deployments directly through Git.

DevStats API

  • Deployments are submitted via the API as part of your CI/CD pipeline.
  • Offers precise control and ensures that all deployments are accounted for.
  • See the Deploy API guide for implementation details.

Deploy Settings

After selecting the data source, configure how deployments should be tracked:

Deploy Type

  • Tag – Track deployments when a new tag is created.
  • Branch – Track deployments when code is committed or merged into a branch.

Deploy Branch

  • Specify the branch DevStats should consider for deployments.
  • Changing the branch triggers a recalculation of deployment data, which may take time depending on repository size.

Repository Scope

Control whether settings apply globally or to specific repositories:

  • All Repositories – Apply the configuration to every repository in your workspace.

  • Selected Repositories – Apply the configuration only to chosen repositories.

  • Use the search bar and checkboxes to filter and select repositories.

  • Each selected repository displays its configured deploy branch.

Example

In the example below:

  • Deploy Type: Branch
  • Deploy Branch: main
  • Scope: Selected Repositories (Alpha/Alpha and Alpha/Zion)

Both repositories will have deployments tracked from the main branch.

Tip: The Deploy API guide provides detailed instructions on submitting deployment data and ensuring accurate tracking of your metrics.