🎟️
turnstyle

A GitHub Action for serializing workflow runs

🤔 why bother

GitHub Actions is an event-oriented system. Your workflows run in response to events and are triggered independently and without coordination. In a shared repository, if two or more people merge pull requests, each will trigger workflows without regard to one another.

This can be problematic for workflows used as part of a continuous deployment process. You might want to let an in-flight deployment complete before progressing further with the next workflow. This is the usecase turnstyle action targets.

🤸 Usage

The typical setup for turnstyle involves adding job step using

softprops/[email protected]

name: Main

on: push
jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/[email protected]

- name: Turnstyle

  uses: softprops/[email protected]

  env:

  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Deploy
  run: sleep 30

Timing out

To avoid waiting prolonged periods of time, you may wish to bail on a run or continuing a workflow run regardless of the status of the previous run.

You can bail from a run using the built-in GitHub Actions

jobs..timeout-minutes

name: Main

on: push
jobs:
  main:

timeout-minutes: 5
  runs-on: ubuntu-latest
  steps:
- name: Checkout
  uses: actions/[email protected]
- name: Turnstyle
  uses: softprops/[email protected]
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Deploy
  run: sleep 30

You can also limit how long you're willing to wait before moving on with

jobs..steps.with.continue-after-seconds

name: Main



on: push
jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/[email protected]
      - name: Turnstyle
        uses: softprops/[email protected]
        with:

  continue-after-seconds: 180
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Deploy
  run: sleep 30

or before aborting the step with

jobs..steps.with.abort-after-seconds

name: Main



on: push
jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/[email protected]
      - name: Turnstyle
        uses: softprops/[email protected]
        with:

  abort-after-seconds: 180
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Deploy
  run: sleep 30

Finally, you can use the

force_continued

continue-after-seconds

if: ! steps..outputs.force_continued

name: Main



on: push
jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/[email protected]
      - name: Turnstyle
        id: turnstyle
        uses: softprops/[email protected]
        with:

  continue-after-seconds: 180
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Deploy

if: ! steps.turnstyle.outputs.force_continued
  run: sleep 30

inputs

| Name | Type | Description | |-------------------------|---------|--------------------------------------------------------------------------------------------------------------------------------| |

continue-after-seconds

abort-after-seconds

poll-interval-seconds

same-branch-only

outputs

| Name | Type | Description | |-------------------------|----------|-------------------------------------------------------------------------------------------------| |

force_continued

environment variables

The following are required as

step.env

| Name | Description | |----------------|--------------------------------------| |

GITHUB_TOKEN

secrets

cost of coordination

At this time there is no way to coordinate between workflow runs beyond waiting. For those using private repositories, you are charged based on the time your workflow spends running. Waiting within one workflow run for another to complete will incur the cost of the time spent waiting.

Doug Tangren (softprops) 2020