Skip to content

Commit

Permalink
Merge pull request #4 from oscal-club/chore-update-readme
Browse files Browse the repository at this point in the history
Update README for release.
  • Loading branch information
xee5ch authored Dec 14, 2022
2 parents fb63df6 + f149e95 commit d7ec72e
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,25 @@
# oscal-cli-action

A GitHub Action to process, convert, and validate OSCAL content with the NIST oscal-cli tool.

# Usage

**NOTE**: This is a composite action for the GitHub Actions and you must check
the code and setup a Java runtime as dependencies, or it will fail.

```yaml
- name: Checkout
uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b
id: checkout
- name: Setup Java
uses: actions/setup-java@c3ac5dd0ed8db40fedb61c32fbe677e6b355e94c
with:
distribution: adopt
java-version: 11
id: setup_java
- name: Run oscal-cli for version check (debugging on)
uses: oscal-club/[email protected]
with:
args: ssp validate repo/path/to/ssp.xml
id: convert_ssp
```

0 comments on commit d7ec72e

Please sign in to comment.