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

Documentation/Clarity #8

Open
4 tasks
aaronlippold opened this issue Mar 8, 2022 · 0 comments
Open
4 tasks

Documentation/Clarity #8

aaronlippold opened this issue Mar 8, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@aaronlippold
Copy link
Member

aaronlippold commented Mar 8, 2022

In reading through the README a few things came to mind

  • Document how the with fuction works and what path is relative to
  • Example of how you might generate an output file from one task and use it in our action
  • Document how you take the result and save it to a desired location
  • Let's make one where we convert from one format to another and save it

This is one use case

- name: Display our ${{ matrix.suite }} results summary
    uses: mitre/saf_action@v1
    with:
      command_string: 'view:summary -i spec/results/ec2_rhel-7_${{ matrix.suite }}.json'
 - name: Ensure the scan meets our ${{ matrix.suite }} results threshold
    uses: mitre/saf_action@v1
    with:
      command_string: 'validate:threshold -i spec/results/ec2_rhel-7_${{ matrix.suite }}.json -F ${{ matrix.suite }}.threshold.yml'
 - name: Save Test Result JSON
    uses: actions/upload-artifact@v2
    with:
      path: spec/results/
@aaronlippold aaronlippold added the documentation Improvements or additions to documentation label Mar 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants