butler2fox 1.0.0

Migrate your CI/CD pipelines from Jenkins to GitLab.

Butler2Fox

Butler2Fox is a CLI tool that helps you migrate your CI/CD pipelines from Jenkins to GitLab.
It automatically converts your Jenkinsfile into the equivalent .gitlab-ci.yml.

[!IMPORTANT] Scope and Limitations

1. Among the different ways to define a Jenkins pipeline, Butler2Fox only supports the Declarative Pipeline syntax.

2. Currently, Butler2Fox does not support Groovy code (script steps and any free-form Groovy statements). These unsupported code blocks will be copied as-is into the generated .gitlab-ci.yml, preceded by a warning comment:

   # 🚨 NOT MIGRATED: unsupported Groovy
   

Install

Butler2Fox requires Python 3.12 or higher and can be installed using pip package manager:

pip install butler2fox

Usage

usage: butler2fox [-h] [--debug] [--no-color] [-i INPUT] [-o OUTPUT] [-nc NAMING_CONVENTION]

This tool can be used to migrate your Jenkins pipelines to GitLab CI/CD

options:
  -h, --help            show this help message and exit
  --debug               Enable debugging
  --no-color            Disable colored output
  -i INPUT, --input INPUT
                        Input Jenkinsfile (default: stdin)
  -o OUTPUT, --output OUTPUT
                        Output GitLab CI YAML file (default: same dir as input or stdout)
  -nc NAMING_CONVENTION, --naming-convention NAMING_CONVENTION
                        Jobs and stages naming convention (one of 'unchanged', 'snake', 'kebab', 'camel' or 'pascal')

Initial inspirations

• GitLab's Migrating from Jenkins guide
• GitLab's Jenkins-to-GitLab migration made easy blog post
• Some Jenkinsfile examples for GitHub Gists

Developers

Butler2Fox is developed in Python (3.12 or higher), and is based on Poetry as packaging and dependency management system:

# install dependencies
poetry install

# run the tool
poetry run butler2fox ...

It uses Ruff for formatting and linting:

# format code
poetry run ruff format

# lint (and fix) code
poetry run ruff check --fix

And it uses pytest for unit testing:

# run tests
poetry run pytest