maintenance.md

Maintenance

Project dependencies should be kept up-to-date for the latest security fixes.

Upgrading Python packages

To list Python packages that need upgrading:

pip list --outdated

To upgrade local packages to their latest patch versions:

make upgrade

To upgrade packages to their latest minor or major version:

1. Bump the package version in pyproject.toml keeping the patch version zero, e.g. ~=1.2.0 to ~=1.3.0

2. Install the upgraded packages:

   pip install -e .[dev]

Upgrading Terraform

To upgrade Terraform the latest minor version:

1. For each Terraform root module in cloud, update the required version in versions.tf keeping the patch version zero:

   terraform {
     required_version = "~> <version>"
     ...
   }

2. Update the Terraform version in the CI workflow:

   - name: Setup Terraform
     uses: hashicorp/setup-terraform@v4
     with:
       terraform_version: '~<version>'

3. Update the Terraform version in the README prerequisites

Upgrading Terraform providers

To upgrade each Terraform root module in cloud:

1. Update the providers in versions.tf to the latest minor or major version keeping the patch version zero, e.g. ~> 1.2.0 to ~> 1.3.0

2. Install the upgraded providers:

   terraform init -upgrade