Flutter: Gitlab CI /CD

Tino Kallinich
Nov 29, 2019 · 3 min read

Continuous Integration /Continuous Delivery within for a Flutter App can be achieved with various Platforms and Tools. In this article I will show a example which uses Gitlab with a shared runner. As usual a Flutter project has to be created connected to a Gitlap repository. With the first commit we can deploy a standard .yml file. This .yml file will be the starting point of this blog post.

  1. Setup the project with a .gitlab-ci.yml
  2. Get a docker:image
  3. Define your stages
  4. Setup a runner

Create .gitlab-ci.yml

Once you successfully created your project it is time to setup your .yml which will be executed by a selected runner from Gitlap. The name ist defined by Flutter.dev as .gitlab-ci.yml and it has to be saved in your root package.

Declare a docker:image

In order to build your Flutter Application you need to get a valid docker image. In this example I used the docker image cirrusci/flutter:stable.

image: cirrusci/flutter:stable

If you like to have a closer look into the docker image than please follow the link to Docker Hub.

Define your stages

Each stage in your .yml file will represent a specific task executed from the Gitlab runner. Here I used three stages which should be executed and successfully passed before a merge to a branch is possible.

stages:
- build
- analyze
- test

Stage 1: build

Within the build, the runner builds the project. Please keep in mind that the build command has additional subcommands for each target platform. Run the flutter build commad without parameters in your Terminal and you will find all available target platforms. Here I selected aot as target, which stands for: “Build an ahead-of-time compiled snapshot of your app’s Dart code”.

build:
stage: build

script:
- flutter build aot

tags:
- shared

only:
- merge_requests

Stage 2: test

All your implemented unit test will be executed, as long as the follow the path /root_package/test/*.

unit_test:
stage: test

script:
- flutter test test/*

tags:
- shared

only:
- merge_requests

Stage 3: analyze

The analyze stage has been left with a echo statement only. But in general it is possible to run the flutter analyze command in it. But if you encounter any linting errors your build will be failed.

analyze:
stage: analyze

script:
- echo job excluded

tags:
- shared

only:
- merge_requests

For each stage in your .gitlab-ci.yml file you can find a script, a tag and a only condition.

The tag is used in this example this, since this .yml file is executed with shared runner within GitLab. The script uses the only condition in order to ensure that only valid code can be merged between branches.

Full Example

image: cirrusci/flutter:stable

stages:
- build
- analyze
- test

before_script:
- flutter pub get
- flutter clean

build:
stage: build

script:
- flutter build aot

tags:
- shared

only:
- merge_requests

unit_test:
stage: test

script:
- flutter test test/*

tags:
- shared

only:
- merge_requests
analyze:
stage: analyze

script:
- echo job excluded

tags:
- shared

only:
- merge_requests

Setup runner

Please the Gitlab documentation for the installation and registration of a Gitlab runner.

Happy coding …


Flutter Community

Articles and Stories from the Flutter Community

Tino Kallinich

Written by

#inovex #Flutter

Flutter Community

Articles and Stories from the Flutter Community

More From Medium

More from Flutter Community

More from Flutter Community

More from Flutter Community

DateField in Flutter Made Easy

More from Flutter Community

Welcome to a place where words matter. On Medium, smart voices and original ideas take center stage - with no ads in sight. Watch
Follow all the topics you care about, and we’ll deliver the best stories for you to your homepage and inbox. Explore
Get unlimited access to the best stories on Medium — and support writers while you’re at it. Just $5/month. Upgrade