docs: mention zizmorcore/zizmor-action (#895)

This commit is contained in:
William Woodruff 2025-06-05 00:05:21 -04:00 committed by GitHub
parent 41112047dc
commit 73dfa03a41
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 87 additions and 4 deletions

29
docs/assets/chips.css Normal file
View file

@ -0,0 +1,29 @@
.chip-recommended {
display: inline-block;
background: green;
color: white;
padding: 0px 6px;
border-radius: 10px;
font-size: x-small;
vertical-align: middle;
}
.chip-recommended::before {
content: "recommended";
font-style: normal;
}
.chip-expert {
display: inline-block;
background: blue;
color: white;
padding: 0px 6px;
border-radius: 10px;
font-size: x-small;
vertical-align: middle;
}
.chip-expert::before {
content: "for experts";
font-style: normal;
}

View file

@ -618,13 +618,66 @@ zizmor --cache-dir /tmp/zizmor ...
### Use in GitHub Actions
`zizmor` is designed to integrate with GitHub Actions. There are
two primary ways to use `zizmor` in GitHub Actions:
`zizmor` is designed to integrate with GitHub Actions.
1. With `--format=sarif` via Advanced Security (recommended)
The easiest way to use `zizmor` in GitHub Actions is
with @zizmorcore/zizmor-action. However, expert users or those who want
more fine-grained control over their integration can also use the
[Manual integration](#manual-integration) steps further below.
#### With @zizmorcore/zizmor-action * *{.chip-recommended}
To get started with @zizmorcore/zizmor-action, you can use the following
workflow skeleton:
```yaml title="zizmor.yml"
name: GitHub Actions Security Analysis with zizmor 🌈
on:
push:
branches: ["main"]
pull_request:
branches: ["**"]
permissions: {}
jobs:
zizmor:
runs-on: ubuntu-latest
permissions:
security-events: write
contents: read # only needed for private repos
actions: read # only needed for private repos
steps:
- name: Checkout repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
persist-credentials: false
- name: Run zizmor 🌈
uses: zizmorcore/zizmor-action@f52a838cfabf134edcbaa7c8b3677dde20045018 # v0.1.1
```
See the action's [`inputs` documentation][inputs-documentation] for
additional configuration options.
[inputs-documentation]: https://github.com/zizmorcore/zizmor-action#inputs
#### Manual integration * *{.chip-expert}
If you don't want to use @zizmorcore/zizmor-action, you can always
use `zizmor` directly in your GitHub Actions workflows.
All of the same functionality is available, but you'll need to do a bit
more explicit scaffolding.
There are two main ways to manually integrate `zizmor` into your
GitHub Actions setup:
1. With `--format=sarif` via Advanced Security * *{.chip-recommended}
2. With `--format=github` via GitHub Annotations
=== "With Advanced Security (recommended)"
=== "With Advanced Security * *{.chip-recommended}"
GitHub's Advanced Security and [code scanning functionality] supports
[SARIF], which `zizmor` can produce via `--format=sarif`.

View file

@ -107,6 +107,7 @@ validation:
extra_css:
- assets/magiclink.css
- assets/chips.css
exclude_docs: |
snippets/