Release and Hotfix procedures - tchapgouv/tchap-android GitHub Wiki

For the release versions of Tchap-Android, we use git-flow.

/!\ Before starting any procedure, be sure to always be up to date in your local git repository with develop and main branches.

Release

  1. Using git-flow, start a new release tchap_vX.Y.Z and push the new branch release/tchap_vX.Y.Z to origin.
  2. If necessary, add a commit to change the version number of Tchap-Android in build.gradle and towncrier.toml.
  3. Generate and commit the changelog by running towncrier build.
  4. Create a new PR from the release branch against main.
  5. Once approved, DO NOT MERGE THE PR.
  6. Finish the release git-flow LOCALLY and DO NOT REMOVE the hotfix branch, do not push anything to origin for the moment.
  7. Verify that main and develop branches have been correctly updating by the git-flow (release branch merged into main, main merged into develop).

/!\ To continue, you must have the right to push on develop and main to finish the git-flow process.

  1. If there is no error, add a tag tchap_vX.Y.Z on the merge commit against main, push the tag, main and develop branches to origin.
  2. The release PR on Github should have been automatically merged and the release branch deleted (no action needed from your side).
  3. You can now create the release or pre-release on GitHub and copy past the changelog.

Hotfix

  1. Using git-flow, start a new hotfix tchap_vX.Y.Z and push the new branch hotfix/tchap_vX.Y.Z to origin.
  2. Add a commit to increment the minor version number (Z) of Tchap-Android in build.gradle and towncrier.toml.
  3. Cherry-pick the potential commits already merged in develop that you want for the hotfix.
  4. Create a PR against this hotfix branch for each new bugfix related to the hotfix. Merge them once approved.
  5. When the hotfix is ready, generate and commit the changelog by running towncrier build.
  6. Create a new PR from the hotfix branch against main.
  7. Once approved, DO NOT MERGE THE PR.
  8. Finish the git-flow LOCALLY and DO NOT REMOVE the hotfix branch, do not push anything to origin for the moment.
  9. Verify that main and develop branches have been correctly updating by the git-flow (hotifx branch merged into main, main merged into develop).

/!\ To continue, you must have the right to push on develop and main to finish the git-flow process.

  1. If there is no error, add a tag tchap_vX.Y.Z on the merge commit against main, push the tag, the main branch and develop to origin.
  2. The hotfix PR on Github should be automatically merged and the hotfix branch deleted.
  3. You can now create the version on GitHub and copy past the changelog.