Skip to content

Commit 23619fc

Browse files
authored
Merge pull request #82 from statisticsnorway/chore/update-docs
Update release docs
2 parents a04b301 + be82fcd commit 23619fc

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

generated/python/datadoc_model/README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@ This package contains pydantic models defining the fields and data types used in
1111
- Support versioning of the metadata format
1212
- Enforce consistency across multiple tools
1313

14-
## Release
14+
## Release process
1515

16-
To release this package, create a branch and run `uv version --bump [patch | minor | major]` depending on your change. Once the branch is merged, a GitHub Actions workflow handles the rest.
16+
Update the version using `uv version --bump`. This project follows [semantic versioning](https://semver.org/):
17+
18+
```bash
19+
uv version --bump patch # bug fixes
20+
uv version --bump minor # new features
21+
uv version --bump major # breaking changes
22+
```
23+
24+
Create a new branch for the release.
25+
26+
Commit with message like `Bump version x.x.x -> y.y.y`.
27+
28+
Open and merge a PR.

0 commit comments

Comments
 (0)