DEVELOPING.md

Developing cg-manage-rds

Setting up a local development environment

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -r requirements-dev.txt

Formatting project code using black

Make sure you have the virtual environment activated and then run:

black .

Creating a new release

1. Create a new tag:

git tag -a v0.x.x -m "Version 0.x.x"

1. Push the tag

git push origin v0.x.x

1. Once a new tag is pushed, the GitHub Actions workflow will run to:

   • Build an installable version of the package for:
     • Mac
     • Linux
     • Windows
   • Create a GitHub release for the tag
   • Update the Homebrew formula for cg-manage-rds in the cloud-gov/cloudgov tap