From 98130e8ccc7e02b82c53d1910526d26dc606836f Mon Sep 17 00:00:00 2001 From: Geoff Boeing Date: Tue, 28 Nov 2023 17:20:54 -0800 Subject: [PATCH 1/4] update docs --- tests/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/README.md b/tests/README.md index ba07355f1..ca1660b86 100644 --- a/tests/README.md +++ b/tests/README.md @@ -37,7 +37,7 @@ All PRs trigger continuous integration tests via GitHub Actions. See the [config ## Releases -To package and release a new version, update `CHANGELOG.md` and edit the version number in `osmnx/_version.py`. If needed, update `LICENSE.txt` dates and `pyproject.toml` dependency versions. Then change directories to the repository's root and run: +To package and release a new version, update `CHANGELOG.md` and edit the version number in `osmnx/_version.py`. If necessary, update the dates in `LICENSE.txt` and `docs/source/conf.py` and the dependency versions in `pyproject.toml`. Then change directories to the repository's root and run: ``` bash ./tests/packaging.sh From 82ae7263eb476b5ff7d49ba372c5b2d97f7470dd Mon Sep 17 00:00:00 2001 From: Geoff Boeing Date: Tue, 28 Nov 2023 17:21:23 -0800 Subject: [PATCH 2/4] version bump to 1.8.0 --- CHANGELOG.md | 2 +- osmnx/_version.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 985b17d33..227754307 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## Unreleased +## 1.8.0 (2023-11-30) - formally support Python 3.12 (#1082) - fix Windows-specific character encoding issue when reading XML files (#1084) diff --git a/osmnx/_version.py b/osmnx/_version.py index b876b2f8c..80a90c67e 100644 --- a/osmnx/_version.py +++ b/osmnx/_version.py @@ -1,3 +1,3 @@ """OSMnx package version information.""" -__version__ = "1.7.1" +__version__ = "1.8.0" From 1750538cb03a90a20511a400e47519b091560d08 Mon Sep 17 00:00:00 2001 From: Geoff Boeing Date: Tue, 28 Nov 2023 17:36:46 -0800 Subject: [PATCH 3/4] verify docs and their links before packaging --- tests/packaging.sh | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/tests/packaging.sh b/tests/packaging.sh index e7040a175..f76ffb357 100644 --- a/tests/packaging.sh +++ b/tests/packaging.sh @@ -15,6 +15,11 @@ conda deactivate conda activate ox mamba update conda-smithy --yes --no-banner +# test the docs build and validate that all their links are live +rm -rf ./docs/build +make -C ./docs html +python -m sphinx -b linkcheck docs/source build/linkcheck + # get the current package version number VERSION=$(hatch version) From a93a13d27fb824b2099b6057a4a49a53880bc8bb Mon Sep 17 00:00:00 2001 From: Geoff Boeing Date: Tue, 28 Nov 2023 17:39:21 -0800 Subject: [PATCH 4/4] remove build dir after docs check --- tests/packaging.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/packaging.sh b/tests/packaging.sh index f76ffb357..acea5208b 100644 --- a/tests/packaging.sh +++ b/tests/packaging.sh @@ -19,6 +19,7 @@ mamba update conda-smithy --yes --no-banner rm -rf ./docs/build make -C ./docs html python -m sphinx -b linkcheck docs/source build/linkcheck +rm -rf ./docs/build # get the current package version number VERSION=$(hatch version)