RELEASING.md

Releasing

Version locations

The version string lives in two places and both must be updated:

• pyproject.toml → version = "X.Y.Z"
• splitfolders/__init__.py → __version__ = "X.Y.Z"

Steps

1. Update the version in both files listed above.

2. Commit the version bump:

   git add pyproject.toml splitfolders/__init__.py
   git commit -m "Bump version to X.Y.Z"

3. Create a git tag:

   git tag X.Y.Z

4. Push the commit and tag:

   git push && git push --tags

5. Build and publish to PyPI:

   poetry build
   poetry publish

   This requires PyPI credentials configured locally via poetry config pypi-token.pypi <token>.

6. Create a GitHub release:

   gh release create X.Y.Z --title "X.Y.Z" --notes "$(cat <<'EOF'
   ### Added
   - ...
   
   ### Fixed
   - ...
   
   ### Changed
   - ...
   EOF
   )"

   Copy the release notes from CHANGELOG.md for the version being released.