GHA: Move lint and docs to external wf definition

mjameswh · mjameswh · commit 58617b97ab68 · 2024-11-28T17:29:56.000-05:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -9,10 +9,13 @@ on:
 
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-  IS_OFFICIAL_REPO: ${{ github.repository == 'temporalio/sdk-typescript' }}
   # Is it the official main branch, or an official release branches?
+  #
+  # Variable IS_TEMPORALIO_SDK_TYPESCRIPT_REPO is configured to true on the official repo.
+  # It can be used to determine if the present execution has access to secrets or not.
+  #
   # AFAIK there's no way to break that line w/o introducing a trailing LF that breaks usage. Sorry.
-  IS_MAIN_OR_RELEASE: ${{ github.repository == 'temporalio/sdk-typescript' && ( github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/heads/releases')) && github.event_name != 'pull_request' }}
+  IS_MAIN_OR_RELEASE: ${{ vars.IS_TEMPORALIO_SDK_TYPESCRIPT_REPO == 'true' && github.event_name != 'pull_request' && ( github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/heads/releases')) }}
 
   # Use these variables to force specific version of CLI/Time Skipping Server for SDK tests
   # TESTS_CLI_VERSION: 'v0.13.2'
@@ -448,123 +451,12 @@ jobs:
       test-timeout-minutes: 20
       reuse-v8-context: true
 
-  # Run TS linting and ts-prune to find unused code
-  lint-and-prune:
-    name: Lint and Prune
-    strategy:
-      # Using a matrix here ensure that Rust-related actions below can be easily be copied from the
-      # compile-binairies job and that the Rust build cache will be usable
-      matrix:
-        include:
-          - platform: linux-x64
-            runner: ubuntu-latest-4-cores
-            target: x86_64-unknown-linux-gnu
-    runs-on: ${{ matrix.runner }}
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          submodules: recursive
-
-      - name: Install Node
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-
-      - name: Get NPM cache directory
-        id: npm-cache-dir
-        shell: bash
-        run: echo "dir=$(npm config get cache)" >> ${GITHUB_OUTPUT}
-
-      - name: Restore NPM cache
-        uses: actions/cache/restore@v4
-        with:
-          path: ${{ steps.npm-cache-dir.outputs.dir }}
-          key: npm-main-${{ matrix.platform }}-${{ hashFiles('./package-lock.json') }}
-          restore-keys: |
-            npm-main-${{ matrix.platform }}-
-
-      - name: Install Rust
-        uses: dtolnay/rust-toolchain@stable
-        with:
-          target: ${{ matrix.target }}
-
-      - name: Install protoc
-        uses: arduino/setup-protoc@v3
-        with:
-          # TODO: Upgrade proto once https://github.com/arduino/setup-protoc/issues/99 is fixed
-          version: '23.x'
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Rust Cargo and Build cache
-        uses: Swatinem/rust-cache@v2
-        with:
-          workspaces: packages/core-bridge -> target
-          prefix-key: corebridge-buildcache
-          shared-key: ${{ matrix.platform }}
-          env-vars: ''
-          save-if: false
-
-      - name: Download dependencies
-        run: |
-          npm ci --ignore-scripts --verbose || npm ci --ignore-scripts --verbose || npm ci --ignore-scripts --verbose
-
-      # eslint-import-resolver-typescript requires packages to be built
-      - name: Compile all non-rust code
-        run: npm run build -- --ignore @temporalio/core-bridge
-
-      - run: npm run lint.check
-      - run: npm run lint.prune
-
-  build-docs:
+  docs:
     name: Build Docs
-    strategy:
-      # Using a matrix here ensure that Rust-related actions below can be easily be copied from the
-      # compile-binairies job and that the Rust build cache will be usable
-      matrix:
-        include:
-          - platform: linux-x64
-            runner: ubuntu-latest-4-cores
-            target: x86_64-unknown-linux-gnu
-    runs-on: ${{ matrix.runner }}
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          submodules: recursive
-
-      - name: Install Node
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-
-      - name: Get NPM cache directory
-        id: npm-cache-dir
-        shell: bash
-        run: echo "dir=$(npm config get cache)" >> ${GITHUB_OUTPUT}
-
-      - name: Restore NPM cache
-        uses: actions/cache/restore@v4
-        with:
-          path: ${{ steps.npm-cache-dir.outputs.dir }}
-          key: npm-main-${{ matrix.platform }}-${{ hashFiles('./package-lock.json') }}
-          restore-keys: |
-            npm-main-${{ matrix.platform }}-
-
-      # Don't build during install phase since we're going to explicitly build
-      - name: Download dependencies
-        # Make up to 3 attempts to install NPM dependencies, to work around transient NPM errors
-        run: |
-          npm ci --ignore-scripts --verbose || npm ci --ignore-scripts --verbose || npm ci --ignore-scripts --verbose
-
-      - run: npm run build -- --ignore @temporalio/core-bridge
-
-      - name: Build docs
-        run: npm run docs
-        env:
-          ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
-
-      - name: Deploy draft docs
-        # Can't run on forks, since secrets won't be available, and command will fail
-        if: ${{ env.IS_OFFICIAL_REPO == 'true'}}
-        run: npx vercel deploy packages/docs/build -t ${{ secrets.VERCEL_TOKEN }} --name typescript --scope temporal --yes
+    uses: ./.github/workflows/docs.yml
+    with:
+      # Can't publish from forks, as secrets won't be available
+      publish_target: ${{ vars.IS_TEMPORALIO_SDK_TYPESCRIPT_REPO == 'true' && 'draft' || '' }}
+    secrets:
+      ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
+      VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
diff --git a/.github/workflows/conventions.yml b/.github/workflows/conventions.yml
@@ -0,0 +1,70 @@
+name: Conventions
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - releases/*
+
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+jobs:
+  lint-and-prune:
+    name: Lint and Prune
+    runs-on: ubuntu-latest-4-cores
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Get NPM cache directory
+        id: npm-cache-dir
+        shell: bash
+        run: echo "dir=$(npm config get cache)" >> ${GITHUB_OUTPUT}
+
+      - name: Restore NPM cache
+        uses: actions/cache/restore@v4
+        with:
+          path: ${{ steps.npm-cache-dir.outputs.dir }}
+          key: npm-main-linux-x64-${{ hashFiles('./package-lock.json') }}
+          restore-keys: |
+            npm-main-linux-x64-
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          target: x86_64-unknown-linux-gnu
+
+      - name: Install protoc
+        uses: arduino/setup-protoc@v3
+        with:
+          version: '23.x'
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Rust Cargo and Build cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: packages/core-bridge -> target
+          prefix-key: corebridge-buildcache
+          shared-key: linux-x64
+          env-vars: ''
+          save-if: false
+
+      - name: Download dependencies
+        run: |
+          npm ci --ignore-scripts --verbose || npm ci --ignore-scripts --verbose || npm ci --ignore-scripts --verbose
+
+      # eslint-import-resolver-typescript requires packages to be built
+      - name: Compile all non-rust code
+        run: npm run build -- --ignore @temporalio/core-bridge
+
+      - run: npm run lint.check
+      - run: npm run lint.prune
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,71 @@
+name: Docs
+
+on:
+  workflow_call:
+    inputs:
+      publish_target:
+        required: true
+        type: string
+        description: |
+          Whether to publish the docs. Set to either 'prod' or 'draft', or leave unset to skip publishing.
+    secrets:
+      ALGOLIA_API_KEY:
+        required: false
+        description: The Algolia API key. Required if 'publish_target' is set.
+      VERCEL_TOKEN:
+        required: false
+        description: The Vercel token. Required if 'publish_target' is set.
+
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+jobs:
+  build-docs:
+    name: Build Docs
+    runs-on: ubuntu-latest-4-cores
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Get NPM cache directory
+        id: npm-cache-dir
+        shell: bash
+        run: echo "dir=$(npm config get cache)" >> ${GITHUB_OUTPUT}
+
+      - name: Restore NPM cache
+        uses: actions/cache/restore@v4
+        with:
+          path: ${{ steps.npm-cache-dir.outputs.dir }}
+          key: npm-main-linux-x64-${{ hashFiles('./package-lock.json') }}
+          restore-keys: |
+            npm-main-linux-x64-
+
+      - name: Download dependencies
+        # Make up to 3 attempts to install NPM dependencies, to work around transient NPM errors
+        # Don't build during install phase since we're going to explicitly build anyway
+        run: |
+          npm ci --ignore-scripts --verbose || npm ci --ignore-scripts --verbose || npm ci --ignore-scripts --verbose
+
+      - run: npm run build -- --ignore @temporalio/core-bridge
+
+      - name: Build docs
+        run: npm run docs
+        env:
+          ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
+
+      - name: Publish docs
+        if: ${{ inputs.publish_target }}
+        run: |
+          npx vercel deploy packages/docs/build \
+            -t '${{ secrets.VERCEL_TOKEN }}' \
+            --name typescript \
+            --scope temporal \
+            --yes \
+            ${{ inputs.publish_target == 'prod' && '--prod' || '' }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -9,10 +9,9 @@ on:
 
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-  IS_OFFICIAL_REPO: ${{ github.repository == 'temporalio/sdk-typescript' }}
   # Is it the official main branch, or an official release branches?
   # AFAIK there's no way to break that line w/o introducing a trailing LF that breaks usage. Sorry.
-  IS_MAIN_OR_RELEASE: ${{ github.repository == 'temporalio/sdk-typescript' && ( github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/heads/releases')) && github.event_name != 'pull_request' }}
+  IS_MAIN_OR_RELEASE: ${{ vars.IS_TEMPORALIO_SDK_TYPESCRIPT_REPO == 'true' && github.event_name != 'pull_request' && ( github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/heads/releases')) }}
 
   # Use these variables to force specific version of CLI/Time Skipping Server for SDK tests
   # TESTS_CLI_VERSION: 'v0.13.2'
@@ -337,60 +336,12 @@ jobs:
         run: rm -rf ${{ runner.temp }}/certs
         continue-on-error: true
 
-  build-docs:
+  docs:
     name: Build Docs
-    strategy:
-      # Using a matrix here ensure that Rust-related actions below can be easily be copied from the
-      # compile-binairies job and that the Rust build cache will be usable
-      matrix:
-        include:
-          - platform: linux-x64
-            runner: ubuntu-latest-4-cores
-    runs-on: ${{ matrix.runner }}
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          submodules: recursive
-
-      - name: Install Node
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-
-      - name: Get NPM cache directory
-        id: npm-cache-dir
-        shell: bash
-        run: echo "dir=$(npm config get cache)" >> ${GITHUB_OUTPUT}
-
-      - name: Restore NPM cache
-        uses: actions/cache/restore@v4
-        with:
-          path: ${{ steps.npm-cache-dir.outputs.dir }}
-          key: npm-main-${{ matrix.platform }}-${{ hashFiles('./package-lock.json') }}
-          restore-keys: |
-            npm-main-${{ matrix.platform }}-
-
-      # Don't build during install phase since we're going to explicitly build
-      - name: Download dependencies
-        # Make up to 3 attempts to install NPM dependencies, to work around transient NPM errors
-        run: |
-          npm ci --ignore-scripts --verbose || npm ci --ignore-scripts --verbose || npm ci --ignore-scripts --verbose
-
-      - run: npm run build -- --ignore @temporalio/core-bridge
-
-      # Do docs stuff (only on one host)
-      - name: Build docs
-        run: npm run docs
-        env:
-          ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
-
-      - name: Deploy draft docs
-        # Can't run on forks, since secrets won't be available, and command will fail
-        if: ${{ env.IS_OFFICIAL_REPO == 'true'}}
-        run: npx vercel deploy packages/docs/build -t ${{ secrets.VERCEL_TOKEN }} --name typescript --scope temporal --yes
-
-      # FIXME: Only run this on release
-      - name: Deploy prod docs # TODO: only deploy prod docs when we publish a new version
-        if: ${{ env.IS_MAIN_OR_RELEASE == 'true' }}
-        run: npx vercel deploy packages/docs/build -t ${{ secrets.VERCEL_TOKEN }} --name typescript --scope temporal --prod --yes
+    uses: ./.github/workflows/docs.yml
+    with:
+      # Can't publish from forks, as secrets won't be available
+      publish_target: prod
+    secrets:
+      ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
+      VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
