Maven Check Versions

Is a Python package designed for analyzing Maven POM files and managing dependencies. It checks the versions of dependencies in a project and identifies the latest available versions in Maven repositories. Developed for developers, this package simplifies dependency management in Maven-based projects. It is especially useful in CI/CD environments, where maintaining consistency and up-to-date dependencies is critical.

Features

• Dependency Analysis: Parses Maven POM files to analyze dependencies and plugins.
• Version Checking: Identifies outdated dependencies and checks versions against customizable thresholds.
• Artifact Search: Finds specific artifacts using groupId:artifactId:version format.
• Repository Support: Integrates with HTTP-based Maven repositories, including REST services.
• Module Processing: Processes nested modules in Maven projects.
• Caching: Caches results for faster rechecks.
• Logging: Provides configurable logging for detailed analysis.
• Command-Line Interface: Easily integrates into CI/CD pipelines.

Installation

You can install the tool via pip:

pip install maven_check_versions

Usage

• Analyze a specific pom file:

maven_check_versions --pom_file path/to/pom.xml

• Search for a specific artifact:

maven_check_versions --find_artifact com.example:my-lib:1.0

• Enable CI mode to suppress prompts:

maven_check_versions --ci_mode

Docker image

Pull image from GitHub:

docker pull ghcr.io/alexundros/maven-check-versions

Or pull image from DockerHub:

docker pull alexundros/maven-check-versions

• Analyze a specific pom file:

docker run --rm -v 'path/to/pom.xml:/app/pom.xml' alexundros/maven_check_versions -pf /app/pom.xml

• Search for a specific artifact:

docker run --rm alexundros/maven_check_versions -fa com.example:my-lib:1.0

• Enable CI mode to suppress prompts:

docker run --rm alexundros/maven_check_versions -ci

Command-Line Arguments

General Options

Cache Control

Logging Options

Configuration Options

Error Handling and Validation

Dependency Search and Processing

Performance Options

Authentication

Configuration

You can customize the tool’s behavior using a configuration file maven_check_versions.yml. The following settings can be adjusted:

• SSL Verification: Enable or disable SSL verification for HTTP requests.
• Cache Preferences: Control cache duration and behavior.
• Repository Settings: Define base URLs, authentication, and paths for repositories.
• Logging Preferences: Specify log levels and file paths.

Example configuration

maven_check_versions.yml:

base:
  cache_off: false
  cache_time: 600
  fail_mode: false
  fail_major: 0
  fail_minor: 0
  search_plugins: false
  process_modules: false
  show_skip: false
  show_search: false
  empty_version: false
  show_invalid: false
  skip_version: true
  threading: false
  max_threads: 8
  user: "USER"
  password: "PASSWORD"

pom_http:
  auth: true

urllib3:
  warnings: true

requests:
  verify: true

pom_files:
  pom-name: "path/to/pom.xml"

repositories:
  "Central (repo1.maven.org)": "repo1.maven"

repo1.maven:
  base: "https://repo1.maven.org"
  path: "maven2"
  auth: false

Environment Variables

The tool supports environment variables to override configuration settings or provide credentials for external services. Below is a list of supported environment variables:

Configuration Overrides

These variables override settings from the maven_check_versions.yml file or command-line arguments. The format is CV_<KEY> where <KEY> corresponds to a configuration key in the base section (case-insensitive).

Usage Example

To override cache settings:

export CV_CACHE_TIME=1800
maven_check_versions --pom_file path/to/pom.xml

License

This project is licensed under the MIT License. See the LICENSE file for more details.