Reusable workflows for use in the Fastify organization.
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.
name: CI
on:
push:
branches:
- main
- next
- 'v*'
paths-ignore:
- 'docs/**'
- '*.md'
pull_request:
paths-ignore:
- 'docs/**'
- '*.md'
permissions:
contents: read
jobs:
test:
permissions:
contents: write
pull-requests: write
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 jobBy 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:
branches:
- main
- next
- 'v*'
paths-ignore:
- 'docs/**'
- '*.md'
pull_request:
paths-ignore:
- 'docs/**'
- '*.md'
permissions:
contents: read
jobs:
test:
permissions:
contents: write
pull-requests: write
uses: fastify/workflows/.github/workflows/plugins-ci.yml@v5
with:
lint: true 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", "24"]' Provide A JSON array that specifies the Node.js versions on which the job should run.
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.
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/request-action@v2.x
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 }} 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", "24"]' Provide A JSON array that specifies the Node.js versions on which the job should run.
Past sponsors:
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.
Licensed under MIT.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4