diff --git a/CHANGELOG.md b/CHANGELOG.md index 0123ea7..2a63fee 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,35 @@ # Changelog +## [v1.1.2] - 2024-12-09 + +### Infrastructure +- Migrated to importlib.resources for file path handling + - Improved package installation reliability + - Standardized default script path definitions + - Removed unused PROJECT_ROOT constant +- Added colorama dependency +- Added warning system for unrecognized CLI arguments with colored output +- Improved virtual cluster output handling + - Added proper output file handling for virtual cluster jobs + - Added automatic output directory creation + - Improved process management for local execution + - Fixed job status tracking to use job_id + +### Bug Fixes +- Fixed file exists error +- Fixed notebook compatibility issues + +### Documentation +- Renamed package from 'flyvision' to 'flyvis' across all documentation, examples +- Updated CLI documentation and usage examples +- Added optional notebook output clearing step to building docs +- Removed pyright and version pin notes from contribute.md +- Cleaned up CLI help text formatting +- Updated file paths in examples to use relative paths +- Removed duplicate CLI documentation from mkdocs.yml + +[v1.1.2]: https://github.com/TuragaLab/flyvis/releases/tag/v1.1.2 + ## [v1.1.1] - 2024-11-21 ### Distribution diff --git a/docs/docs/release.md b/docs/docs/release.md index 79b1b3c..80e49f6 100644 --- a/docs/docs/release.md +++ b/docs/docs/release.md @@ -102,20 +102,20 @@ Commit all open changes to the repository. ```bash git add CHANGELOG.md -git commit -m "docs: add changelog for vX.Y.Z" +git commit -m "docs: add changelog for v1.1.2" ``` ### Create and Push Tag ```bash # Create annotated tag using changelog -git tag -a vX.Y.Z -F CHANGELOG.md +git tag -a v1.1.2 -F CHANGELOG.md # Push to both remotes git push origin main -git push origin vX.Y.Z +git push origin v1.1.2 git push public_repo main -git push public_repo vX.Y.Z +git push public_repo v1.1.2 ``` ### Build and Upload to PyPI @@ -127,7 +127,7 @@ rm -rf dist/ python -m build # Set version temporarily for this session manually -export SETUPTOOLS_SCM_PRETEND_VERSION=X.Y.Z +export SETUPTOOLS_SCM_PRETEND_VERSION=1.1.2 # Now build and test python -m build @@ -137,7 +137,7 @@ python -m twine upload --repository testpypi dist/* unset SETUPTOOLS_SCM_PRETEND_VERSION # Upload to Test PyPI first (recommended) -python -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ flyvis==X.Y.Z +python -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ flyvis==1.1.2 # Upload to PyPI python -m twine upload dist/*