Housekeeping: ignore Android build artifacts and publish APKs via Releases

Author: seanap

.github/workflows/android-widget-release.yml

@@ -0,0 +1,89 @@
+name: Android Widget Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      release_tag:
+        description: "Release tag (e.g. android-widget-v0.2.0)"
+        required: true
+        type: string
+      release_name:
+        description: "Release title"
+        required: true
+        default: "Chronicle Android Widget"
+        type: string
+      prerelease:
+        description: "Mark release as prerelease"
+        required: true
+        default: true
+        type: boolean
+  push:
+    tags:
+      - "android-widget-v*"
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Java 17
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: "17"
+
+      - name: Set up Gradle
+        uses: gradle/actions/setup-gradle@v4
+        with:
+          gradle-version: "8.10.2"
+
+      - name: Set up Android SDK
+        uses: android-actions/setup-android@v3
+
+      - name: Install Android SDK packages
+        run: |
+          yes | sdkmanager --licenses > /dev/null
+          sdkmanager "platform-tools" "platforms;android-35" "build-tools;35.0.0"
+
+      - name: Build debug APK
+        run: gradle -p android :app:assembleDebug
+
+      - name: Resolve release metadata
+        id: meta
+        shell: bash
+        run: |
+          if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
+            echo "tag=${{ inputs.release_tag }}" >> "$GITHUB_OUTPUT"
+            echo "name=${{ inputs.release_name }}" >> "$GITHUB_OUTPUT"
+            echo "prerelease=${{ inputs.prerelease }}" >> "$GITHUB_OUTPUT"
+          else
+            echo "tag=${GITHUB_REF_NAME}" >> "$GITHUB_OUTPUT"
+            echo "name=Chronicle Android Widget ${GITHUB_REF_NAME}" >> "$GITHUB_OUTPUT"
+            echo "prerelease=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Prepare release asset
+        run: |
+          mkdir -p dist
+          cp android/app/build/outputs/apk/debug/app-debug.apk "dist/chronicle-widget-${{ steps.meta.outputs.tag }}.apk"
+
+      - name: Upload workflow artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: chronicle-widget-apk-${{ steps.meta.outputs.tag }}
+          path: dist/*.apk
+
+      - name: Publish GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.meta.outputs.tag }}
+          target_commitish: ${{ github.sha }}
+          name: ${{ steps.meta.outputs.name }}
+          prerelease: ${{ steps.meta.outputs.prerelease }}
+          files: dist/*.apk

.gitignore

@@ -16,9 +16,17 @@ local/
 
 # Local desktop artifacts
 Thumbs.db
+.DS_Store
 Chronicle.png
 View_hero_layout.png
 
 # Android companion app build artifacts
 android/.gradle/
+android/.kotlin/
+android/**/build/
 android/local.properties
+android/captures/
+*.iml
+*.jks
+*.keystore
+*.aab

README.md

@@ -68,4 +68,5 @@ http://localhost:1609
 ## Documentation
 - API docs: [`docs/API_DOCUMENTATION.md`](docs/API_DOCUMENTATION.md)
 - Android widget companion: [`docs/ANDROID_WIDGET_COMPANION.md`](docs/ANDROID_WIDGET_COMPANION.md)
+- Android widget APK downloads: [GitHub Releases](https://github.com/seanap/Chronicle/releases)
 - Misery Index report: [`docs/MISERY_INDEX_REPORT.md`](docs/MISERY_INDEX_REPORT.md)

android/app/build/outputs/apk/debug/app-debug.apk

@@ -36,3 +36,11 @@ The launcher app (`Chronicle Widget`) contains a simple base URL setting.
 ## Notes
 - WorkManager enforces a minimum interval; 61 minutes is honored.
 - If network fetch fails, widget falls back to last cached payload.
+
+## APK Distribution
+- APK binaries are distributed through **GitHub Releases**, not committed in source control.
+- Release workflow: `.github/workflows/android-widget-release.yml`.
+- Trigger options:
+  - Push a tag like `android-widget-v0.2.0`.
+  - Or run the workflow manually (`workflow_dispatch`) and provide `release_tag`.
+- Release asset output name format: `chronicle-widget-<tag>.apk`.