Noxsios/R2-D2

R2-D2 - Robotic Release Documentation Delivery

Installing

Python 3.9+ is a prereq.

# create a venv if needed
python3 -m venv venv
source venv/bin/activate

# install from git
python3 -m pip install git+https://github.com/noxsios/r2-d2.git

Usage

Run in interactive CLI mode:

r2d2

Run in noninteractive CLI mode w/ config from ~/.r2d2/config.yaml:

yq -i '.interactive = false' ~/.r2d2/config.yaml
# replace below w/ your Repo1 token
yq -i '.repo1_token = "<token>"' ~/.r2d2/config.yaml
# replace below w/ relative path to your local cloned bigbang repo
yq -i '.bb_path = "<path>"' ~/.r2d2/config.yaml
# steps you want to run, ex. "Check last release SHAs", "Create release branch"
yq -i '.steps = ["<step1>", "<step2>", "<step3>"]' ~/.r2d2/config.yaml

# run it
r2d2

Developing

This project requires the poetry python package to be installed globally. For developing on Windows, I recommend using the Open Folder in a Container... feature of VS Code and opening in a Python 3.9+ container.

pip install poetry

After installation, you can run the following commands to install the project dependencies:

poetry config virtualenvs.in-project true
# ^ this is so that vscode can find the venv
poetry install

# run w/
poetry run r2d2