@@ -51,6 +51,9 @@ qualytics config import --input ./qualytics-config --dry-run
5151| ` anomalies ` | View and manage detected anomalies |
5252| ` operations ` | Trigger sync, profile, and scan operations |
5353| ` config ` | Export and import configuration as code |
54+ | ` users ` | List and view users |
55+ | ` teams ` | List and view teams |
56+ | ` tags ` | Manage tags (list, create, delete) |
5457| ` schedule ` | Schedule recurring operations |
5558| ` mcp ` | Start the MCP server for LLM integration |
5659| ` doctor ` | Check CLI health and connectivity |
@@ -85,6 +88,39 @@ uv run pre-commit run --all-files # Lint, format, type checks
8588
8689For architecture details and contribution guidelines, see [ AGENTS.md] ( AGENTS.md ) .
8790
91+ ## Releasing
92+
93+ Releases are automated via GitHub Actions. The version lives in ` pyproject.toml ` and is managed by ` uv version ` .
94+
95+ ### Steps to release a new version
96+
97+ 1 . ** Ensure ` main ` is green** -- CI (lint + tests across Python 3.10-3.14 + pre-commit) must pass.
98+
99+ 2 . ** Trigger the Release workflow** -- Go to [ Actions > Release] ( ../../actions/workflows/release.yml ) and click ** Run workflow** . Select the bump type:
100+ - ` patch ` -- bug fixes (1.0.0 → 1.0.1)
101+ - ` minor ` -- new features (1.0.0 → 1.1.0)
102+ - ` major ` -- breaking changes (1.0.0 → 2.0.0)
103+
104+ 3 . ** The workflow automatically:**
105+ - Bumps the version in ` pyproject.toml ` via ` uv version --bump <type> `
106+ - Commits the change and creates a ` v{version} ` git tag
107+ - Pushes the commit and tag to ` main `
108+
109+ 4 . ** The tag push triggers the Publish workflow** , which:
110+ - Builds the package (` uv build ` )
111+ - Publishes to [ PyPI] ( https://pypi.org/project/qualytics-cli/ ) via OIDC trusted publishing (no API tokens needed)
112+ - Creates a GitHub Release with auto-generated release notes and attached artifacts
113+
114+ ### Manual version check
115+
116+ ``` bash
117+ # Current version in pyproject.toml
118+ uv version --short
119+
120+ # Installed version
121+ qualytics --version
122+ ```
123+
88124## License
89125
90126MIT License -- see [ LICENSE] ( LICENSE ) for details.
0 commit comments