github-workflows

Repository for shared GitHub Action workflows.

GitHub documentation.

Workflows

`platformio-build.yaml`

Build PlatformIO project and optionally upload firmware artefacts.

jobs:
  call-platformio-build:
    uses: ravngr/github-workflows/.github/workflows/platformio-build.yaml@main
    with:
      pio-environment: <env-name>
      upload-firmware: false

`pre-commit.yaml`

Runs pre-commit against repository files.

jobs:
  call-pre-commit:
    uses: ravngr/github-workflows/.github/workflows/pre-commit.yaml@main

`submodule-update.yaml`

Checks out repoisitory and updated submodules. When changes are found a PR is opened using peter-evans/create-pull-request. Requires additional permissions to create PR.

permissions:
  pull-requests: write
  contents: write

jobs:
  call-submodule-update:
    uses: ravngr/github-workflows/.github/workflows/submodule-update.yaml@main
    with:
      pr-branch: <branch>
      pr-title: <title>

`yamllint.yaml`

Runs yamllint against repository files.

jobs:
  call-yamllint:
    uses: ravngr/github-workflows/.github/workflows/yamllint.yaml@main