ai-platform-snippets workflow (GoogleCloudPlatform/nodejs-docs-samples)
The ai-platform-snippets workflow from GoogleCloudPlatform/nodejs-docs-samples, explained and optimized by Latchkey.
CI health: C - fair
Point runs-on at Latchkey and get caching, run de-duplication, self-healing for flaky steps, and up to 58% lower cost, applied automatically.
What it does
This is the ai-platform-snippets workflow from the GoogleCloudPlatform/nodejs-docs-samples repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.
Below, Latchkey shows a faster, safer version produced by its optimization engine.
The workflow
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
name: ai-platform-snippets
on:
push:
branches:
- main
paths:
- 'ai-platform/snippets/**'
- '.github/workflows/ai-platform-snippets.yaml'
pull_request:
types:
- opened
- reopened
- synchronize
- labeled
paths:
- 'ai-platform/snippets/**'
- '.github/workflows/ai-platform-snippets.yaml'
schedule:
- cron: '0 0 * * 0'
jobs:
test:
if: github.event.action != 'labeled' || github.event.label.name == 'actions:force-run'
runs-on: ubuntu-latest
timeout-minutes: 120
permissions:
contents: 'read'
id-token: 'write'
steps:
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
ref: ${{github.event.pull_request.head.sha}}
- uses: 'google-github-actions/auth@7c6bc770dae815cd3e89ee6cdf493a5fab2cc093' # v3.0.0
with:
workload_identity_provider: 'projects/1046198160504/locations/global/workloadIdentityPools/github-actions-pool/providers/github-actions-provider'
service_account: 'kokoro-system-test@long-door-651.iam.gserviceaccount.com'
create_credentials_file: 'true'
access_token_lifetime: 600s
- id: secrets
uses: 'google-github-actions/get-secretmanager-secrets@e5bb06c2ca53b244f978d33348d18317a7f263ce' # v2
with:
secrets: |-
caip_id:nodejs-docs-samples-tests/nodejs-docs-samples-ai-platform-caip-project-id
location:nodejs-docs-samples-tests/nodejs-docs-samples-ai-platform-location
- name: Set environment variables
run: |
echo "CAIP_PROJECT_ID=${{ steps.secrets.outputs.caip_id }}" >> $GITHUB_ENV
echo "LOCATION=${{ steps.secrets.outputs.location }}" >> $GITHUB_ENV
- uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
with:
node-version: 16
- name: Get npm cache directory
id: npm-cache-dir
shell: bash
run: echo "dir=$(npm config get cache)" >> ${GITHUB_OUTPUT}
- uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4
id: npm-cache
with:
path: ${{ steps.npm-cache-dir.outputs.dir }}
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: "${{ runner.os }}-node- \n"
- name: set env vars for scheduled run
if: github.event.action == 'schedule'
run: |
echo "MOCHA_REPORTER_SUITENAME=ai-platform-snippets" >> $GITHUB_ENV
echo "MOCHA_REPORTER_OUTPUT=${{github.run_id}}_sponge_log.xml" >> $GITHUB_ENV
echo "MOCHA_REPORTER=xunit" >> $GITHUB_ENV
- name: Run Tests
run: make test dir=ai-platform/snippets
env:
GOOGLE_SAMPLES_PROJECT: "long-door-651"The same workflow, on Latchkey
Estimated ~20% faster on cache hits, plus fewer wasted runs and a safer supply chain. Added and changed lines are highlighted.
# Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. name: ai-platform-snippets on: push: branches: - main paths: - 'ai-platform/snippets/**' - '.github/workflows/ai-platform-snippets.yaml' pull_request: types: - opened - reopened - synchronize - labeled paths: - 'ai-platform/snippets/**' - '.github/workflows/ai-platform-snippets.yaml' schedule: - cron: '0 0 * * 0' concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: test: if: github.event.action != 'labeled' || github.event.label.name == 'actions:force-run' runs-on: latchkey-small timeout-minutes: 120 permissions: contents: 'read' id-token: 'write' steps: - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 with: ref: ${{github.event.pull_request.head.sha}} - uses: 'google-github-actions/auth@7c6bc770dae815cd3e89ee6cdf493a5fab2cc093' # v3.0.0 with: workload_identity_provider: 'projects/1046198160504/locations/global/workloadIdentityPools/github-actions-pool/providers/github-actions-provider' service_account: 'kokoro-system-test@long-door-651.iam.gserviceaccount.com' create_credentials_file: 'true' access_token_lifetime: 600s - id: secrets uses: 'google-github-actions/get-secretmanager-secrets@e5bb06c2ca53b244f978d33348d18317a7f263ce' # v2 with: secrets: |- caip_id:nodejs-docs-samples-tests/nodejs-docs-samples-ai-platform-caip-project-id location:nodejs-docs-samples-tests/nodejs-docs-samples-ai-platform-location - name: Set environment variables run: | echo "CAIP_PROJECT_ID=${{ steps.secrets.outputs.caip_id }}" >> $GITHUB_ENV echo "LOCATION=${{ steps.secrets.outputs.location }}" >> $GITHUB_ENV - uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0 with: cache: 'npm' node-version: 16 - name: Get npm cache directory id: npm-cache-dir shell: bash run: echo "dir=$(npm config get cache)" >> ${GITHUB_OUTPUT} - uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4 id: npm-cache with: path: ${{ steps.npm-cache-dir.outputs.dir }} key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} restore-keys: "${{ runner.os }}-node- \n" - name: set env vars for scheduled run if: github.event.action == 'schedule' run: | echo "MOCHA_REPORTER_SUITENAME=ai-platform-snippets" >> $GITHUB_ENV echo "MOCHA_REPORTER_OUTPUT=${{github.run_id}}_sponge_log.xml" >> $GITHUB_ENV echo "MOCHA_REPORTER=xunit" >> $GITHUB_ENV - name: Run Tests run: make test dir=ai-platform/snippets env: GOOGLE_SAMPLES_PROJECT: "long-door-651"
What changed
- Run on Latchkey managed runners with one line (
runs-on), which apply the fixes below automatically and self-heal transient failures. This example useslatchkey-small; pick the runner size that fits the job. - Cancel superseded runs when a branch or PR gets a newer push.
- Cache dependency installs on the setup step so they are served from cache.
This workflow runs 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.