Skip to content

docs: document Python test matrix and CI checks #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MugdhoAI merged 1 commit into from
Oct 24, 2026
Merged

docs: document Python test matrix and CI checks #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Vault API is a hands-on way to study the full lifecycle of a sensitive backend r

## Stack

* Python 3.12
* Python 3.12+ (CI tested on 3.12, 3.13, and 3.14)
* FastAPI
* PostgreSQL
* SQLAlchemy 2
Expand Down Expand Up @@ -234,7 +234,7 @@ Run static checks with Ruff:
ruff check .
```

Tests cover password hashing, token handling, configuration validation, encryption and key rotation, duplicate registration, invalid credentials, database health, secret CRUD operations, owner isolation, and request schema validation. GitHub Actions runs Ruff and the PostgreSQL-backed test suite for pushes to `main` and pull requests.
Tests cover password hashing, token handling, configuration validation, encryption and key rotation, duplicate registration, invalid credentials, database health, secret CRUD operations, owner isolation, and request schema validation. CI runs Ruff, `pip-audit`, Docker image and Compose validation, and the PostgreSQL-backed test suite on Python 3.12, 3.13, and 3.14. CodeQL analyzes the Python code on pushes to `main` and pull requests targeting `main`.

## Current limitations

Expand Down
Loading