Skip to content

Latest commit

 

History

History
98 lines (55 loc) · 2.1 KB

development.rst

File metadata and controls

98 lines (55 loc) · 2.1 KB

Development

This guide provides instructions for running tests and executing buildrunner locally during development.

Unit tests

The unit tests use pytest. To run the tests, execute the following commands:

  1. Clone the buildrunner repository
git clone https://github.com/adobe/buildrunner.git
  1. Navigate to the root of the buildrunner repository
  2. Install dependencies
uv sync

  1. Run the tests

    Run all the tests by typing uv run pytest

    uv run pytest

    To run a specific test file, provide the path to the file

    uv run pytest tests/test_buildrunner.py

Locally

To run buildrunner locally in the buildrunner directory, use uv run. This ensures that the latest local changes are used when running buildrunner. The examples/ directory contains example buildrunner configuration files that can be used to test the functionality of buildrunner. To run buildrunner locally follow these steps:

  1. Clone the buildrunner repository
git clone https://github.com/adobe/buildrunner.git
  1. Navigate to the root of the buildrunner repository
  2. Install dependencies
uv sync
  1. Run buildrunner
uv run buildrunner -f examples/build/basic/buildrunner.yaml

Another repository

It is also possible to install and run a working version of buildrunner in another repository. To do this, follow these steps:

  1. Clone the buildrunner repository
git clone https://github.com/adobe/buildrunner.git
  1. Navigate to the root of the desired repository
  2. Install buildrunner
uv tool install ..</path/to>/buildrunner
  1. Run buildrunner
buildrunner --help

Note

You can verify that you are using the correct buildrunner by typing which buildrunner.