Skip to content

Latest commit

 

History

History
64 lines (39 loc) · 2.66 KB

releasing.md

File metadata and controls

64 lines (39 loc) · 2.66 KB

back

Release Instructions

You can build & deploy new releases with GitHub Actions as described in the following sections.

Regular Release Flow (main → test → production)

  1. In the tab bar of the GitHub project select Actions:
    Release Workflow

  2. Select the workflow Container Build and Push 🐳 ⏏️ on the left side:
    Release Workflow

  3. Click on Run workflow and a dropdown will open where you can choose a branch.

  4. Choose corresponding branch of the environment you want to deploy a new version to:
    → If you want to deploy to the test environment, choose test (will merge main into test).
    → If you want to deploy to the production environment, choose production (will merge test into production).
    Release Workflow

Hotfix Release

  1. Create a hotfix branch named hotfix/1234-short-description from the production branch (with 1234 being the issue number and short-description being a summary of the purpose of the branch).

  2. Test hotfix on your environment.

  3. Commit your fixes to the hotfix branch, then push the hotfix branch.

  4. In the tab bar of the GitHub project select Actions:
    Release Workflow

  5. Select the workflow HotFix Build and Push 🔥🚒 on the left side:
    Release Workflow

  6. Click on Run workflow and a dropdown will open where you can choose a branch.

  7. Choose the hotfix branch you've created earlier:
    Release Workflow

  8. When finished, the package repository should look similar to the following screenshot:
    Hotfix Releases

  9. Now your hotfix will be deploy automatic to test and production.

  10. To complete the process, you have to merge back the hotfix changes to production, test and main, or otherwise they would be missing in the next (regular or hotfix) release.

    1. Merge the hotfix branch into production:

      git checkout production
      git merge hotfix/1234-short-description
      git push
      
    2. Merge the hotfix branch into test:

      git checkout test
      git merge hotfix/1234-short-description
      git push
      
    3. Merge the hotfix branch into main:

      git checkout main
      git merge hotfix/1234-short-description
      # Resolve possible merge conflicts & `git commit` them...
      git push
      
  11. Finally, you can delete the hotfix branch.