Create release workflow (decaporg/decap-cms)

The Create release workflow from decaporg/decap-cms, explained and optimized by Latchkey.

CI health: A - excellent

Point runs-on at Latchkey and get 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: decaporg/decap-cms.github/workflows/create-release.ymlLicense MITView source

What it does

This is the Create release workflow from the decaporg/decap-cms repository, a real project running GitHub Actions. It is shown here with attribution under its MIT license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

workflow (.yml)

name: Create release

on:
  create

jobs:
  create-release:
    name: Create GitHub Release
    runs-on: ubuntu-latest
    if: startsWith(github.ref, 'refs/tags/decap-cms@')

    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Get semver number
        id: get_semver
        env:
          TAG_NAME: ${{ github.ref }}
        run: echo "::set-output name=pkg::${TAG_NAME:10}"

      - name: Create release on GitHub API
        id: create_release
        uses: actions/create-release@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          tag_name: ${{ github.ref }}
          release_name: ${{ steps.get_semver.outputs.pkg }}
          body: |
            :scroll: [Changelog](https://github.com/${{ github.repository }}/blob/${{ steps.get_semver.outputs.pkg }}/CHANGELOG.md)
          draft: false
          prerelease: false

The same workflow, on Latchkey

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

name: Create release
 
on:
  create
 
jobs:
  create-release:
    timeout-minutes: 30
    name: Create GitHub Release
    runs-on: latchkey-small
    if: startsWith(github.ref, 'refs/tags/decap-cms@')
 
    steps:
      - name: Checkout
        uses: actions/checkout@v3
 
      - name: Get semver number
        id: get_semver
        env:
          TAG_NAME: ${{ github.ref }}
        run: echo "::set-output name=pkg::${TAG_NAME:10}"
 
      - name: Create release on GitHub API
        id: create_release
        uses: actions/create-release@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          tag_name: ${{ github.ref }}
          release_name: ${{ steps.get_semver.outputs.pkg }}
          body: |
            :scroll: [Changelog](https://github.com/${{ github.repository }}/blob/${{ steps.get_semver.outputs.pkg }}/CHANGELOG.md)
          draft: false
          prerelease: false

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 uses latchkey-small; pick the runner size that fits the job.
Add a job timeout so a hung step cannot burn hours of runner time.

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

Actions used in this workflow

actions/checkout