Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

website documentation for trestle task osco-to-oscal #336

Merged
merged 2 commits into from
Feb 8, 2021

Conversation

degenaro
Copy link
Collaborator

@degenaro degenaro commented Feb 2, 2021

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • All commits are signed-off.

Description

Update docs/cli.md documentation for trestle task osco-to-oscal configuration parameters comprising:

  • input-dir: required - contains osco evidence .yaml files and optional oscal metadata .yaml file.
  • output-dir: required - contains created OSCAL partial Assessment Results .json file.
  • oscal-metadata: optional - name of .yaml file in input-dir employed to augment the produced OSCAL.
  • output-overwrite: optional - true or false for permission to overwrite existing output files.

Closes #335.

@degenaro degenaro force-pushed the feature/task-osco-to-oscal-documentation branch from 20aad2b to 9e94bb0 Compare February 2, 2021 20:00
@codecov
Copy link

codecov bot commented Feb 2, 2021

Codecov Report

Merging #336 (ca54c06) into develop (7b1b48d) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #336   +/-   ##
========================================
  Coverage    99.11%   99.11%           
========================================
  Files           52       52           
  Lines         6359     6359           
========================================
  Hits          6303     6303           
  Misses          56       56           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7b1b48d...ca54c06. Read the comment docs.

@butler54 butler54 self-requested a review February 2, 2021 20:15
Copy link
Collaborator

@butler54 butler54 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@butler54 butler54 merged commit 95c5c09 into develop Feb 8, 2021
@butler54 butler54 deleted the feature/task-osco-to-oscal-documentation branch February 8, 2021 04:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

website documention for trestle task osco-to-oscal
2 participants