Skip to content

Commit

Permalink
rename 'internal-be-careful-output' to 'summary-output-base64'
Browse files Browse the repository at this point in the history
  • Loading branch information
dom-colangelo committed Feb 21, 2024
1 parent 78c8c56 commit 8a779a7
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 12 deletions.
12 changes: 5 additions & 7 deletions .github/workflows/selftest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@ jobs:
internal-be-careful-allow-failure: true
- name: assert expected output
env:
PIP_AUDIT_OUTPUT: "${{ steps.pip-audit.outputs.internal-be-careful-output }}"
MARKDOWN_SUMMARY_OUTPUT: "${{ steps.pip-audit.outputs.makrdown-summary }}"
PIP_AUDIT_OUTPUT: "${{ steps.pip-audit.outputs.summary-output-base64 }}"
run: |
grep -E 'pyyaml\s+\|\s+5.1' <<< $(base64 -d <<< "${PIP_AUDIT_OUTPUT}")
grep 'pip-audit found one or more problems' <<< $(base64 -d <<< "${MARKDOWN_SUMMARY_OUTPUT}")
selftest-environment:
runs-on: ubuntu-latest
Expand All @@ -43,7 +41,7 @@ jobs:
internal-be-careful-allow-failure: true
- name: assert expected output
env:
PIP_AUDIT_OUTPUT: "${{ steps.pip-audit.outputs.internal-be-careful-output }}"
PIP_AUDIT_OUTPUT: "${{ steps.pip-audit.outputs.summary-output-base64 }}"
run: |
grep -E 'pyyaml\s+\|\s+5.1' <<< $(base64 -d <<< "${PIP_AUDIT_OUTPUT}")
Expand All @@ -69,7 +67,7 @@ jobs:
internal-be-careful-allow-failure: true
- name: assert expected output
env:
PIP_AUDIT_OUTPUT: "${{ steps.pip-audit.outputs.internal-be-careful-output }}"
PIP_AUDIT_OUTPUT: "${{ steps.pip-audit.outputs.summary-output-base64 }}"
run: |
grep -E 'pyyaml\s+\|\s+5.1' <<< $(base64 -d <<< "${PIP_AUDIT_OUTPUT}")
Expand All @@ -87,7 +85,7 @@ jobs:
internal-be-careful-allow-failure: true
- name: assert expected output
env:
PIP_AUDIT_OUTPUT: "${{ steps.pip-audit.outputs.internal-be-careful-output }}"
PIP_AUDIT_OUTPUT: "${{ steps.pip-audit.outputs.summary-output-base64 }}"
run: |
grep -E 'pyyaml\s+\|\s+5.1' <<< $(base64 -d <<< "${PIP_AUDIT_OUTPUT}")
Expand All @@ -106,6 +104,6 @@ jobs:
internal-be-careful-allow-failure: true
- name: assert expected output
env:
PIP_AUDIT_OUTPUT: "${{ steps.pip-audit.outputs.internal-be-careful-output }}"
PIP_AUDIT_OUTPUT: "${{ steps.pip-audit.outputs.summary-output-base64 }}"
run: |
grep 'pip-audit did not return any output' <<< $(base64 -d <<< "${PIP_AUDIT_OUTPUT}")
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ The `summary` setting controls whether a GitHub
[job summary](https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/)
is rendered at the end of the action.

__Note:__ The markdown-formatted summary ("raw markdown" in the GitHub UI) is output to a variable `markdown-summary` when job summaries are enabled.
__Note:__ The markdown-formatted summary is base64 wrapped and output to the variable `summary-output-base64` when job summaries are enabled.

Example:

Expand Down
5 changes: 1 addition & 4 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,9 @@ inputs:
required: false
default: ""
outputs:
internal-be-careful-output:
summary-output-base64:
description: "the column-formatted output from pip-audit, wrapped as base64"
value: "${{ steps.pip-audit.outputs.output }}"
markdown-summary:
description: "the markdown summary output from pip-audit, passed to the Job Summaries page"
value: "${{ steps.pip-audit.outputs.markdown-summary }}"
runs:
using: "composite"
steps:
Expand Down

0 comments on commit 8a779a7

Please sign in to comment.