Docs on releases

[dbatten5]

Are there any docs on the release workflow? Seems like I need to bump the version on a release/{version} branch but would be good to see exactly what's needed to create a release

[56kyle]

Hey, sorry about that will definitely add some. Works been a bit crazy lately but will start having some more time to focus on this in about a week or so, and definitely working on the template docs as soon as I can

For setting up a release the workflow is the following:

git checkout develop
# Ensure you have no outstanding changes, the script will purposely fail if "git status --porcelain" doesn't pass

nox -s setup-release -- {PATCH_TYPE}

# PATCH_TYPE can be one of ["MAJOR", "MINOR", "PATCH", "PRERELEASE"]

This should leave you with release/x.y.z checked out, committed, and ready to be pushed to remote if everything went as expected.

From there the workflow would be:

• Create a PR from release/x.y.z into main
• Should automatically run a bunch of CI/CD checks
• Merge release/x.y.z into main through PR
• Fetch changes locally and update local main
• Merge local main into local develop
• Push local develop to remote
• Merge local develop into local features as needed

Can definitely vary from this workflow, and I doubt it should affect too much, but this is kinda what I've been doing for the time being.

I've tried out using proper gitflow where you merge release/x.y.z into main and develop individually, and then leave the histories separate, but I kept running into history reference problems and some weird CI/CD flow issues with tagging doing it that way