@fdawgs' reusable workflows

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.

This repository contains reusable workflows that are used across multiple repositories maintained by @fdawgs. These workflows are designed to be generic enough to be used in other repositories with minimal modification.

Reusable workflows are prefixed with reusable- to distinguish them from regular workflows in this repository.

name: Check Markdown for Broken Links

permissions:
    contents: read

jobs:
    link-check:
        name: Link Check
        permissions:
            contents: read
        uses: fdawgs/workflows/.github/workflows/reusable-link-check.yml@15c09545397588f9a2ac47db6c6269520ebc983a # v2.2.0

This workflow is not intended for use by external repositories as it is designed to be used in @fdawgs' Node.js projects and requires specific scripts to be defined in the package.json file. However, it can be used as a reference for creating reusable workflows for other types of projects.

name: CI

permissions:
    contents: read

jobs:
    code-quality:
        name: Code Quality
        uses: fdawgs/workflows/.github/workflows/reusable-code-quality.yml@15c09545397588f9a2ac47db6c6269520ebc983a # v2.2.0
        permissions:
            contents: read
        with:
            commitlint: true
            lint: false
    unit-tests:
        name: Unit Tests
        needs: code-quality
        runs-on: ubuntu-latest
        steps:
            - run: echo "Tests go here"

The workflow can be configured with the following inputs:

• commitlint: A boolean value indicating whether to run commit message linting (default: false)
• lint: A boolean value indicating whether to run linting (default: false)

If lint is set to true, the workflow will run linting using ESLint, Prettier, and Licensee licensing checker, and requires a package.json file with the following scripts.

When calling these reusable workflows, ensure the calling workflow/job grants at least the required permissions below. Reusable workflows cannot escalate permissions beyond what the caller allows.

Contributions are welcome, and any help is greatly appreciated!

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

workflows is licensed under the MIT license.