Skip to content

Workflow

Jump to bottom
J. R. Smith edited this page Feb 22, 2024 · 2 revisions

To add a new feature:

  • Check out a feature branch from develop (recommended: feature/$ticket-summary or feature/$milestone/main)
  • Commit your changes, including corresponding updates to CHANGELOG.md
  • Create a Pull Request against develop
  • Merge Pull Request into develop (triggers develop action workflow)
    • Tests executed
    • Deployment to DEV env

To release a feature:

  • Ensure that the CHANGELOG.md is up to date in develop
  • Ensure the develop branch has the desired release version in version.py (i.e $version-SNAPSHOT)
  • Create a Pull Request for develop against main
  • Merge Pull Request into main (triggers main action workflow)
    • Tests executed
    • Project tagged
    • Version bumped to next incremental snapshot
    • Deployment to PROD env
Clone this wiki locally