formigas GitHub Actions CI

A brick that provides a GitHub Actions Continuous Integration workflow for Flutter projects as we use it at formigas.

See Details for more info about the pipeline and Troubleshooting.

Usage 🛠️

See BrickHub for usage instructions.

Output 📦

The workflow file

.github/workflows/continuous-integration.yml

Setup and Configuration

The GitHub Actions CI pipeline runs validation, build and tests.
The pipeline is run on every push to develop, staging and master/main branches, as well as on every merge request.
The build stage will create a release build and runs a different flavor depending on the branch:

• develop runs the development flavor
• staging runs the staging flavor
• master/main runs the production flavor

Setup GitHub Actions for Android builds

For Android builds, an upload key is required. Please refer to Create an upload keystore to create a keystore. After having created the keystore, follow these steps to make it available to the pipeline:

1. Encode the keystore file to base64. You can use the following command assuming your keystore file is named upload-keystore.jks to encode it and then copy and paste the output to the repository secret:

cat upload-keystore.jks | base64

2. Add the keystore password as a repository secret with the name ANDROID_KEYSTORE_PASSWORD
3. Add the key password (usually the same as the keystore password) as a repository secret with the name ANDROID_KEYSTORE_PRIVATE_KEY_PASSWORD
4. Add the alias of the keystore as a repository variable (not secret) with the name ANDROID_KEYSTORE_ALIAS. The alias can be found in the command you used to create the keystore.

Configuration

The pipeline is defined in .github/workflows/continuous-integration.yml, while the build action is in .github/actions/build_app/action.yml.

• Flutter version: Make sure to update the FLUTTER_VERSION to the version of Flutter you want to use

The pipeline uses following actions:

• actions/checkout: Checkout the repository
• subosito/flutter-action: Install Flutter
• dorny/test-reporter: Add test coverage to workflow summary
• zgosalvez/github-actions-report-lcov: Upload html coverage report to workflow artifacts and comment coverage on Pull Requests

Please refer to their documentation for configuration details

Troubleshooting

Error when building Android app

Execution failed for task ':app:signDevelopmentReleaseBundle'.
> A failure occurred while executing com.android.build.gradle.internal.tasks.FinalizeBundleTask$BundleToolRunnable
   > java.lang.NullPointerException (no error message)

This error occurs when signing failed. Make sure you closely followed the steps in the Setup GitHub Actions for Android builds section. If any of the steps are not followed, the pipeline will fail with the above error.

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add formigas_github_actions

# Install globally
mason add -g formigas_github_actions

Usage 🚀

mason make formigas_github_actions

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.53 <0.1.0"

0.1.0

Docs

• Improve documentation to reduce redundancy on BrickHub page

Initial Release

• Add GitHub Actions workflow for Flutter projects
• Include CI steps for formatting, analysis, testing, and building
• Support different flavors based on branch

MIT License

Copyright (c) 2024 formigas GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.