feat: development requirement file setting

NKUST-ITC · Sep 3, 2024 · af4591f · af4591f
1 parent 49da0fd
commit af4591f
Show file tree

Hide file tree

Showing 9 changed files with 70 additions and 5 deletions.
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -32,6 +32,10 @@ jobs:
         with:
           flutter-version: '3.24.x'
           channel: 'stable'
+      - name: Decrypt dev configs
+        run: sh ./scripts/decrypt_dev_configs.sh
+        env:
+          DEV_CONFIGS_PASSPHRASE: ${{ secrets.DEV_CONFIGS_PASSPHRASE }}
       - name: Install Flutter dependencies
         run: flutter pub get
       - run: flutter build appbundle --release
@@ -73,6 +77,10 @@ jobs:
         with:
           flutter-version: '3.24.x'
           channel: 'stable'
+      - name: Decrypt dev configs
+        run: sh ./scripts/decrypt_dev_configs.sh
+        env:
+          DEV_CONFIGS_PASSPHRASE: ${{ secrets.DEV_CONFIGS_PASSPHRASE }}
       - run: flutter pub get
       - run: flutter build ios --release --no-codesign
       - uses: ruby/setup-ruby@v1
@@ -132,6 +140,10 @@ jobs:
         with:
           flutter-version: '3.24.x'
           channel: 'stable'
+      - name: Decrypt dev configs
+        run: sh ./scripts/decrypt_dev_configs.sh
+        env:
+          DEV_CONFIGS_PASSPHRASE: ${{ secrets.DEV_CONFIGS_PASSPHRASE }}
       - name: Enable windows
         run: flutter config --enable-windows-desktop
       - run: flutter doctor -v

diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml
@@ -51,6 +51,10 @@ jobs:
           channel: 'stable'
           cache: true
           cache-key: 'flutter-:os:-:channel:-:version:-:arch:-:hash:'
+      - name: Decrypt dev configs
+        run: sh ./scripts/decrypt_dev_configs.sh
+        env:
+          DEV_CONFIGS_PASSPHRASE: ${{ secrets.DEV_CONFIGS_PASSPHRASE }}
       - run: flutter pub get
       - name: Build Android app bundle
         run: flutter build appbundle --release
@@ -78,6 +82,10 @@ jobs:
           channel: 'stable'
           cache: true
           cache-key: 'flutter-:os:-:channel:-:version:-:arch:-:hash:'
+      - name: Decrypt dev configs
+        run: sh ./scripts/decrypt_dev_configs.sh
+        env:
+          DEV_CONFIGS_PASSPHRASE: ${{ secrets.DEV_CONFIGS_PASSPHRASE }}
       - run: flutter pub get
       - name: Build iOS
         run: flutter build ios --release --no-codesign
@@ -128,6 +136,10 @@ jobs:
           channel: 'stable'
           cache: true
           cache-key: 'flutter-:os:-:channel:-:version:-:arch:-:hash:'
+      - name: Decrypt dev configs
+        run: sh ./scripts/decrypt_dev_configs.sh
+        env:
+          DEV_CONFIGS_PASSPHRASE: ${{ secrets.DEV_CONFIGS_PASSPHRASE }}
       - name: Intall requird Dependencies
         run: sudo apt -y install clang cmake ninja-build pkg-config libgtk-3-dev liblzma-dev
       - name: Enable linux
@@ -150,6 +162,10 @@ jobs:
           channel: 'stable'
           cache: true
           cache-key: 'flutter-:os:-:channel:-:version:-:arch:-:hash:'
+      - name: Decrypt dev configs
+        run: sh ./scripts/decrypt_dev_configs.sh
+        env:
+          DEV_CONFIGS_PASSPHRASE: ${{ secrets.DEV_CONFIGS_PASSPHRASE }}
       - name: Enable windows
         run: flutter config --enable-windows-desktop
       - run: flutter doctor -v

diff --git a/.gitignore b/.gitignore
@@ -50,6 +50,8 @@ google-services.json
 key.jks
 service_account_key.json
 android/android_keys.zip
