feat: initial commit

Author: Robert27

.github/CODEOWNERS

@@ -0,0 +1 @@
+*    @Robert27

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI - Biome and TypeScript
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+jobs:
+  test:
+    name: Run biome and typescript checks
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Set up Bun
+        uses: oven-sh/setup-bun@v2
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Run TypeScript checks
+        run: bun tsc --noEmit
+
+      - name: Run Biome check
+        run: bun biome ci .
+
+      - name: Run tests
+        run: bun test

.github/workflows/codeql.yml

@@ -0,0 +1,82 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+  schedule:
+    - cron: "19 20 * * 3"
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners (GitHub.com only)
+    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
+    permissions:
+      # required for all workflows
+      security-events: write
+
+      # required to fetch internal or private CodeQL packs
+      packages: read
+
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - language: javascript-typescript
+            build-mode: none
+        # CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
+        # Use `c-cpp` to analyze code written in C, C++ or both
+        # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
+        # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+        # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
+        # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
+        # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
+        # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: ${{ matrix.language }}
+          build-mode: ${{ matrix.build-mode }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+
+          # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          # queries: security-extended,security-and-quality
+
+      # If the analyze step fails for one of the languages you are analyzing with
+      # "We were unable to automatically build your code", modify the matrix above
+      # to set the build mode to "manual" for that language. Then modify this step
+      # to build your code.
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+      - if: matrix.build-mode == 'manual'
+        shell: bash
+        run: |
+          echo 'If you are using a "manual" build mode for one or more of the' \
+            'languages you are analyzing, replace this with the commands to build' \
+            'your code, for example:'
+          echo '  make bootstrap'
+          echo '  make release'
+          exit 1
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
+        with:
+          category: "/language:${{matrix.language}}"

.github/workflows/pr-title.yml

@@ -0,0 +1,23 @@
+name: "Lint PR"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+      - reopened
+
+permissions:
+  pull-requests: read
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        with:
+          subjectPattern: ^[^A-Z].*[^.]$
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,13 @@
+node_modules
+build
+logs
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+*.tsbuildinfo
+.idea
+.vscode
+.DS_Store
+

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Robert Eggl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,98 @@
+# Expo GitHub Cache
+
+A remote build cache provider plugin for Expo that uses GitHub Releases to store and retrieve cached build artifacts, dramatically accelerating your local development workflow.
+
+## What is this?
+
+This library implements Expo's [remote build cache provider interface](https://docs.expo.dev/guides/cache-builds-remotely/) using GitHub Releases as the storage backend. Build caching is an experimental Expo feature that speeds up `npx expo run:ios` and `npx expo run:android` commands by caching builds remotely based on your project's [fingerprint](https://docs.expo.dev/versions/latest/sdk/fingerprint/).
+
+### How it works with Expo's caching system
+
+When you run local development builds with `npx expo run:[android|ios]`, this plugin:
+
+1. **Checks for existing builds**: Searches GitHub Releases for a cached build matching your project's current fingerprint
+2. **Downloads if available**: If a matching build exists, downloads and launches it instead of compiling from scratch  
+3. **Uploads new builds**: If no cache exists, compiles normally and uploads the resulting binary to GitHub Releases for future use
+
+This integration with Expo's build caching system can save significant time during development, especially for large projects or when switching between branches with similar dependencies. Instead of waiting for full compilation every time, you can reuse previously built binaries when your project's fingerprint hasn't changed.
+
+## Installation
+
+```bash
+npm install @robert27/expo-github-cache
+# or
+bun add @robert27/expo-github-cache
+```
+
+## Configuration
+
+### 1. Set up GitHub Token
+
+Create a GitHub Personal Access Token with `repo` permissions and set it as an environment variable:
+
+```bash
+export GITHUB_TOKEN=your_github_token_here
+```
+
+### 2. Configure your Expo project
+
+Add the build cache provider to your `app.json` or `app.config.js`:
+
+```json
+{
+  "expo": {
+    "experiments": {
+      "buildCacheProvider": {
+        "plugin": "@robert27/expo-github-cache",
+        "options": {
+          "owner": "your-github-username",
+          "repo": "your-repo-name"
+        }
+      }
+    }
+  }
+}
+```
+
+### 3. Usage
+
+Now when you run your Expo commands, the cache will automatically be used:
+
+```bash
+npx expo run:ios
+npx expo run:android
+```
+
+## How it works
+
+The plugin uses your project's [fingerprint hash](https://docs.expo.dev/versions/latest/sdk/fingerprint/) to create unique tags in GitHub Releases. Each build artifact is stored as a release asset with a tag like:
+
+- `fingerprint.abc123def456.ios` - iOS production build
+- `fingerprint.abc123def456.dev-client.android` - Android development client build
+
+When you run a build command, the plugin:
+
+1. Calculates your project's current fingerprint
+2. Searches for a GitHub Release with the matching tag
+3. Downloads the cached build if found, or compiles and uploads if not
+
+## Requirements
+
+- Node.js 18 or higher
+- GitHub repository with release permissions
+- GitHub Personal Access Token with `repo` scope
+- Expo project with fingerprinting enabled
+
+## Environment Variables
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `GITHUB_TOKEN` | Yes | GitHub Personal Access Token with repo permissions |
+
+## Contributing
+
+This project is based on the [Expo build cache provider example](https://github.com/expo/examples/tree/master/with-github-remote-build-cache-provider) and implements the standard Expo build cache provider interface.
+
+## License
+
+MIT

__tests__/basic.test.ts

@@ -0,0 +1,61 @@
+import { describe, expect, test } from "bun:test";
+import type { ResolveRemoteBuildCacheProps } from "@expo/config";
+import buildCachePlugin from "../src/index";
+
+// Create dummy build props
+const createDummyProps = (
+	platform: "ios" | "android",
+): ResolveRemoteBuildCacheProps => ({
+	projectRoot: "/fake/project",
+	platform,
+	fingerprintHash: "1234567890abcdef",
+	runOptions: {
+		buildCache: false, // Disable cache to avoid external dependencies
+	},
+});
+
+describe("GitHub Cache Plugin Basic Tests", () => {
+	test("should return null when build cache is disabled", async () => {
+		// When buildCache is false, the function should return null immediately
+		const props = createDummyProps("ios");
+
+		const result = await buildCachePlugin.resolveRemoteBuildCache(props, {
+			owner: "owner",
+			repo: "repo",
+		});
+
+		expect(result).toBeNull();
+	});
+
+	test("should include platform in tag name for iOS", async () => {
+		const props = createDummyProps("ios");
+		const uploadProps = {
+			...props,
+			buildPath: "/fake/build/path/app.zip",
+		};
+
+		// Since GITHUB_TOKEN is missing, this should return null but still generate the tag name internally
+		const result = await buildCachePlugin.uploadRemoteBuildCache(uploadProps, {
+			owner: "owner",
+			repo: "repo",
+		});
+
+		expect(result).toBeNull();
+	});
+
+	test("should include platform in tag name for Android", async () => {
+		const props = createDummyProps("android");
+		const uploadProps = {
+			...props,
+			buildPath: "/fake/build/path/app.apk",
+		};
+
+		// Since GITHUB_TOKEN is missing, this should return null but still generate the tag name internally
+		const result = await buildCachePlugin.uploadRemoteBuildCache(uploadProps, {
+			owner: "owner",
+			repo: "repo",
+		});
+
+		expect(result).toBeNull();
+	});
+});