Skip to content

Latest commit

 

History

History
73 lines (39 loc) · 1 KB

CONTRIBUTING.rst

File metadata and controls

73 lines (39 loc) · 1 KB
Raw

jenkinscfg

Prerequisites

  • Python >= 3.8
python3 --version

Setup

  1. Create virtual environment
mkdir -p ~/.virtualenv
python3 -m venv ~/.virtualenv/jenkinscfg
  1. Activate virtual environment
source ~/.virtualenv/jenkinscfg/bin/activate
  1. Install Python packages required for development

Only do this while the virtual environment is active.

pip install -e '.[dev]'
  1. Execute the unpackaged jenkinscfg CLI

Only do this while the virtual environment is active.

python3 src/jenkinscfg/cli.py update --dry-run <jobs_path>

Lint

Perform a linter check via:

make lint

Test

Perform a test run via:

make test
make test.unit
make test.integration

To run a particular test run the following and specify the test function:

pytest -s -vvv -k test_function_xyz