+dev_configs.zip
+lib/firebase_options.dart
 
 .vscode/
 

diff --git a/README.md b/README.md
@@ -12,10 +12,10 @@
 
 - [X] [Android](https://play.google.com/store/apps/details?id=com.kuas.ap&hl=zh_TW)
 - [X] [iOS](https://itunes.apple.com/us/app/id1439751462)
-- [X] [Web](https://nkust-ap-flutter.web.app)
-- [X] [Windows(Beta)](https://github.com/NKUST-ITC/NKUST-AP-Flutter/releases/download/v3.8.5/nkust_ap_windows.zip)
-- [X] [MacOS](https://itunes.apple.com/us/app/id1439751462)
-- [X] [Linux(Beta)](https://snapcraft.io/nkust-ap)
+- [ ] [Web](https://nkust-ap-flutter.web.app)
+- [X] [Windows(目前無法使用因為目前 TFLite 套件不支援 桌面版)](https://github.com/NKUST-ITC/NKUST-AP-Flutter/releases/download/v3.8.5/nkust_ap_windows.zip)
+- [X] [MacOS(目前無法使用因為目前 TFLite 套件不支援 桌面版)](https://itunes.apple.com/us/app/id1439751462)
+- [X] [Linux(目前無法使用因為目前 TFLite 套件不支援 桌面版)](https://snapcraft.io/nkust-ap)
 
 ### Web 版本自7月起因為學校阻擋高請求IP，改為客戶端爬蟲，因此暫時無法使用
 
@@ -30,7 +30,22 @@
  - [NKUST API](https://github.com/NKUST-ITC/NKUST-AP-API) : 
    高科校務通後端HTTP RESTful API，代為App處理所有爬蟲問題
 
-## 步驟
+## 開發事前需求
+
+### 開發需安裝工具
+
+ - GPG 
+
+### 解密開發所需檔案
+
+`$DEV_CONFIGS_PASSPHRASE` 替換成正確的密碼
+
+```bash
+  gpg --quiet --batch --yes --decrypt --passphrase="$DEV_CONFIGS_PASSPHRASE" \
+    --output dev_configs.zip dev_configs.zip.gpg && sh scripts/unzip_dev_configs.sh
+```
+
+## 如何貢獻
 1. `Fork` 此專案到你的 GitHub 帳號.
 2. 挑選一個你想解決的 [issue](https://github.com/NKUST-ITC/NKUST-AP-Flutter/issues).
 3. 創建一個分支(Branch)以該問題命名.

diff --git a/dev_configs.zip.gpg b/dev_configs.zip.gpg
diff --git a/scripts/decrypt_dev_configs.sh b/scripts/decrypt_dev_configs.sh
@@ -0,0 +1,6 @@
+#!/bin/sh
+
+# --batch to prevent interactive command
+# --yes to assume "yes" for questions
+gpg --quiet --batch --yes --decrypt --passphrase="$DEV_CONFIGS_PASSPHRASE" \
+--output dev_configs.zip dev_configs.zip.gpg && sh scripts/unzip_dev_configs.sh
diff --git a/scripts/encrypt_dev_configs.sh b/scripts/encrypt_dev_configs.sh
@@ -0,0 +1,4 @@
+#!/bin/sh
+
+sh scripts/zip_dev_configs.sh
+gpg --symmetric --cipher-algo AES256 dev_configs.zip
diff --git a/scripts/unzip_dev_configs.sh b/scripts/unzip_dev_configs.sh
@@ -0,0 +1,3 @@
+#!/bin/sh
+
+jar xvf dev_configs.zip
diff --git a/scripts/zip_dev_configs.sh b/scripts/zip_dev_configs.sh
@@ -0,0 +1,7 @@
+#!/bin/sh
+
+zip -r dev_configs.zip \
+    lib/firebase_options.dart \
+    android/app/google-services.json \
+    ios/Runner/GoogleService-Info.plist \
+    macos/Runner/GoogleService-Info.plist