README.md

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.

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

Usage

A reusable workflow is called by using the uses keyword in another workflow:

name: CI

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

jobs:
  call-reuseable-workflow:
    uses: fastify/workflows/.github/workflows/plugins-ci.yml@v3

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:
    uses: fastify/workflows/.github/workflows/plugins-ci.yml@v3
    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.
fail-fast	false	boolean	true	Set to false to disable the fail-fast strategy.
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.

Acknowledgements

Past sponsors:

• Yeovil District Hospital NHS Foundation Trust

License

Licensed under MIT.