Skip to content

Commit

Permalink
legal: adds a reference to the licenses and the disclaimer in the `RE…
Browse files Browse the repository at this point in the history
…ADME.md`
  • Loading branch information
claymcleod committed Nov 12, 2024
1 parent 44131be commit cc1044f
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,48 @@
<hr/>

# Sprocket GitHub Action

This action uses [Sprocket](https://github.com/stjude-rust-labs/sprocket) to validate and optionally lint WDL documents.

## Inputs

### `lint`

**Optional** Whether to run linting in addition to validation. Boolean, valid choices: ["true", "false"]

### `exclude-patterns`

**Optional** Comma separated list of patterns to exclude when searching for WDL files.

### `deny-warnings`

**Optional** If specified, Sprocket `check` will fail if any `warnings` are produced.

### `deny-notes`

**Optional** If specified, Sprocket `check` will fail if any `notes` are produced.

### `except`
**Optional** If specified and `lint`==`true`, then the listed rules will be excepted from all `sprocket lint` checks. Multiple rules can be specified as a comma-separated list, e.g. `CallInputSpacing,CommandSectionMixedIndentation`. Valid options can be found at: https://docs.rs/wdl/latest/wdl/lint/index.html#lint-rules.

**Optional** If specified and `lint`==`true`, then the listed rules will be excepted from all `sprocket lint` checks. Multiple rules can be specified as a comma-separated list, e.g. `CallInputSpacing,CommandSectionMixedIndentation`. Valid options can be found at: https://docs.rs/wdl/latest/wdl/lint/index.html#lint-rules.

## Example usage

```
uses: stjude-rust-labs/sprocket-action@main
with:
lint: true
exclude-patterns: template,test
```

## License and Legal

This project is licensed as either [Apache 2.0][license-apache] or
[MIT][license-mit] at your discretion. Additionally, please see [the
disclaimer](https://github.com/stjude-rust-labs#disclaimer) that applies to all
crates and command line tools made available by St. Jude Rust Labs.

Copyright © 2024-Present [St. Jude Children's Research Hospital](https://github.com/stjude).

[license-apache]: https://github.com/stjude-rust-labs/sprocket-action/blob/main/LICENSE-APACHE
[license-mit]: https://github.com/stjude-rust-labs/sprocket-action/blob/main/LICENSE-MIT

0 comments on commit cc1044f

Please sign in to comment.