From 3b04e4acc8f3d3b91f74d48af364792599ead7a3 Mon Sep 17 00:00:00 2001 From: Jan Macku Date: Mon, 1 Aug 2022 14:48:20 +0200 Subject: [PATCH] Add section for GitHub Actions - Differential ShellCheck --- GitHub-Actions.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 GitHub-Actions.md diff --git a/GitHub-Actions.md b/GitHub-Actions.md new file mode 100644 index 0000000..f295d7e --- /dev/null +++ b/GitHub-Actions.md @@ -0,0 +1,36 @@ +## Differential ShellCheck + +GitHub action for running ShellCheck differentially. Findings are reported to GitHub using SARIF format. + +- Source: [@redhat-plumbers-in-action/differential-shellcheck](https://github.com/redhat-plumbers-in-action/differential-shellcheck) + +[Usage](https://github.com/redhat-plumbers-in-action/differential-shellcheck#usage): + +```yaml +name: Differential ShellCheck +on: + pull_request: + branches: [main] + +permissions: + contents: read + +jobs: + test: + runs-on: ubuntu-latest + + permissions: + security-events: write + pull-requests: write + + steps: + - name: Repository checkout + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Differential ShellCheck + uses: redhat-plumbers-in-action/differential-shellcheck@latest + with: + token: ${{ secrets.GITHUB_TOKEN }} +```