feat: rework monorepo with Turborepo; update example apps and CI pipelines (#171)

* chore: move RN CLI example app to dedicated folder

* feat: bootstrap CLI & add Android commands

* docs: added CLI docs

* fix: update path to root project in metro and react-native config files

* chore: upgraded pods in example app

* feat: ios support PoC using Rock utilities

* chore: bootstrap new RN app with RN CLI

* feat: integrate brownfield into demo Android RN app

* chore: bootstrap demo android app

* feat: integrate brownfield RN lib into demo native Android app

* ci: added CI for new Android app

* docs: updated links to apps in docs

* chore: bootstrap demo iOS app

* feat: added brownfield framework target to RN iOS app

* ci: added pipeline for new iOS app

* feat: better logging in verbose mode in the CLI

* feat: cleanup cli flags for CLI

* chore: re-add brownfield target to RN iOS project

* chore: use static frameworks in RN iOS app

* fix: cli for iOS

* chore: deintegrate old, obsolete example app

* docs: added README in example/ directory

* chore: static frameworks in RNApp

* feat: pod install in CLI

* feat: simplify iOS CLI logic, add xcframework merging

* feat: integrate brownfield with demo iOS app

* feat: new, nicer UI in demo Android app

* ci: build Release variants

* chore: remove obsolete tag in AndroidManifest.xml

* chore: move cli sources and configuration after merge

* chore: proper turborepo configuration

* chore: provide brownfield bin

* fix(ci): fix ci

* fix: paths in demo RNApp configuration

* fix: respect --no-install-pods CLI option

* ci: merge workflows

* ci: build iOS Release configuration

* chore: remove yarn.lock in RNApp

* chore: rename CI workflow, add badge to README.md

* chore: move tester app, reorganize CI workflow

* fix(ci): fix CLI commands in CI

* fix(ci): use first available iOS simulator

* fix(ci): right path to the CLI

* fix(ci): use any iOS target

* fix(ci): proper native app build commands

* chore: add android / ios scripts to run the RN app

* chore: rework turbo repo config

* chore: add CONTRIBUTING.md and describe demo apps in docs

* ci: use Turbo tasks instead of manual commands

* ci: cache Turbo caches on GH Actions

* fix: move build:brownfield task to turbo repo root

* fix: iOS app script name

* ci: build framework only for iphoneos to speed up

* ci: build iOS artifact for iphonesimulator to match consumer app destination

* chore: add linting of gradle plugins to the lint job

* fix: add eslint dev-dependency to react-native-brownfield

* chore: deintegrate CLI from this PR

* ci: cache tester app in CI

* chore: remove cli bin entry from yarn.lock

* chore: rename tester-integrated directory to TesterIntegrated

* chore: embed frameworks in Apple example app

* fix(ci): fix caching keys

* ci: rename caching steps

* ci: cache gradle files

* chore: enable ccache in Podfiles

* chore: separate script for linting gradle plugin sources

* ci: deintegrate iOS build caching that does not bring boost

* chore: deintegrate CLI docs

* ci: set concurrency rule to stop outdated running tasks

* fix: typo in apps/README.md

Co-authored-by: Oskar Kwaśniewski <oskarkwasniewski@icloud.com>

* chore: remove leftover CLI dependencies

* ci: pin action commit checksums, validate gradle wrapper in android CI

---------

Co-authored-by: Oskar Kwaśniewski <oskarkwasniewski@icloud.com>

Author: artus9033

.github/actions/setup/action.yml

@@ -5,11 +5,22 @@ runs:
   using: composite
   steps:
     - name: Setup Node.js
-      uses: actions/setup-node@v4
+      uses: actions/setup-node@65d868f8d4d85d7d4abb7de0875cde3fcc8798f5 # v6
       with:
         node-version: 'lts/*'
         cache: 'yarn'
 
+    - name: Restore turbo cache
+      uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5
+      with:
+        path: |
+          .turbo
+          apps/*/.turbo
+          packages/*/.turbo
+        key: ${{ runner.os }}-turbo-${{ hashFiles('.turbo', '**/.turbo') }}
+        restore-keys: |
+          ${{ runner.os }}-turbo-
+
     - name: Install dependencies
       run: yarn install
       shell: bash

.github/workflows/build.yml

@@ -6,21 +6,130 @@ on:
   pull_request:
     branches: [main]
 
+concurrency:
+  group: pr-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
 jobs:
-  lint:
+  build-lint:
+    name: Build & static code analysis
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
 
       - name: Setup
         uses: ./.github/actions/setup
 
-      - name: Build package
+      - name: Build packages
         run: yarn build
 
       - name: Lint files
         run: yarn lint
 
       - name: Typecheck files
         run: yarn typecheck
+
+  tester-android:
+    name: Integrated tester Android App
+    runs-on: ubuntu-latest
+    needs: build-lint
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
+
+      - name: Validate Gradle Wrapper
+        uses: gradle/actions/wrapper-validation@6f229686ee4375cc4a86b2514c89bac4930e82c4 # v5
+
+      - name: Setup Java
+        uses: actions/setup-java@5d7b2146334bacf88728daaa70414a99f5164e0f # v5
+        with:
+          distribution: 'zulu'
+          java-version: '17'
+
+      - name: Setup Node.js
+        uses: actions/setup-node@65d868f8d4d85d7d4abb7de0875cde3fcc8798f5 # v6
+        with:
+          node-version: 'lts/*'
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Build packages
+        run: yarn build
+
+      - name: Restore android build cache
+        uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5
+        with:
+          path: |
+            apps/TesterIntegrated/kotlin/build
+            apps/TesterIntegrated/kotlin/app/.cxx
+            apps/TesterIntegrated/kotlin/app/build
+          key: ${{ runner.os }}-tester-android-build-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-tester-android-build-
+
+      - name: Resture Gradle cache
+        uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-tester-integrated-android-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-tester-integrated-android-gradle-
+
+      - name: Build integrated Android tester app
+        run: yarn run build:tester-integrated:android
+
+  tester-ios:
+    name: Integrated tester iOS App
+    runs-on: macos-latest
+    needs: build-lint
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
+
+      - name: Use appropriate Xcode version
+        uses: maxim-lobanov/setup-xcode@60606e260d2fc5762a71e64e74b2174e8ea3c8bd # v1.6.0
+        with:
+          xcode-version: '16'
+
+      - name: Setup Node.js
+        uses: actions/setup-node@65d868f8d4d85d7d4abb7de0875cde3fcc8798f5 # v6
+        with:
+          node-version: 'lts/*'
+          cache: 'yarn'
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@5dd816ae0186f20dfa905997a64104db9a8221c7 # v1.280.0
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Build packages
+        run: yarn build
+
+      - name: Restore Pods cache
+        uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5
+        with:
+          path: |
+            apps/TesterIntegrated/swift/Pods
+          key: ${{ runner.os }}-tester-ios-pods-${{ hashFiles('apps/TesterIntegrated/swift/Podfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-tester-ios-pods-
+
+      - name: Install pods
+        run: |
+          cd apps/TesterIntegrated/swift
+          pod install
+
+      - name: Build integrated iOS tester app
+        run: |
+          yarn run build:tester-integrated:ios

.github/workflows/ci.yml

@@ -21,14 +21,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
         with:
           fetch-depth: 0 # Not needed if lastUpdated is not enabled
       - name: Setup
         uses: ./.github/actions/setup
 
       - name: Setup Pages
-        uses: actions/configure-pages@v5
+        uses: actions/configure-pages@d5606572c479bee637007364c6b4800ac4fc8573 # v5
 
       - name: Install dependencies
         working-directory: docs
@@ -40,7 +40,7 @@ jobs:
           yarn run build
 
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
+        uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4
         with:
           path: docs/doc_build
 
@@ -55,4 +55,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v4
+        uses: actions/deploy-pages@854d7aa1b99e4509c4d1b53d69b7ba4eaf39215a # v4.0.5

.github/workflows/deploy-docs.yml

@@ -2,7 +2,7 @@ name: ktlint and detekt
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ['main']
   pull_request:
     branches: [main]
 
@@ -13,19 +13,19 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
 
       - name: Validate Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v2
+        uses: gradle/actions/wrapper-validation@6f229686ee4375cc4a86b2514c89bac4930e82c4 # v5
 
       - name: Set up JDK
-        uses: actions/setup-java@v4
+        uses: actions/setup-java@5d7b2146334bacf88728daaa70414a99f5164e0f # v5
         with:
           distribution: temurin
           java-version: 17
 
-      - name: Cache Gradle
-        uses: actions/cache@v4
+      - name: Restore Gradle cache
+        uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5
         with:
           path: |
             ~/.gradle/caches

.github/workflows/gradle-plugin-lint.yml

@@ -0,0 +1,26 @@
+# Contributing to React Native Brownfield
+
+## Project setup
+
+Run `yarn` in the root of the repository to install all dependencies.
+
+Depending on your needs, you may need to install CocoaPods in a subset of the below directories:
+- example React Native iOS app: `cd apps/RNApp/ios && pod install`
+- integrated iOS tester app: `cd apps/TesterIntegrated/swift && pod install`
+
+## Scripts
+
+- `lint` - runs linting on all JS/TS source files in the monorepo *[Turbo]* 
+- `gradle-plugin:lint` - runs linting on the Brownfield Gradle plugin source code
+- `typecheck` - runs TypeScript type checking on all TS source files in the monorepo *[Turbo]* 
+- `build` - runs all `build*` tasks in the Turbo repo - see below for more details *[Turbo]* 
+- `release` - releases a new version of React Native Brownfield package using `release-it`
+- `brownfield:plugin:publish:local` - publishes the Brownfield Gradle plugin to your local Maven repository for testing purposes
+- `build:brownfield` - builds the React Native Brownfield package (`packages/react-native-brownfield`) *[Turbo]* 
+- `build:docs` - builds the documentation site (`docs/`) *[Turbo]* 
+- `build:tester-integrated:android` - builds the Android integrated tester app (`apps/TesterIntegrated/android`) *[Turbo]* 
+- `build:tester-integrated:ios` - builds the iOS integrated tester app (`apps/TesterIntegrated/swift`) *[Turbo]* 
+- `build:example:android-rn` - builds the example React Native app for Android (`apps/RNApp/android`) *[Turbo]* 
+- `build:example:ios-rn` - builds the example React Native app for iOS (`apps/RNApp/ios`) *[Turbo]* 
+- `build:example:android-consumer` - builds the example native Android consumer app (`apps/AndroidApp`) *[Turbo]* 
+- `build:example:ios-consumer` - builds the example native Apple consumer app (`apps/AppleApp`) *[Turbo]* 

CONTRIBUTING.md

@@ -62,6 +62,7 @@ This project follows the [all-contributors](https://github.com/kentcdodds/all-co
 
 [build-badge]: https://img.shields.io/circleci/build/github/callstack/react-native-brownfield/master.svg?style=flat-square
 [build]: https://circleci.com/gh/callstack/react-native-brownfield
+[ci]: https://github.com/callstack/react-native-brownfield/actions/workflows/ci.yml/badge.svg
 [version-badge]: https://img.shields.io/npm/v/@callstack/react-native-brownfield.svg?style=flat-square
 [package]: https://www.npmjs.com/package/@callstack/react-native-brownfield
 [license-badge]: https://img.shields.io/npm/l/@callstack/react-native-brownfield.svg?style=flat-square

README.md

@@ -0,0 +1,15 @@
+*.iml
+.gradle
+/local.properties
+/.idea/caches
+/.idea/libraries
+/.idea/modules.xml
+/.idea/workspace.xml
+/.idea/navEditor.xml
+/.idea/assetWizardSettings.xml
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+.cxx
+local.properties

apps/AndroidApp/.gitignore

@@ -0,0 +1 @@
+/build