Skip to content

configuration.md

Latest commit

 

History

History
183 lines (139 loc) · 3.68 KB

configuration.md

File metadata and controls

183 lines (139 loc) · 3.68 KB

Configuration Guide

Configuration Files

Unified Format (deps.yaml)

The modern, unified configuration format that works across all languages:

# Language field is OPTIONAL - will auto-detect if omitted
# You can also explicitly set: go, rust, java, or auto
language: auto

packages:
  # Go/Rust format
  - name: package-name
    version: 1.2.3

  # Maven format
  - groupId: com.example
    artifactId: library
    version: 1.0.0
    scope: compile      # optional: compile, test, runtime, provided
    type: jar           # optional: jar, war, pom, etc.

Minimal example (language auto-detected):

packages:
  - name: golang.org/x/sys
    version: v0.28.0

Properties File (properties.yaml)

For Maven projects using properties:

properties:
  - property: property-name
    value: property-value

  - property: slf4j.version
    value: 2.0.16

Replaces File (replaces.yaml)

For Go module replacements:

replaces:
  - oldName: github.com/old/package
    name: github.com/new/package
    version: v2.0.0

Legacy File Names (Backward Compatible)

omnibump automatically recognizes and migrates from legacy file names:

Legacy Name New Name
gobump-deps.yaml deps.yaml
cargobump-deps.yaml deps.yaml
pombump-deps.yaml deps.yaml
pombump-properties.yaml properties.yaml
gobump-replaces.yaml replaces.yaml

Package Format Reference

Go

packages:
  - name: module-path
    version: v1.2.3

Inline format:

--packages "module-path@v1.2.3"

Special versions:

  • @latest - Latest available version
  • @v1 - Latest v1.x.x version
  • @v1.2 - Latest v1.2.x version

Version normalization (automatic):

omnibump automatically resolves versions to canonical forms:

# You specify without +incompatible
packages:
  - name: github.com/docker/docker
    version: v28.0.0

# Omnibump automatically resolves to: v28.0.0+incompatible

Note: You can also specify the +incompatible suffix explicitly if preferred:

packages:
  - name: github.com/docker/docker
    version: v28.0.0+incompatible

Both formats work - omnibump queries the Go module proxy to get the canonical version.

Rust

packages:
  - name: crate-name
    version: 1.2.3

Inline format:

--packages "crate-name@1.2.3"

Maven

packages:
  - groupId: com.example
    artifactId: library
    version: 1.2.3
    scope: compile      # optional
    type: jar           # optional

Inline format:

--packages "groupId@artifactId@version"
--packages "groupId@artifactId@version@scope"
--packages "groupId@artifactId@version@scope@type"

Examples:

--packages "io.netty@netty-codec-http@4.1.94.Final"
--packages "junit@junit@4.13.2@test"
--packages "org.example@custom@1.0.0@compile@war"

Gradle

packages:
  # Standard format (groupId:artifactId)
  - name: "org.apache.commons:commons-lang3"
    version: "3.18.0"

  # For Spring Boot library() - use display name
  - name: "org.apache.commons:Commons Lang3"
    version: "3.18.0"

Inline format:

# String notation dependencies
--packages "groupId:artifactId@version"

# Spring Boot library() dependencies (use display name)
--packages "groupId:Display Name@version"

Examples:

# Standard Gradle dependencies
--packages "org.apache.commons:commons-lang3@3.18.0"
--packages "io.netty:netty-all@4.1.101.Final"

# Spring Boot library() pattern
--packages "org.apache.commons:Commons Lang3@3.18.0"

Note: Gradle uses : separator in package names (not @ like Maven). The @ only appears before the version in inline format.