Skip to content

Commit 7d9f181

Browse files
docs: adding release-please docs
1 parent 489612a commit 7d9f181

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

CONTRIBUTORS.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,19 @@ Re-record cassettes when:
7878
- An API response schema changes (use `just test-vcr-rewrite tests/test_main.py::test_affected_test`)
7979
- A fixture changes the request payload (field values, resource names, etc.)
8080

81+
## Releases
82+
83+
Releases are automated via [release-please](https://github.com/googleapis/release-please). PR titles must use [Conventional Commits](https://www.conventionalcommits.org/) prefixes, and PRs must be squash-merged so the title becomes the commit message.
84+
85+
| Prefix | Version bump | Example |
86+
|---|---|---|
87+
| `fix:` | Patch (1.1.1 -> 1.1.2) | `fix: handle null chart_settings in cost reports` |
88+
| `feat:` | Minor (1.1.1 -> 1.2.0) | `feat: add dashboard endpoints` |
89+
| `feat!:` | Major (1.1.1 -> 2.0.0) | `feat!: rename VantageSDK to VantageClient` |
90+
| `chore:`, `docs:`, `ci:` | No release | `chore: update dev dependencies` |
91+
92+
When commits land on `main`, release-please opens (or updates) a Release PR that bumps the version in `pyproject.toml` and updates `CHANGELOG.md`. Merging that Release PR triggers the publish to PyPI. Do not manually edit the version in `pyproject.toml`.
93+
8194
## Regenerating Models
8295

8396
`vantage_sdk/models/gen_models/` is generated using the `datamodel-codegen` tool. All codegen configuration lives in `pyproject.toml` under `[tool.datamodel-codegen]`.

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "uv_build"
44

55
[project]
66
name = "client-for-vantage"
7-
version = "1.1.2"
7+
version = "1.1.1"
88
description = "An SDK for interacting with the Vantage API, attempts to maintain parity with the API, provides type safety via codegen Pydantic classes and manages pagination"
99
readme = "README.md"
1010
requires-python = ">=3.10,<3.13"
@@ -163,4 +163,4 @@ quote-style = "double"
163163

164164
[tool.pyproject-fmt]
165165
column_width = 120
166-
indent = 4
166+
indent = 4

0 commit comments

Comments
 (0)