GitHub Actions

Catppuccin Whiskers can be installed in GitHub Actions to generate and/or check templates match the generated files.

Setup Whiskers

The catppuccin/setup-whiskers action installs whiskers into the GitHub Actions $PATH.

For code snippets to copy/paste into your workflows, see Usage and Examples.

Whiskers Check

Many repositories using Whiskers store the generated file(s) in source control, allowing the --check command to verify that the generated file(s) match the template(s) at all times.

Reusable Workflow (recommended)

A reusable organisation workflow is stored in the catppuccin/actions repository.

Catppuccin ports generated with Whiskers should use the reusable workflow, as shown below:

name: whiskers

on:
  workflow_dispatch:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  run:
    uses: catppuccin/actions/.github/workflows/whiskers-check.yml@v1
    with:
      args: <template_file>
    secrets: inherit

For some “real world” examples, search GitHub with the query “org:catppuccin path:*.yml catppuccin/actions/.github/workflows/whiskers-check.yml”.

Manual Workflow

If the reusable workflow cannot be used, you can use the following template below:

name: whiskers

on:
  workflow_dispatch:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v5

      - name: Setup Whiskers
        uses: catppuccin/setup-whiskers@v2

      - name: Check
        run: |
          whiskers --check <output_file> <template_file>

For some “real world” examples, search GitHub with the query “org:catppuccin path:*.yml catppuccin/setup-whiskers”.