Skip to content

Commit 7c3e49c

Browse files
committed
adding changelist
1 parent 478be5c commit 7c3e49c

File tree

2 files changed

+37
-8
lines changed

2 files changed

+37
-8
lines changed

CHANGELIST.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [2.2.0] - 2025-12-12
9+
10+
### Added
11+
- Added a codespace configuration.
12+
- Implemented new unit tests and various improvements.
13+
14+
### Changed
15+
- Reworked project structure for best practices.
16+
- Updated configuration for trusted publishing.
17+
- Moving the package to its own repo.
18+
- Implemented more of the Riverscapes Project XSD spec.

DEVELOPER.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,22 @@ nox
3232

3333
In order to run the examples you will need to install `rsxml`. If you want that installed version to be editable, you can use `pip install -e .` from the root rsxml directory.
3434

35-
## Deploying
36-
37-
There are two scripts to deploy the package to PyPI:
38-
39-
- `build.sh` - builds the package and puts it in `dist/`.
40-
- `deploy.sh` - Push the package to the PyPI server. This script requires `PYPI_TOKEN` environment variable.
41-
42-
The scripts will automatically install `uv` if it is not present.
35+
## Release Process
36+
37+
1. **Update Changelog**:
38+
- Move the content from `[Unreleased]` to a new section with the version number and date in [CHANGELIST.md](CHANGELIST.md).
39+
- Ensure `[Unreleased]` is empty but preserved at the top.
40+
41+
2. **Bump Version**:
42+
- Update the version number in [src/rsxml/__version__.py](src/rsxml/__version__.py).
43+
44+
3. **Tag and Push**:
45+
- Commit the changes (changelog and version bump).
46+
- Create a git tag matching the version (e.g., `v2.2.0`) NOTE THE "v" it is important that the tag start with this.
47+
- Push the commit and the tag to GitHub:
48+
```bash
49+
git commit -am "Bump version to 2.2.0"
50+
git tag v2.2.0
51+
git push && git push --tags
52+
```
53+
- The [Publish to PyPI](.github/workflows/pypi-publish.yml) GitHub Action will automatically build and deploy the package.

0 commit comments

Comments
 (0)