From 9711ed907d5909054f565f01907b33eb4bb5cefb Mon Sep 17 00:00:00 2001 From: Colin Dembovsky Date: Tue, 4 Oct 2022 12:06:56 -0500 Subject: [PATCH] Update README.md Add upload artifact example. --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5c8a76c..b251dd6 100644 --- a/README.md +++ b/README.md @@ -38,10 +38,20 @@ a future release to provide customization of these templates, via an ability to ## Examples ``` -name: Generate Security Report -uses: peter-murray/github-security-report-action@v2 -with: - token: ${{ secrets.SECURITY_TOKEN }} +- name: Generate Security Report + uses: peter-murray/github-security-report-action@v2 + with: + token: ${{ secrets.SECURITY_TOKEN }} +``` + +To upload the report as an artifact, use the `actions/upload-artifact` Action: + +``` +- name: Upload security report + uses: actions/upload-artifact@v2 + with: + name: SecuritySummaryReport + path: ${{ github.workspace }}/summary.pdf ``` Example summary report output: