Release

Publishing Releases

1. Prepare for Release

Test & Review: Ensure code is thoroughly tested and reviewed.

Merge Changes: Confirm all changes are merged into the main branch.

Update Docs: Refresh any relevant documentation.

2. Create a Git Tag

Commit Changes (if any):

git add .
git commit -m "Prepare for release v1.0.0"

Create & Push Tag:

git tag -a v1.0.0 -m "Release version 1.0.0"
git push origin v1.0.0

3. Deploy the Release

Trigger Deployment: Use CI/CD pipeline or scripts to deploy the tagged version.

Verify: Ensure the release is functioning as expected.

4. Document the Release

Release Notes: Include version number, release date, new features, bug fixes, and known issues.

5. Rollback if Needed

Deploy Previous Tag:

Simply re-run the deploy-prod workflow corresponding to the previous tag.