GitHub Action ​

The Sprocket GitHub Action runs select functionality of the sprocket command line tool in CI/CD pipelines. It is a Docker action, so no separate Sprocket installation step is required.

Set up CI ​

A typical WDL repository checks three things on every pull request:

• Analysis and lint. sprocket check reports analysis diagnostics; adding lint: true also reports lint rule violations.
• Formatting. sprocket format verifies that every document is already formatted.
• Inputs. sprocket validate checks that the inputs files committed to the repository still satisfy their task or workflow.

Add the action to a workflow under .github/workflows/:

name: CI

on:
  pull_request:
  push:
    branches: [main]

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: stjude-rust-labs/sprocket-action@main
        with:
          action: lint

  format:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: stjude-rust-labs/sprocket-action@main
        with:
          action: format

If an existing repository has more diagnostics than you can fix at once, generate a baseline with sprocket lint --generate-baseline and commit sprocket-baseline.toml. The action then only fails on diagnostics that are not in the baseline, so new problems are caught while existing ones stay recorded.

Actions ​

The default action is to sprocket check all WDL documents found in the workspace.

check and lint ​

The check and lint subcommands perform static analysis on WDL documents. The lint: true option additionally enables linting rules. The lint action is an alias for action: check with linting enabled.

Inputs ​

Example usage ​

uses: stjude-rust-labs/sprocket-action@main
with:
    action: check
    lint: true
    ignore-patterns: template,test
    except: TrailingComma,ContainerUri

The action lint can be specified and is equivalent to specifying action: check and lint: true.

uses: stjude-rust-labs/sprocket-action@main
with:
    action: lint
    ignore-patterns: template,test
    except: TrailingComma,ContainerUri

validate ​

Validates an input JSON against a task or workflow input schema.

Inputs ​

Example usage ​

uses: stjude-rust-labs/sprocket-action@main
with:
    action: validate
    wdl_files: "tools/bwa.wdl"
    inputs_files: "@inputs/bwa.json"

Multiple files can be specified as well:

uses: stjude-rust-labs/sprocket-action@main
with:
    action: validate
    wdl_files: "tools/bwa.wdl,tools/star.wdl"
    inputs_files: "@inputs/bwa.json,@inputs/star.json"

format ​

Checks that all WDL files are formatted correctly.

Inputs ​

To set your format configuration (for example, indentation), commit a sprocket.toml to your repository. See Configuration for more information.

Example usage ​

uses: stjude-rust-labs/sprocket-action@main
with:
    action: format
    ignore-patterns: template,test

Configuration ​

The Sprocket GitHub Action will load a sprocket.toml in the root of your repository, so your CI environment can use the same settings as your local development environment. The except, deny-warnings, and deny-notes action inputs correspond to the except, deny_warnings, and deny_notes keys in the [check] table, so you can set them in your TOML instead. Action-specific inputs, such as action, skip-config-search, config-path, wdl_files, inputs_files, and ignore-patterns, have no sprocket.toml equivalent and must stay in your workflow YAML. See the configuration concept page and the configuration file reference for the available keys.

Disabling implicit config loading ​

Set skip-config-search: true to enable the --skip-config-search Sprocket option, which disables the normal configuration search. Use it together with config-path to load only the specified configuration file.

Setting an explicit config path ​

Use config-path if your config TOML is not in the root of the repository, or if you want to add CI-specific configuration. The TOML found at this location is the highest priority configuration. See configuration load order for more information.

Outputs ​

The action sets a single output, status, with the status of the check.