User guide

.github/workflows/analyze-test.yaml

@@ -1,5 +1,10 @@
 on:
-  workflow_call:
+  pull_request:
+    paths-ignore:
+      - ".github/**"
+      - "docs"
+      - "Jenkinsfile"
+      - "**/*.md"
 
 name: Analyze and test
 
@@ -25,7 +30,7 @@ jobs:
       - name: Setup flutter
         uses: subosito/flutter-action@v2
         with:
-          flutter-version: "3.0.5"
+          flutter-version: "3.10.6"
           channel: "stable"
           cache: true
           cache-key: "deps-${{ hashFiles('**/pubspec.lock') }}"
@@ -56,22 +61,3 @@ jobs:
         with:
           name: test-reports
           path: test-report*.json
-
-  report:
-    runs-on: ubuntu-latest
-    if: success() || failure() # Always upload report
-    needs:
-      - analyze-test
-    steps:
-      - uses: actions/checkout@v3
-
-      - uses: actions/download-artifact@v3
-        with:
-          name: test-reports
-
-      - uses: dorny/test-reporter@v1
-        with:
-          name: Flutter Tests
-          path: "*.json"
-          reporter: flutter-json
-          only-summary: "true"

.github/workflows/ci.yaml → .github/workflows/build.yaml

@@ -1,23 +1,11 @@
 on:
   workflow_dispatch:
-  pull_request:
-    paths-ignore:
-      - ".github/**"
-      - "docs"
-      - "Jenkinsfile"
-      - "**/*.md"
 
-name: CI
+name: Build dev binaries
 
 jobs:
-  analyze-test:
-    name: Analyze and test
-    uses: ./.github/workflows/analyze-test.yaml
-
   build-app:
     name: Build app
-    needs:
-      - analyze-test
     runs-on: ${{ matrix.runner }}
     strategy:
       matrix:
@@ -35,27 +23,24 @@ jobs:
       - name: Setup flutter
         uses: subosito/flutter-action@v2
         with:
-          flutter-version: "3.0.5"
+          flutter-version: "3.10.6"
           channel: "stable"
           cache: true
           cache-key: deps-${{ hashFiles('**/pubspec.lock') }} # optional, change this to force refresh cache
           cache-path: ${{ runner.tool_cache }}/flutter # optional, change this to specify the cache path
 
+      - name: Setup Fastlane
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "ruby"
+          bundler-cache: true
+          working-directory: ${{ matrix.os }}
+
       - name: Setup Firebase env
         env:
           FIREBASE_ENV: ${{ secrets.FIREBASE_ENV }}
         run: echo "$FIREBASE_ENV" > ./configurations/env.fcm
 
-      - name: Setup Android environment
-        if: matrix.os == 'android'
-        env:
-          PLAY_STORE_UPLOAD_KEY_BASE64: ${{ secrets.PLAY_STORE_UPLOAD_KEY_BASE64 }}
-          PLAY_STORE_KEY_INFO_BASE64: ${{ secrets.PLAY_STORE_KEY_INFO_BASE64 }}
-        run: |
-          echo "$PLAY_STORE_UPLOAD_KEY_BASE64" | base64 --decode > app/keystore.jks
-          echo "$PLAY_STORE_KEY_INFO_BASE64" | base64 --decode > key.properties
-        working-directory: ${{ matrix.os }}
-
       - name: Setup Java
         if: matrix.os == 'android'
         uses: actions/setup-java@v3
@@ -65,37 +50,25 @@ jobs:
 
       - name: Setup iOS environment
         if: matrix.os == 'ios'
-        env:
-          CERTIFICATE_BASE64: ${{ secrets.CERTIFICATE_BASE64 }}
-          PROVISION_PROFILE_BASE64: ${{ secrets.PROVISION_PROFILE_BASE64 }}
-          SHAREEXT_PROVISION_PROFILE_BASE64: ${{ secrets.SHAREEXT_PROVISION_PROFILE_BASE64 }}
         run: |
-          echo -n "$CERTIFICATE_BASE64" | base64 --decode --output cert.p12
-          echo -n "$PROVISION_PROFILE_BASE64" | base64 --decode --output buildpp.mobileprovision
-          echo -n "$SHAREEXT_PROVISION_PROFILE_BASE64" | base64 --decode --output shareextpp.mobileprovision
-          flutter pub get && pod install
+          flutter pub get
+          pod install && pod update
         working-directory: ${{ matrix.os }}
 
-      - name: Setup Fastlane
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "ruby"
-          bundler-cache: true
-          working-directory: ${{ matrix.os }}
-
       - name: Run prebuild
         run: bash prebuild.sh
 
       - name: Build
         env:
