mirror of
https://github.com/trailofbits/algo.git
synced 2026-09-28 20:44:58 +02:00
21e21747ea
* ci: modernize tooling with prek, ty, and security scanning Migrate from pre-commit to prek (Rust-native, faster hooks) and add comprehensive CI improvements for code quality and security. Changes: - Replace pre-commit with prek for git hooks - Add ty type checker (Rust-based, replaces mypy) - Expand ruff rules: security (S), simplify (SIM), commented code (ERA) - Add pip-audit workflow for Python dependency CVE scanning - Add actionlint and zizmor for GitHub Actions linting/security - Add ruff format check to CI - Enable stricter ansible-lint rules (no-changed-when, risky-file-permissions) - Remove obsolete Claude workflow files - Apply ruff formatting fixes to test files Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(ci): resolve actionlint install and ty type errors - Use actionlint's official install script instead of broken URL pattern - Exclude test mock modules from ty type checking - Run workflows on push only for main/master to avoid duplicate PR runs Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(ci): use glob pattern for actionlint, exclude all tests from ty - actionlint requires *.yml glob, not directory path - Exclude all tests from ty type checking (test code has looser typing) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(ci): quote shell variables to fix shellcheck warnings Fix SC2046/SC2086 warnings in workflow scripts: - Quote $(uname -r) in apt-get install - Quote $(pwd) in docker volume mount - Quote $existing in gh issue comment Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(ci): move key-order[task] to warn_list Too many existing violations in the codebase to enable as error. Move to warn_list for gradual fixes over time. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
24 lines
1.1 KiB
Markdown
24 lines
1.1 KiB
Markdown
### Filing New Issues
|
|
|
|
* We welcome bug reports! Before filing, a quick check of the [FAQ](docs/faq.md) or [troubleshooting](docs/troubleshooting.md) docs might have your answer
|
|
* Algo automatically installs dependencies with uv - no manual setup required
|
|
* We support modern clients: macOS 12+, iOS 15+, Windows 11+, Ubuntu 22.04+, etc.
|
|
* Supported cloud providers: DigitalOcean, AWS, Azure, GCP, Vultr, Hetzner, Linode, OpenStack, CloudStack
|
|
* If you need to file a new issue, fill out any relevant fields in the Issue Template
|
|
|
|
### Pull Requests
|
|
|
|
* Run the full linter suite: `./scripts/lint.sh`
|
|
* Test your changes on multiple platforms when possible
|
|
* Use conventional commit messages that clearly describe your changes
|
|
* Pin dependency versions rather than using ranges (e.g., `==1.2.3` not `>=1.2.0`)
|
|
|
|
### Development Setup
|
|
|
|
* Clone the repository: `git clone https://github.com/trailofbits/algo.git`
|
|
* Run Algo: `./algo` (dependencies installed automatically via uv)
|
|
* Install git hooks: `prek install` (optional, for contributors)
|
|
* For local testing, consider using Docker or a cloud provider test instance
|
|
|
|
Thanks!
|