Skip to content
Latchkey

Automation workflow (googleworkspace/apps-script-samples)

The Automation workflow from googleworkspace/apps-script-samples, explained and optimized by Latchkey.

C

CI health: C - fair

Point runs-on at Latchkey and get run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →
Source: googleworkspace/apps-script-samples.github/workflows/automation.ymlLicense Apache-2.0View source

What it does

This is the Automation workflow from the googleworkspace/apps-script-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

workflow (.yml)
# Copyright 2022 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: Automation
on: [ push, pull_request, workflow_dispatch ]
jobs:
  dependabot:
    runs-on: ubuntu-latest
    if: ${{ github.actor == 'dependabot[bot]' &&  github.event_name == 'pull_request' }}
    env:
      PR_URL: ${{github.event.pull_request.html_url}}
      GITHUB_TOKEN: ${{secrets.GOOGLEWORKSPACE_BOT_TOKEN}}
    steps:
      - name: approve
        run: gh pr review --approve "$PR_URL"
      - name: merge
        run: gh pr merge --auto --squash --delete-branch "$PR_URL"
  default-branch-migration:
    # this job helps with migrating the default branch to main
    # it pushes main to master if master exists and main is the default branch
    # it pushes master to main if master is the default branch
    runs-on: ubuntu-latest
    if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master' }}
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0
          # required otherwise GitHub blocks infinite loops in pushes originating in an action
          token: ${{ secrets.GOOGLEWORKSPACE_BOT_TOKEN }}
      - name: Set env
        run: |
          # set DEFAULT BRANCH
          echo "DEFAULT_BRANCH=$(gh repo view --json defaultBranchRef --jq '.defaultBranchRef.name')" >> "$GITHUB_ENV";

          # set HAS_MASTER_BRANCH
          if [ -n "$(git ls-remote --heads origin master)" ]; then
            echo "HAS_MASTER_BRANCH=true" >> "$GITHUB_ENV"
          else
            echo "HAS_MASTER_BRANCH=false" >> "$GITHUB_ENV"
          fi
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      - name: configure git
        run: |
          git config --global user.name 'googleworkspace-bot'
          git config --global user.email 'googleworkspace-bot@google.com'
      - if: ${{ env.DEFAULT_BRANCH == 'main' && env.HAS_MASTER_BRANCH == 'true' }}
        name: Update master branch from main
        run: |
          git checkout -B master
          git reset --hard origin/main
          git push origin master
      - if: ${{ env.DEFAULT_BRANCH == 'master'}}
        name: Update main branch from master
        run: |
          git checkout -B main
          git reset --hard origin/master
          git push origin main

The same workflow, on Latchkey

Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.

# Copyright 2022 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: Automation
on: [ push, pull_request, workflow_dispatch ]
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  dependabot:
    timeout-minutes: 30
    runs-on: latchkey-small
    if: ${{ github.actor == 'dependabot[bot]' &&  github.event_name == 'pull_request' }}
    env:
      PR_URL: ${{github.event.pull_request.html_url}}
      GITHUB_TOKEN: ${{secrets.GOOGLEWORKSPACE_BOT_TOKEN}}
    steps:
      - name: approve
        run: gh pr review --approve "$PR_URL"
      - name: merge
        run: gh pr merge --auto --squash --delete-branch "$PR_URL"
  default-branch-migration:
    timeout-minutes: 30
    # this job helps with migrating the default branch to main
    # it pushes main to master if master exists and main is the default branch
    # it pushes master to main if master is the default branch
    runs-on: latchkey-small
    if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master' }}
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0
          # required otherwise GitHub blocks infinite loops in pushes originating in an action
          token: ${{ secrets.GOOGLEWORKSPACE_BOT_TOKEN }}
      - name: Set env
        run: |
          # set DEFAULT BRANCH
          echo "DEFAULT_BRANCH=$(gh repo view --json defaultBranchRef --jq '.defaultBranchRef.name')" >> "$GITHUB_ENV";
 
          # set HAS_MASTER_BRANCH
          if [ -n "$(git ls-remote --heads origin master)" ]; then
            echo "HAS_MASTER_BRANCH=true" >> "$GITHUB_ENV"
          else
            echo "HAS_MASTER_BRANCH=false" >> "$GITHUB_ENV"
          fi
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      - name: configure git
        run: |
          git config --global user.name 'googleworkspace-bot'
          git config --global user.email 'googleworkspace-bot@google.com'
      - if: ${{ env.DEFAULT_BRANCH == 'main' && env.HAS_MASTER_BRANCH == 'true' }}
        name: Update master branch from main
        run: |
          git checkout -B master
          git reset --hard origin/main
          git push origin master
      - if: ${{ env.DEFAULT_BRANCH == 'master'}}
        name: Update main branch from master
        run: |
          git checkout -B main
          git reset --hard origin/master
          git push origin main
 

What changed

This workflow runs 2 jobs per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow