Workflows

Reusable workflows for use in the Fastify organization.

Intro

GitHub introduced reusable workflows on 2021-11-29 which, as the name suggests, are workflows that can be referenced across the entirety of GitHub. A reusable workflow is called by using the uses keyword in another workflow.

For more information, including limitations, see the GitHub Docs.

CI workflows

Usage

name: CI

on:
  push:
    paths-ignore:
      - 'docs/**'
      - '*.md'
  pull_request:
    paths-ignore:
      - 'docs/**'
      - '*.md'

jobs:
  ci:
    uses: fastify/workflows/.github/workflows/plugins-ci.yml@v5

Included in this repo is a basic workflow for use across the majority of plugins, as well as variants with service containers.

Enable workflow Linter job

By setting the lint option to true when using the basic workflow the CI will first run the linter job once.

Example: running the linter job first with the basic workflow

name: CI

on:
  push:
    paths-ignore:
      - 'docs/**'
      - '*.md'
  pull_request:
    paths-ignore:
      - 'docs/**'
      - '*.md'

jobs:
  test:
    permissions:
      contents: write
      pull-requests: write
    uses: fastify/workflows/.github/workflows/plugins-ci.yml@v5
    with:
      lint: true

Inputs

Input Name	Required	Type	Default	Description
auto-merge-exclude	false	string	fastify	Provide a semicolon separated list of packages that you do not want to be auto-merged.
fastify-dependency-integration	false	boolean	false	Set to true to run fastify tests with the (proposed) changes.
license-check	false	boolean	false	Set to true to check that a repository's production dependencies use permissive licenses: 0BSD, Apache-2.0, BSD-2-Clause, BSD-3-Clause, MIT, or ISC.
license-check-allowed-additional	false	string		Provide a semicolon separated list of SPDX-license identifiers that you want to additionally allow.
lint	false	boolean	false	Set to true to run the lint script in a repository's package.json.
node-versions	false	string	'["20", "22"]'	Provide A JSON array that specifies the Node.js versions on which the job should run.

Benchmark PR workflow

The benchmark workflow expects pull_request or pull_request_target events. A common use for this workflow is to run benchmarks when a benchmark label is added to the PR.

Usage

name: Benchmark PR

on:
  pull_request_target:
    types:
      - labeled

jobs:
  benchmark:
    if: ${{ github.event.label.name == 'benchmark' }}
    uses: fastify/workflows/.github/workflows/plugins-benchmark-pr.yml@v5
    with:
      npm-script: bench

  remove-label:
    if: "always()"
    needs: benchmark
    runs-on: ubuntu-latest
    steps:
      - name: Remove benchmark label
        uses: octokit/[email protected]
        id: remove-label
        with:
          route: DELETE /repos/{repo}/issues/{issue_number}/labels/{name}
          repo: ${{ github.event.pull_request.base.repo.full_name }}
          issue_number: ${{ github.event.pull_request.number }}
          name: benchmark
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Inputs

Input Name	Required	Type	Default	Description
npm-script	false	string	benchmark	Provide the name of the npm script to run
node-versions	false	string	'["20", "22"]'	Provide A JSON array that specifies the Node.js versions on which the job should run.

Acknowledgements

Past sponsors:

• Yeovil District Hospital NHS Foundation Trust

Contributing

Contributions are welcome, and any help is greatly appreciated!

See the contributing guide for details on how to get started. Please adhere to Fastify's Code of Conduct when contributing.

License

Licensed under MIT.