changelog 0.8.0

mikesongming · Jul 7, 2022 · a45a95b · a45a95b
1 parent 5d86e3b
commit a45a95b
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 6 deletions.
diff --git a/.changelog/news/24.api b/.changelog/news/24.api
diff --git a/.changelog/news/24.doc b/.changelog/news/24.doc
diff --git a/.changelog/news/PR26.maint b/.changelog/news/PR26.maint
diff --git a/.github/workflows/publish_doc.yml b/.github/workflows/publish_doc.yml
@@ -6,6 +6,9 @@ on:
     paths:
       - docs
       - overrides
+  pull_request:
+    types:
+      - closed
   workflow_dispatch:
 
 
@@ -16,6 +19,10 @@ jobs:
   deploy:
     needs: whoami
     runs-on: ubuntu-latest
+    if: >-
+      github.event_name == 'workflow_dispatch' ||
+      github.event_name == 'push' ||
+      (github.event_name == 'pull_request' && github.event.pull_request.merged)
     steps:
       - uses: actions/checkout@v3
         with:

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -45,7 +45,7 @@ jobs:
       ${{
         inputs.os == 'Linux' && 'ubuntu-20.04' ||
         (
-          inputs.os == 'Windows' && 'windows-2019' || 'macos-11'
+          inputs.os == 'Windows' && 'windows-2022' || 'macos-11'
         )
       }}
     outputs:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,29 @@
 
 <!-- towncrier release notes start -->
 
+## **v0.8.0** (2022-07-07)
+
+### :bulb: API Changes
+
+- [#24](https://github.com/mikesongming/SE-Geometry/issues/24) simplify python
+  frontend api by refactoring c++ backend with pybind11-empowered virtual
+  function overriding and methods overloading
+
+
+### :memo: Documentation Improvements
+
+- [#24](https://github.com/mikesongming/SE-Geometry/issues/24) update flow
+  graph in dev-guid.md and docstring in _analyzer.py
+
+
+### :hammer_and_wrench: Maintenance
+
+- [PR\#26](https://github.com/mikesongming/SE-Geometry/pull/26) Introduce cmake
+  module to fetch library pybind11 and date-tz; Modify setup.py to support
+  c++17 on MacOSX >= 10.12;
+  and Build windows version on Windows-2022 with manually downloaded tzdata
+
+
 ## **v0.7.6** (2022-06-28)
 
 ### :bug: Bug Fixes

diff --git a/docs/index.md b/docs/index.md
@@ -21,4 +21,4 @@ which comsists of a simplistic _python_ frontend and an extensible _C++_ backend
 
 - MacOSX-10.12-x86_64
 - Ubuntu-20.04-manylinux_x86_64
-- Windows-2019-win_amd64
+- Windows-2022-win_amd64
diff --git a/docs/user-guide/usage.md b/docs/user-guide/usage.md
@@ -5,6 +5,22 @@ import fseg
 print(fseg.__version__)
 ```
 
+!!! note
+
+    Since there is no system time-zone data on **Windows**,
+    it is necessary to download [IANA](https://www.iana.org/time-zones)
+    tzdata for the library date-tz.
+
+    ```bash
+    mkdir $HOME/tzdata
+    cd $HOME/tzdata
+    curl "https://data.iana.org/time-zones/releases/tzdata2022a.tar.gz" | tar xvz
+    curl "https://raw.githubusercontent.com/unicode-org/cldr/main/common/supplemental/windowsZones.xml"
+    ```
+
+    If `curl` failed with `connection refused`, manually download the `windowsZones.xml` file in browser.
+
+
 ## sun position at
 
 1. Instantialize an `analyzer`, and bound to an _algorithm_, for example _"SPA"_: