Pigeon and Profile configuration

.github/workflows/pull_request.yml

@@ -8,20 +8,18 @@ permissions:
   checks: write
   contents: read
 env:
-  FLUTTER_VERSION: "3.3.10"
   FLUTTER_CHANNEL: "stable"
 jobs:
   lint:
     runs-on: ubuntu-latest
     timeout-minutes: 20
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-      - name: Flutter Checkout
+        uses: actions/checkout@v4
+      - name: Flutter Setup
         uses: subosito/flutter-action@v2
         with:
           cache: true
-          flutter-version: ${{ env.FLUTTER_VERSION }}
           channel: ${{ env.FLUTTER_CHANNEL }}
       - name: Dependencies
         run: flutter pub get
@@ -32,4 +30,43 @@ jobs:
           fatal-warnings: true
           annotate: true
       - name: Check Formatting
-        run: flutter format --set-exit-if-changed --output none $(find lib test -name "*.dart" -not \( -name "*.*mocks.dart" \))
+        run: dart format --set-exit-if-changed --output none $(find lib test -name "*.dart" -not \( -name "*.freezed.dart" -o -name "*.g.dart" \))
+
+  android-build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    needs: [lint]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Flutter Setup
+        uses: subosito/flutter-action@v2
+        with:
+          cache: true
+          channel: ${{ env.FLUTTER_CHANNEL }}
+      - name: Java Setup
+        uses: actions/setup-java@v4
+        with:
+          distribution: "temurin"
+          java-version: "17"
+      - name: Dependencies
+        run: flutter pub get
+      - name: Build Android Example APK
+        run: cd example && flutter build apk --release
+
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    needs: [lint]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Flutter Setup
+        uses: subosito/flutter-action@v2
+        with:
+          cache: true
+          channel: ${{ env.FLUTTER_CHANNEL }}
+      - name: Dependencies
+        run: flutter pub get
+      - name: Run Tests
+        run: flutter test

.github/workflows/release.yml

@@ -0,0 +1,203 @@
+name: Release
+
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - '.github/workflows/**'
+      - '*.md'
+      - 'CHANGELOG.md'
+      - '.gitignore'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+env:
+  FLUTTER_CHANNEL: "stable"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Flutter Setup
+        uses: subosito/flutter-action@v2
+        with:
+          cache: true
+          channel: ${{ env.FLUTTER_CHANNEL }}
+      - name: Dependencies
+        run: flutter pub get
+      - name: Dart Analyze
+        run: dart analyze
+      - name: Check Formatting
+        run: dart format --set-exit-if-changed --output none $(find lib test -name "*.dart" -not \( -name "*.freezed.dart" -o -name "*.g.dart" \))
+
+  android-build:
+    needs: [lint]
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Flutter Setup
+        uses: subosito/flutter-action@v2
+        with:
+          cache: true
+          channel: ${{ env.FLUTTER_CHANNEL }}
+      - name: Java Setup
+        uses: actions/setup-java@v4
+        with:
+          distribution: "temurin"
+          java-version: "17"
+      - name: Dependencies
+        run: flutter pub get
+      - name: Build Android Example APK
+        run: cd example && flutter build apk --release
+
+  test:
+    needs: [lint]
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Flutter Setup
+        uses: subosito/flutter-action@v2
+        with:
+          cache: true
+          channel: ${{ env.FLUTTER_CHANNEL }}
+      - name: Dependencies
+        run: flutter pub get
+      - name: Run Tests
+        run: flutter test
+
+  release:
+    needs: [lint, android-build, test]
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Flutter Setup
+        uses: subosito/flutter-action@v2
+        with:
+          cache: true
+          channel: ${{ env.FLUTTER_CHANNEL }}
+
+      - name: Activate mtrust-api-guard
+        run: dart pub global activate mtrust_api_guard 6.0.4
+
+      - name: Install Dependencies
+        run: flutter pub get
+
+      - name: Detect API Changes
+        id: version
+        run: |
+          mtrust-api-guard --input pubspec.yaml --output .bump-result.json || true
+
+          if [ ! -f .bump-result.json ]; then
+            echo "ERROR: mtrust-api-guard did not produce output file"
+            exit 1
+          fi
+
+          echo "mtrust-api-guard output:"
+          cat .bump-result.json
+
+          jq empty .bump-result.json || { echo "ERROR: Invalid JSON output from mtrust-api-guard"; exit 1; }
+
+          CHANGE_TYPE=$(jq -r '.change_type // "none"' .bump-result.json)
+          NEW_VERSION=$(jq -r '.new_version // ""' .bump-result.json)
+          CHANGELOG=$(jq -r '.changelog // ""' .bump-result.json)
+
+          echo "change_type=$CHANGE_TYPE" >> $GITHUB_OUTPUT
+          echo "new_version=$NEW_VERSION" >> $GITHUB_OUTPUT
+          echo "changelog<<CHANGELOG_EOF" >> $GITHUB_OUTPUT
+          echo "$CHANGELOG" >> $GITHUB_OUTPUT
+          echo "CHANGELOG_EOF" >> $GITHUB_OUTPUT
+
+          echo "Version Detection: change_type=$CHANGE_TYPE new_version=$NEW_VERSION"
+
+      - name: Skip Release (No API Changes)
+        if: steps.version.outputs.change_type == 'none'
+        run: |
+          echo "No API changes detected. Skipping release."
+          exit 0
+
+      - name: Verify No Duplicate Tag
+        id: check-tag
+        if: steps.version.outputs.change_type != 'none'
+        run: |
+          VERSION="${{ steps.version.outputs.new_version }}"
+          if git rev-parse "v$VERSION" >/dev/null 2>&1; then
+            echo "Tag v$VERSION already exists. Release is idempotent (skipping)."
+            echo "tag_exists=true" >> $GITHUB_OUTPUT
+          else
+            echo "Tag v$VERSION does not exist. Proceeding with release."
+            echo "tag_exists=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Configure Git
+        if: steps.version.outputs.change_type != 'none' && steps.check-tag.outputs.tag_exists == 'false'
+        run: |
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git config user.name "github-actions[bot]"
+
+      - name: Update pubspec.yaml Version
+        if: steps.version.outputs.change_type != 'none' && steps.check-tag.outputs.tag_exists == 'false'
+        run: |
+          VERSION="${{ steps.version.outputs.new_version }}"
+          sed -i "s/^version: .*/version: $VERSION/" pubspec.yaml
+          echo "Updated pubspec.yaml to version $VERSION"
+
+      - name: Update CHANGELOG.md
+        if: steps.version.outputs.change_type != 'none' && steps.check-tag.outputs.tag_exists == 'false'
+        run: |
+          ENTRY="${{ steps.version.outputs.changelog }}"
+          awk '/<!-- Entries below/{print; print ""; print "'"$ENTRY"'"; next}1' CHANGELOG.md > CHANGELOG.tmp && mv CHANGELOG.tmp CHANGELOG.md
+          echo "Updated CHANGELOG.md with release entry"
+
+      - name: Commit Version Bump
+        if: steps.version.outputs.change_type != 'none' && steps.check-tag.outputs.tag_exists == 'false'
+        run: |
+          VERSION="${{ steps.version.outputs.new_version }}"
+          git add pubspec.yaml CHANGELOG.md
+          git commit -m "chore: release $VERSION"
+
+      - name: Create Annotated Git Tag
+        if: steps.version.outputs.change_type != 'none' && steps.check-tag.outputs.tag_exists == 'false'
+        run: |
+          VERSION="${{ steps.version.outputs.new_version }}"
+          git tag -a "v$VERSION" -m "Release v$VERSION"
+          echo "Created annotated tag v$VERSION"
+
+      - name: Push Changes and Tags
+        if: steps.version.outputs.change_type != 'none' && steps.check-tag.outputs.tag_exists == 'false'
+        run: git push origin main --tags
+
+      - name: Create GitHub Release
+        if: steps.version.outputs.change_type != 'none' && steps.check-tag.outputs.tag_exists == 'false'
+        run: |
+          VERSION="${{ steps.version.outputs.new_version }}"
+          CHANGELOG="${{ steps.version.outputs.changelog }}"
+          gh release create "v$VERSION" \
+            --title "Release $VERSION" \
+            --notes "$CHANGELOG" \
+            --target main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Release Summary
+        if: always()
+        run: |
+          echo "## Release Summary"
+          echo "- Change Type: ${{ steps.version.outputs.change_type }}"
+          echo "- New Version: ${{ steps.version.outputs.new_version }}"
+          echo "- Tag Exists: ${{ steps.check-tag.outputs.tag_exists }}"

.gitignore

@@ -11,3 +11,4 @@ Dart_packages.xml
 *.idea/
 pubspec.lock
 doc
+.planning/

.planning/PROJECT.md

@@ -0,0 +1,89 @@
+# flutter_datawedge Upgrade
+
+## What This Is
+
+A Flutter plugin for communicating with Zebra DataWedge barcode scanners via the DataWedge Intent API. This is a maintained fork consumed internally via git dependencies, now with modernized toolchains, automated CI, and semantic release automation via mtrust-api-guard.
+
+## Core Value
+
+The plugin must reliably bridge Flutter apps to Zebra DataWedge scanners with type-safe platform channels — all upgrades must preserve this functionality.
+
+## Requirements
+
+### Validated
+
+- ✓ Scan event streaming from DataWedge to Flutter via broadcast streams — existing
+- ✓ Profile creation and configuration via Intent API — existing
+- ✓ Decoder management (enable/disable individual and all decoders) — existing
+- ✓ Scanner status change event streaming — existing
+- ✓ Type-safe Dart-Kotlin communication via Pigeon-generated platform channels — existing
+- ✓ Singleton API surface via `FlutterDataWedge.instance` — existing
+- ✓ Immutable data models via Freezed code generation — existing
+- ✓ Custom exception hierarchy for error handling — existing
+- ✓ Bump all Dart/Flutter dependencies to latest stable versions — v3.1.0
+- ✓ Update Android SDK targets (compileSdk 36, Kotlin 2.3.20, Gradle 9.4.1) — v3.1.0
+- ✓ Add GitHub Actions CI pipeline with lint, android-build, and test gates — v3.1.0
+- ✓ Integrate mtrust-api-guard for automated semantic versioning — v3.1.0
+- ✓ Add a minimal passing test as placeholder for future test coverage — v3.1.0
+- ✓ Regenerate Pigeon platform channel code with updated Pigeon version — v3.1.0
+- ✓ Regenerate Freezed models with updated Freezed version — v3.1.0
+- ✓ Verify example app builds successfully with updated dependencies — v3.1.0
+
+### Active
+
+(None — next milestone requirements to be defined)
+
+### Out of Scope
+
+- Full test suite — deferred, placeholder test only for now
+- iOS support — Android-only plugin by design
+- Publishing to pub.dev — consumed via git dependencies
+- Changelog automation beyond what mtrust-api-guard provides — keep it simple
+
+## Context
+
+- Fork of [circus-kitchens/flutter_datawedge](https://github.com/circus-kitchens/flutter_datawedge), changes never upstreamed
+- Shipped v3.1.0 with Dart SDK >=3.11.0 <4.0.0, Flutter >=3.41.0
+- Pigeon 26.2.3, Freezed 3.2.5, compileSdk 36, Kotlin 2.3.20, Gradle 9.4.1
+- GitHub Actions CI: 3-job PR workflow (lint, android-build, test) + 4-job release workflow (mtrust-api-guard)
+- Placeholder test suite (1 test)
+- Consumed by internal projects via git dependency in pubspec.yaml
+
+## Constraints
+
+- **Platform**: Android-only — no iOS implementation exists or is planned
+- **Compatibility**: Must remain compatible with Zebra DataWedge Intent API
+- **Consumption**: Package installed via git URL, not pub.dev — versioning via git tags
+- **Code generation**: Pigeon and Freezed upgrades require regeneration of generated files
+
+## Key Decisions
+
+| Decision | Rationale | Outcome |
+|----------|-----------|---------|
+| Use mtrust-api-guard for versioning | Automates semver based on API change detection, fits Dart/Flutter ecosystem | ✓ Shipped v3.1.0 |
+| Bump to latest stable across the board | Maximize maintainability, avoid incremental upgrade pain later | ✓ Shipped v3.1.0 |
+| GitHub Actions for CI | Already using GitHub for hosting, natural fit | ✓ Shipped v3.1.0 |
+| Placeholder test only | No existing tests, full suite is separate effort | ✓ Shipped v3.1.0 |
+| Gradle Kotlin DSL migration | Modern build config, better IDE support, aligns with Flutter template | ✓ Shipped v3.1.0 |
+| v3.0.0 baseline tag on original fork | Phase 1 infrastructure captured in first automated release | ✓ Shipped v3.1.0 |
+| Release on push to main + manual fallback | Fully automated releases with workflow_dispatch safety net | ✓ Shipped v3.1.0 |
+
+## Evolution
+
+This document evolves at phase transitions and milestone boundaries.
+
+**After each phase transition** (via `/gsd:transition`):
+1. Requirements invalidated? → Move to Out of Scope with reason
+2. Requirements validated? → Move to Validated with phase reference
+3. New requirements emerged? → Add to Active
+4. Decisions to log? → Add to Key Decisions
+5. "What This Is" still accurate? → Update if drifted
+
+**After each milestone** (via `/gsd:complete-milestone`):
+1. Full review of all sections
+2. Core Value check — still the right priority?
+3. Audit Out of Scope — reasons still valid?
+4. Update Context with current state
+
+---
+*Last updated: 2026-03-21 after v3.1.0 milestone*