CI pipeline for Flut

.github/ISSUE_TEMPLATE/bug_report.md

@@ -22,7 +22,7 @@ Describe how you expected the application to work.
 
 ## Actual Behavior
 <!--
-Describe how the API really works
+Describe how the application really works
 You can provide a screenshot to help us
 BEWARE: HIDE ANY SENSITIVE DATA FROM YOUR SCREENSHOT
 THIS APPLICATION CAN SEND SENSITIVE DATA AND THIS ISSUE IS PUBLIC

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  - package-ecosystem: "pub"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "chore(deps)"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "chore(deps)"

.github/workflows/00-main.yml

@@ -0,0 +1,124 @@
+name: main-workflow
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}
+
+jobs:
+  test:
+    uses: ./.github/workflows/01-analyze-test.yml
+
+  parse-screenshot:
+    uses: ./.github/workflows/01-parse-screenshot.yml
+    with:
+      # Set to empty string to always take screenshots
+      screenshot-text: "SCREENSHOT"
+
+  conventional-release:
+    needs:
+      - test
+    uses: ./.github/workflows/02-conventional-release.yml
+    secrets: inherit
+
+  build-android:
+    # set if false to disable android branch of build
+    if: ${{ needs.conventional-release.outputs.new_release_published == 'true' }}
+    needs:
+    - parse-screenshot
+    - conventional-release
+    uses: ./.github/workflows/03-build-android.yml
+    with:
+      screenshot: ${{ needs.parse-screenshot.outputs.contains_screenshot }}
+      apk: "true"
+    secrets: inherit
+
+  build-ios:
+    # set if false to disable iOS branch of build
+    if: ${{ needs.conventional-release.outputs.new_release_published == 'true' }}
+    needs:
+      - parse-screenshot
+      - conventional-release
+    uses: ./.github/workflows/03-build-ios.yml
+    with:
+      screenshot: ${{ needs.parse-screenshot.outputs.contains_screenshot }}
+      ipa: "true"
+    secrets: inherit
+
+  integration-screenshot-android:
+    if: ${{ needs.parse-screenshot.outputs.contains_screenshot == 'true' }}
+    needs:
+      - parse-screenshot
+      - build-android
+    uses: ./.github/workflows/10-take-screenshot-android.yml
+    with:
+      api_level: 34
+      model: "['pixel_6']"
+
+  integration-screenshot-ios:
+    if: ${{ needs.parse-screenshot.outputs.contains_screenshot == 'true' }}
+    needs:
+      - parse-screenshot
+      - build-ios
+    uses: ./.github/workflows/10-take-screenshot-ios.yml
+    with:
+      model: "['iPhone 16 Pro Max', 'iPad Pro 13-inch (M4)']"
+
+  integration-screenshot-commit-android:
+    needs:
+      - integration-screenshot-android
+    uses: ./.github/workflows/11-commit-screenshot-android.yml
+    with:
+      locale: "['fr-FR']"
+    secrets: inherit
+
+  integration-screenshot-commit-ios:
+    needs:
+      - integration-screenshot-ios
+    uses: ./.github/workflows/11-commit-screenshot-ios.yml
+    with:
+      locale: "['fr-FR']"
+    secrets: inherit
+
+  upload-android:
+    if: ${{ needs.parse-screenshot.outputs.contains_screenshot == 'false' }}
+    needs:
+      - build-android
+      - conventional-release
+    uses: ./.github/workflows/04-upload-android.yml
+    with:
+      new_release: ${{ needs.conventional-release.outputs.new_release }}
+      new_release_notes: ${{ needs.conventional-release.outputs.new_release_notes }}
+    secrets: inherit
+
+  upload-ios:
+    if: ${{ needs.parse-screenshot.outputs.contains_screenshot == 'false' }}
+    needs:
+      - parse-screenshot
+      - build-ios
+      - conventional-release
+    uses: ./.github/workflows/04-upload-ios.yml
+    with:
+      new_release: ${{ needs.conventional-release.outputs.new_release }}
+      new_release_notes: ${{ needs.conventional-release.outputs.new_release_notes }}
+    secrets: inherit
+
+  upload-android-with-screenshots:
+    needs:
+    - integration-screenshot-commit-android
+    uses: ./.github/workflows/04-upload-android.yml
+    with:
+      new_release: ${{ needs.conventional-release.outputs.new_release }}
+      new_release_notes: ${{ needs.conventional-release.outputs.new_release_notes }}
+    secrets: inherit
+
+  upload-ios-with-screenshots:
+    needs:
+      - integration-screenshot-commit-ios
+    uses: ./.github/workflows/04-upload-ios.yml
+    with:
+      new_release: ${{ needs.conventional-release.outputs.new_release }}
+      new_release_notes: ${{ needs.conventional-release.outputs.new_release_notes }}
+    secrets: inherit

.github/workflows/01-analyze-test.yml

@@ -0,0 +1,21 @@
+name: test-analyze
+on:
+  workflow_call:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - name: Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          cache: true
+          cache-key: 'flutter-:os:-:channel:-:version:-:arch:-:hash:'
+          cache-path: "${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch:"
+      - run: flutter pub get
+      - run: flutter analyze --no-pub #--no-fatal-infos
+      - run: flutter test

.github/workflows/01-parse-screenshot.yml

