Release Process with CICD

Frontend Release Process

1. Make Necessary Changes

   • Implement all required changes in the codebase.

2. Update Version in pubspec.yaml

   • Update the version field in pubspec.yaml to reflect the new release.

3. Add Relevant Assets

   • Insert the required images or other assets.

4. Push to Main Branch

   • Commit and push the changes to the main branch.

5. Create a Release Branch

   • Branch off of main using the valid branch naming convention:
     Release-v[0-9]+.[0-9]+.[0-9]+-[0-9]+
   • The build number must always increase; v1.0.5-10 the build version is 10
   • Example: Release-v1.0.0-1
   tip

   Make sure a valid runner is avalible for the action to run on.

6. Handle Errors

   • If any errors occur during the release process, ensure to:
     • Remove the tag and release from GitHub:
       • Releases
       • Tags
     • Try again; Re-run the Github Actions.

Linux Action Runner

In order to run GitHub Actions, you will need a Linux runner that meets the requirements. The runner we use is a Virtual Machine (VM) with the tags: self-hosted, Linux.

Steps to Set Up

1. Install Oracle VM VirtualBox

   You will need Oracle VM VirtualBox installed on your machine. You can download it from the official website:

   Oracle VM VirtualBox

2. Download the VM Image

   warning

   This download is 20GB, and it may take about 5 minutes to uncompress.

   Download the VM image from the link below:

   • Download VM (Short URL)
   • Download VM (Long URL)

3. Add the VM to VirtualBox

   • Open VirtualBox and go to Machine > Add.

   • Select the .vbox file from the downloaded VM.

   • Your setup should look like the screenshot below:

     

4. Boot the VM

   • Start the VM.
   info

   If you encounter errors regarding the shared folder not being found, don't worry about it. It won't affect the runner setup.

5. Login and Navigate to the Runner Folder

   • Log in with the root password.

   • Navigate to the runner folder by going to documents/runner/actions-runner

     

6. Run the Runner

   • Inside the runner folder, run the run.sh script.

   • If everything is set up correctly, your actions should appear like the following:

     

   danger

   Use only one VM at a time, or you may encounter permission errors.

7. GitHub Actions Runners Settings

   • You can manage the runner settings on your GitHub repository by navigating to:

     GitHub Actions Runners Settings