-          CERTIFICATE_PASSWORD: ${{ secrets.CERTIFICATE_PASSWORD }}
+          MATCH_PASSWORD: ${{ secrets.MATCH_PASSWORD }}
+          APPLE_CERTIFICATES_SSH_KEY: ${{ secrets.APPLE_CERTIFICATES_SSH_KEY }}
         run: bundle exec fastlane dev
         working-directory: ${{ matrix.os }}
 
       - name: Upload artifacts
         uses: actions/upload-artifact@v3
         with:
-          name: tmail-dev-pr-${{ github.event.pull_request.number }}
+          name: tmail-dev
           path: |
-            build/app/outputs/flutter-apk/app-release.apk
+            build/app/outputs/flutter-apk/app-debug.apk
             ios/Runner.ipa

.github/workflows/image.yaml

@@ -0,0 +1,98 @@
+on:
+  push:
+    branches:
+      - "master"
+    tags:
+      - "v*.*.*"
+
+name: Build Docker images
+
+jobs:
+  build-dev-image:
+    name: Build development image
+    if: github.ref_type == 'branch' && github.ref_name == 'master'
+    runs-on: ubuntu-latest
+    environment: dev
+
+    steps:
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Docker metadata
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: |
+            ${{ github.repository_owner }}/tmail-web
+            ghcr.io/${{ github.repository_owner }}/tmail-web
+          tags: |
+            type=ref,event=branch
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push image
+        uses: docker/build-push-action@v4
+        with:
+          push: true
+          cache-from: |
+            type=gha
+          cache-to: |
+            type=gha
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+  build-release-image:
+    name: Build release image
+    if: github.ref_type == 'tag' && startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    environment: prod
+
+    steps:
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Docker metadata
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: |
+            ${{ github.repository_owner }}/tmail-web
+            ghcr.io/${{ github.repository_owner }}/tmail-web
+          tags: |
+            type=ref,event=tag
+            type=raw,value=release
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push image
+        uses: docker/build-push-action@v4
+        with:
+          push: true
+          cache-from: |
+            type=gha
+          cache-to: |
+            type=gha
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/pr-deployments.yaml

@@ -0,0 +1,69 @@
+on:
+  pull_request:
+    paths:
+      - "**/*.dart"
+
+name: Deploy PR on Github Pages
+
+jobs:
+  deploy:
+    name: Build web version and deploy
+    runs-on: ubuntu-latest
+    environment:
+      name: PR-${{ github.event.pull_request.number }}
+      url: ${{ steps.configure.outputs.URL }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Setup flutter
+        uses: subosito/flutter-action@v2
+        with:
+          flutter-version: "3.10.6"
+          channel: "stable"
+          cache: true
+          cache-key: deps-${{ hashFiles('**/pubspec.lock') }} # optional, change this to force refresh cache
+          cache-path: ${{ runner.tool_cache }}/flutter # optional, change this to specify the cache path
+
+      - name: Run prebuild
+        run: bash prebuild.sh
+
+      - name: Configure environments
+        id: configure
+        env:
+          FOLDER: ${{ github.event.pull_request.number }}
+        run: |
+          sed -i "s|SERVER_URL=.*|SERVER_URL=https://apisix.upn.integration-open-paas.org/|g" env.file
+          sed -i "s|DOMAIN_REDIRECT_URL=.*|DOMAIN_REDIRECT_URL=https://$GITHUB_REPOSITORY_OWNER.github.io/${GITHUB_REPOSITORY##*/}/$FOLDER|g" env.file
+          echo "URL=https://$GITHUB_REPOSITORY_OWNER.github.io/${GITHUB_REPOSITORY##*/}/$FOLDER" >> $GITHUB_OUTPUT
+
+      - name: Build
+        env:
+          FOLDER: ${{ github.event.pull_request.number }}
+        run: flutter build web --profile --verbose --base-href "/${GITHUB_REPOSITORY##*/}/$FOLDER/"
+
+      - name: Deploy to Github Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          destination_dir: ${{ github.event.pull_request.number }}
+          keep_files: true
+          publish_dir: "build/web"
+
+      - name: Find deployment comment
+        uses: peter-evans/find-comment@v2
+        id: fc
+        with:
+          comment-author: "github-actions[bot]"
+          issue-number: ${{ github.event.pull_request.number }}
+          body-includes: "This PR has been deployed to"
+
+      - name: Create or update deployment comment
+        uses: peter-evans/create-or-update-comment@v3
+        with:
+          comment-id: ${{ steps.fc.outputs.comment-id }}
+          issue-number: ${{ github.event.pull_request.number }}
+          body: |
+            This PR has been deployed to ${{ steps.configure.outputs.URL }}.
+          edit-mode: replace