Merge pull request #303 from bitmovin/release/v0.13.0

Release 0.13.0
bitmovin · Oct 20, 2023 · c0160df · c0160df
2 parents 4c835b7 + 51881ee
commit c0160df
Show file tree

Hide file tree

Showing 98 changed files with 2,859 additions and 1,065 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_template.yaml b/.github/ISSUE_TEMPLATE/bug_template.yaml
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,5 +1,8 @@
 blank_issues_enabled: false
 contact_links:
+  - name: Report a Bug
+    url: https://dashboard.bitmovin.com/support/tickets
+    about: Report a Bug you encountered in our Player React Native SDK in your Bitmovin Customer Dashboard.
   - name: Feature Requests
     url: https://community.bitmovin.com/t/how-to-submit-a-feature-request-to-us/1463
     about: Learn how to suggest new features for our Player SDKs.

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,6 +15,65 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  code-style-typescript:
+    name: Code style Typescript
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup node and npm registry
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+          registry-url: 'https://registry.npmjs.org/'
+          cache: 'yarn'
+
+      - name: Install node_modules
+        run: yarn install --frozen-lockfile
+
+      - name: Lint Typescript
+        run: yarn lint
+
+  code-style-android:
+    name: Code style Android
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'zulu'
+          java-version: '11'
+
+      - name: Set up Gradle cache
+        uses: gradle/gradle-build-action@v2
+        with:
+          cache-read-only: ${{ github.ref != 'refs/heads/development' }}
+
+      - name: Check code style
+        run: ./gradlew ktlintCheck
+        working-directory: android
+
+  code-style-ios:
+    name: Code style iOS
+    runs-on: macOS-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: '14.1'
+
+      - name: Install dependencies
+        run: brew bundle install
+
+      - name: Check code style
+        run: swiftlint --strict
+
   test-build-typescript:
     name: Build Typescript
     runs-on: ubuntu-latest
@@ -38,6 +97,29 @@ jobs:
       - name: Compile TypeScript
         run: yarn typescript
 
+  test-build-docs:
+    name: Build API docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup node and npm registry
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+          registry-url: 'https://registry.npmjs.org/'
+          cache: 'yarn'
+
+      - name: Install node_modules
+        run: yarn install --frozen-lockfile
+
+      - name: Install node_modules (example/)
+        run: yarn install --frozen-lockfile --cwd example
+
+      - name: Build docs
+        run: yarn docs
+
   test-build-android:
     name: Build Android
     runs-on: ubuntu-latest
@@ -97,6 +179,9 @@ jobs:
       - name: Install node_modules (example/)
         run: yarn install --frozen-lockfile --cwd example
 
+      - name: Install dependencies
+        run: brew bundle install
+
       - name: Restore Pods cache
         id: pods-cache-restore
         uses: actions/cache/restore@v3
@@ -156,6 +241,9 @@ jobs:
       - name: Install node_modules (example/)
         run: yarn install --frozen-lockfile --cwd example
 
+      - name: Install dependencies
+        run: brew bundle install
+
       - name: Restore Pods cache
         id: pods-cache-restore
         uses: actions/cache/restore@v3

diff --git a/.github/workflows/finish-release-train.yml b/.github/workflows/finish-release-train.yml
@@ -5,12 +5,15 @@ on:
       - closed
     branches:
       - main
+
 env:
   LC_ALL: en_US.UTF-8
   LANG: en_US.UTF-8
+
 concurrency:
   group: finish-release-train-${{ github.ref_name }}
   cancel-in-progress: true
+
 jobs:
   create_pr:
     if: github.event.pull_request.merged == true && startsWith(github.head_ref, 'release/v')
@@ -88,3 +91,13 @@ jobs:
           tag: v${{ needs.create_pr.outputs.version_number }}
           token: ${{ secrets.GITHUB_TOKEN }}
           body: ${{ steps.changelog.outputs.release_notes }}
+
+  publish_documentation:
+    needs: [publish_release]
+    name: Generate API Documentation
+    uses: ./.github/workflows/generate-documentation.yml
+    secrets:
+      GH_TOKEN: ${{ secrets.GH_TOKEN }}
+      GCS_ACCOUNT: ${{ secrets.GCS_ACCOUNT }}
+      CF_TOKEN: ${{ secrets.CF_TOKEN }}
+      CF_ZONEID: ${{ secrets.CF_ZONEID }}
diff --git a/.github/workflows/generate-documentation.yml b/.github/workflows/generate-documentation.yml
@@ -0,0 +1,65 @@
+name: Generate documentation
+on:
+  workflow_call:
+    secrets:
+      GH_TOKEN:
+        description: GitHub token to access player-ci repo for CI scripts
+        required: true
+      GCS_ACCOUNT:
+        description: Google Cloud Storage account for uploading API docs
+        required: true
+      CF_TOKEN:
+        description: CloudFlare token for API docs cache purging
+        required: true
+      CF_ZONEID:
+        description: CloudFlare zone ID for API docs cache purging
+        required: true
+
+  workflow_dispatch:
+
+env:
+  LC_ALL: en_US.UTF-8
+  LANG: en_US.UTF-8
+
+jobs:
+  generate-documentation:
+    env:
+      GH_TOKEN: ${{ secrets.GH_TOKEN }}
+      GC_SACCOUNT: ${{ secrets.GCS_ACCOUNT }}
+      CF_TOKEN: ${{ secrets.CF_TOKEN }}
+      CF_ZONEID: ${{ secrets.CF_ZONEID }}
+
+    name: Generate documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup node and npm registry
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+          registry-url: 'https://registry.npmjs.org/'
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Install dependencies (example/)
+        run: yarn example install --frozen-lockfile
+
+      - name: Detect version using jq
+        run: |
+          echo "PCI_BRANCH=$(jq -r '.version' package.json)" >> $GITHUB_ENV
+
+      - name: Generate documentation
+        run: yarn docs
+
+      - name: Install CI scripts
+        run: |
+          curl -sS -H "Authorization: token ${GH_TOKEN}" -L https://raw.githubusercontent.com/bitmovin-engineering/player-ci/master/install.sh | bash
+
+      - name: Upload to CDN
+        run: node ./ci_scripts/src/uploadToGcs.js reactnative ../../docs/generated
+
+      - name: Purge CDN cache
+        run: node ./ci_scripts/src/purgeCloudflarePath.js 'reactnative'
diff --git a/.gitignore b/.gitignore
@@ -64,3 +64,6 @@ android/keystores/debug.keystore
 
 # generated by bob
 lib/
+
+# generated API documentation
+docs/generated
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1,12 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
+if [[ "$(uname -m)" == arm64 ]]; then
+    export PATH="/opt/homebrew/bin:$PATH"
+fi
+
 yarn lint-staged
+
+if [ "$(uname)" == "Darwin" ]; then
+    swiftlint lint --strict
+fi