@@ -0,0 +1,39 @@
+name: parse-screenshot
+
+on:
+  workflow_call:
+    inputs:
+      screenshot-text:
+        description: 'Text to search for in commit message'
+        required: true
+        type: string
+    outputs:
+      contains_screenshot:
+        description: 'If commit message contains screenshot keyword'
+        value: ${{ jobs.check_commit_message.outputs.contains_screenshot }}
+
+jobs:
+  check_commit_message:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Check Commit Message for '${{ inputs.screenshot-text }}'
+        id: check_commit
+        run: |
+          COMMIT_MESSAGE=$(git log --format=%B -n 1 ${{ github.sha }})
+          if [[ $COMMIT_MESSAGE == *"${{ inputs.screenshot-text }}"* ]]; then
+            echo "Contains Screenshot: true"
+            echo "contains_screenshot=true" >> $GITHUB_OUTPUT
+          else
+            echo "Contains Screenshot: false"
+            echo "contains_screenshot=false" >> $GITHUB_OUTPUT
+          fi
+        shell: bash
+
+    outputs:
+      contains_screenshot: ${{ steps.check_commit.outputs.contains_screenshot }}

.github/workflows/02-conventional-release.yml

@@ -0,0 +1,41 @@
+name: conventional-release
+on:
+  workflow_call:
+    secrets:
+      GH_TOKEN:
+        required: true
+
+    outputs:
+      new_release_published:
+        description: 'If a new release was published'
+        value: ${{ jobs.conventional-release.outputs.new_release_published }}
+      new_release_version:
+        description: 'The new release version'
+        value: ${{ jobs.conventional-release.outputs.new_release_version }}
+      new_release_notes:
+        description: 'The release notes for the new release'
+        value: ${{ jobs.conventional-release.outputs.new_release_notes }}
+
+jobs:
+  conventional-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 1
+          token: ${{ secrets.GH_TOKEN }}
+          fetch-tags: true
+
+      - name: Semantic Release
+        uses: codfish/semantic-release-action@v5
+        id: semantic
+        with:
+          additional-packages: |
+            ['@semantic-release/changelog', '@semantic-release/exec', '@semantic-release/git']
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+
+    outputs:
+      new_release_published: ${{ steps.semantic.outputs.new_release_published }}
+      new_release_version: ${{ steps.semantic.outputs.new_release_version }}
+      new_release_notes: ${{ steps.semantic.outputs.new_release_notes }}

.github/workflows/03-build-android.yml

@@ -0,0 +1,98 @@
+name: build-android
+on:
+  workflow_call:
+    inputs:
+      screenshot:
+        type: string
+        required: true
+      apk:
+        description: 'Run APK build'
+        type: string
+        required: true
+  workflow_dispatch:
+    inputs:
+      screenshot:
+        description: 'Run screenshot build'
+        type: choice
+        options:  ['true', 'false']
+        required: true
+      apk:
+        description: 'Run APK build'
+        type: choice
+        options:  ['true', 'false']
+        required: true
+
+jobs:
+  build-android:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    defaults:
+      run:
+        working-directory: android
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Configure Keystore
+        run: |
+          echo "$PLAY_STORE_UPLOAD_KEY" | base64 --decode > app/upload-keystore.jks
+          echo "storeFile=upload-keystore.jks" >> key.properties
+          echo "keyAlias=$KEYSTORE_KEY_ALIAS" >> key.properties
+          echo "storePassword=$KEYSTORE_STORE_PASSWORD" >> key.properties
+          echo "keyPassword=$KEYSTORE_KEY_PASSWORD" >> key.properties
+        env:
+          PLAY_STORE_UPLOAD_KEY: ${{ secrets.PLAY_STORE_UPLOAD_KEY }}
+          KEYSTORE_KEY_ALIAS: ${{ secrets.KEYSTORE_KEY_ALIAS }}
+          KEYSTORE_KEY_PASSWORD: ${{ secrets.KEYSTORE_KEY_PASSWORD }}
+          KEYSTORE_STORE_PASSWORD: ${{ secrets.KEYSTORE_STORE_PASSWORD }}
+
+      - uses: actions/setup-java@v5
+        with:
+          distribution: 'zulu'
+          java-version: '17'
+
+      - name: Setup Fastlane
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.2"
+          bundler-cache: true
+          working-directory: android
+
+      - run: bundle install
+
+      - run: bundle exec fastlane versioning
+        env:
+          PLAY_STORE_CONFIG_JSON: ${{ secrets.PLAY_STORE_CONFIG_JSON }}
+
+      - name: Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          cache: true
+          cache-key: 'flutter-:os:-:channel:-:version:-:arch:-:hash:'
+          cache-path: "${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch:"
+      - run: flutter build apk --debug --target=integration_test/screenshot_test.dart
+        if: ${{ inputs.screenshot == 'true' }}
+
+      - name: Archive integration test apk
+        if: ${{ inputs.screenshot == 'true' }}
+        uses: actions/upload-artifact@v7
+        with:
+          name: app-debug.apk
+          path: build/app/outputs/flutter-apk/app-debug.apk
+          if-no-files-found: error
+          retention-days: 3
+
+      # Build android Release
+
+      - run: flutter build appbundle --build-number ${{ env.ANDROID_VERSION_CODE }} --build-name ${{ env.ANDROID_VERSION_NAME }} --target lib/main.dart
+        if: ${{ inputs.apk == 'true' }}
+
+      - name: Archive appbundle
+        if: ${{ inputs.apk == 'true' }}
+        uses: actions/upload-artifact@v7
+        with:
+          name: app-release.aab
+          path: build/app/outputs/bundle/release/app-release.aab
+          if-no-files-found: error
+          retention-days: 3