mirrors/zizmor
1
0
Fork 0
mirror of https://github.com/zizmorcore/zizmor.git synced 2025-12-23 08:47:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

feat: make zizmor's core async (#1314)
Some checks are pending
CI / Lint (push) Waiting to run
Details
CI / Test (push) Waiting to run
Details
CI / Test site build (push) Waiting to run
Details
CI / All tests pass (push) Blocked by required conditions
Details
zizmor wheel builds for PyPI 🐍 / Build Linux wheels (manylinux) (push) Waiting to run
Details
zizmor wheel builds for PyPI 🐍 / Build Linux wheels (musllinux) (push) Waiting to run
Details
zizmor wheel builds for PyPI 🐍 / Build Windows wheels (push) Waiting to run
Details
zizmor wheel builds for PyPI 🐍 / Build macOS wheels (push) Waiting to run
Details
zizmor wheel builds for PyPI 🐍 / Build source distribution (push) Waiting to run
Details
zizmor wheel builds for PyPI 🐍 / Release (push) Blocked by required conditions
Details
Deploy zizmor documentation site 🌐 / Deploy zizmor documentation to GitHub Pages 🌐 (push) Waiting to run
Details
GitHub Actions Security Analysis with zizmor 🌈 / Run zizmor 🌈 (push) Waiting to run
Details

Browse source
This commit is contained in:
William Woodruff 2025-11-07 19:04:53 -05:00 • committed by GitHub
parent b532131fe3
commit 2e85156ddf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
46 changed files with 739 additions and 515 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/development.md
View file

@ -290,12 +290,12 @@ Some things that can be useful to discuss beforehand:
When developing a new `zizmor` audit, there are a couple of implementation details to be aware of:
- All existing audits live in a Rust modules grouped under `crates/zizmor/src/audit` folder
- All existing audits live in a Rust module grouped under `crates/zizmor/src/audit` folder
- The expected behavior for all audits is defined by the `Audit` trait at `crates/zizmor/src/audit/mod.rs`
- The expected outcome of an executed audit is defined by the `Finding` struct at `crates/zizmor/src/finding/mod.rs`
- Any `Audit` implementation can have access to an `AuditState` instance, as per `crates/zizmor/src/state.rs`
- If an audit requires data from the GitHub API, there is a `Client` implementation at `crates/zizmor/src/github_api.rs`
- All the audits must be registered at `crates/zizmor/src/main.rs` according to the `register_audit!` macro
- All the audits must be registered in the default `AuditRegistry` at `crates/zizmor/src/registry.rs`
Last but not least, it's useful to run the following checks before opening a Pull Request: