Skip to content

Commit

Permalink
docs: penetration_test_artifact (#50)
Browse files Browse the repository at this point in the history
  • Loading branch information
DerekRoberts authored Sep 17, 2023
1 parent 3c2e3c4 commit fe41fbd
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ Testing has only been done with public containers on ghcr.io (GitHub Container R
# Allow ZAProxy alerts to fail the workflow? [true/false]
penetration_test_fail: false

# Provide a name for ZAProxy workflow artifacts; e.g. frontend, backend
# Without this multiple package artifact names can collide
penetration_test_artifact: frontend

# Provide a name to enable ZAProxy issue creation; e.g. frontend, backend
# If the issue exists, it adds new comments to the existing issue.
penetration_test_issue: frontend
Expand Down
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ inputs:
penetration_test_fail:
description: Allow ZAProxy alerts to fail the workflow? [true|false]
default: "false"
penetration_test_artifact_name:
penetration_test_artifact:
description: Provide a name to attach ZAProxy scan artifacts to workflows; e.g. frontend, backend
default: "unnamed"
penetration_test_issue:
Expand Down Expand Up @@ -197,7 +197,7 @@ runs:
fail_action: "${{ inputs.penetration_test_fail }}"
# allow_... is purposefully obscured - if a title is provided, then = true
allow_issue_writing: "${{ inputs.penetration_test_issue && true || false }}"
artifact_name: "zap_${{ inputs.penetration_test_artifact_name }}"
artifact_name: "zap_${{ inputs.penetration_test_artifact }}"
issue_title: "ZAP: ${{ inputs.penetration_test_issue }}"

# Action repo needs to be present for cleanup/tests
Expand Down

0 comments on commit fe41fbd

Please sign in to comment.