fix(workflows): fix hashFiles pattern for macOS

Author: XuehaiPan

.github/workflows/build.yml

@@ -72,15 +72,13 @@ jobs:
           update-environment: true
 
       - name: Upgrade pip
-        run: |
-          python -m pip install --upgrade pip setuptools
+        run: python -m pip install --upgrade pip setuptools
 
       - name: Set __release__
         if: |
           startsWith(github.ref, 'refs/tags/') ||
           (github.event_name == 'workflow_dispatch' && github.event.inputs.task == 'build-and-publish')
-        run: |
-          python .github/workflows/set_release.py
+        run: python .github/workflows/set_release.py
 
       - name: Print version
         run: python setup.py --version
@@ -333,8 +331,7 @@ jobs:
         run: ls -lh dist/*
 
       - name: Remove PyPI unsupported files
-        run: |
-          rm -f dist/*wasm*.whl
+        run: rm -f dist/*wasm*.whl
 
       - name: Upload artifacts
         uses: actions/upload-artifact@v5
@@ -367,13 +364,11 @@ jobs:
           update-environment: true
 
       - name: Upgrade pip
-        run: |
-          python -m pip install --upgrade pip setuptools
+        run: python -m pip install --upgrade pip setuptools
 
       - name: Set __release__
         if: startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch'
-        run: |
-          python .github/workflows/set_release.py
+        run: python .github/workflows/set_release.py
 
       - name: Print version
         run: python setup.py --version

.github/workflows/lint.yml

@@ -51,16 +51,15 @@ jobs:
           cache: pip
           cache-dependency-path: |
             pyproject.toml
-            **/requirements.txt
+            requirements*.txt
+            */requirements*.txt
             .pre-commit-config.yaml
 
       - name: Upgrade pip
-        run: |
-          python -m pip install --upgrade pip setuptools
+        run: python -m pip install --upgrade pip setuptools
 
       - name: Install dependencies
-        run: |
-          python -m pip install wheel pybind11 -r docs/requirements.txt
+        run: python -m pip install wheel pybind11 -r docs/requirements.txt
 
       - name: Install nightly pybind11
         shell: bash
@@ -75,52 +74,40 @@ jobs:
           python -m pip install --force-reinstall 'pybind11 @ git+https://github.com/pybind/pybind11.git#egg=pybind11'
 
       - name: Install OpTree
-        run: |
-          python -m pip install -v --no-build-isolation --editable '.[lint]'
+        run: python -m pip install -v --no-build-isolation --editable '.[lint]'
 
       - name: pre-commit
-        run: |
-          make pre-commit
+        run: make pre-commit
 
       - name: clang-format
-        run: |
-          make clang-format
+        run: make clang-format
 
       - name: clang-tidy
-        run: |
-          make clang-tidy CMAKE_CXX_STANDARD=17
+        run: make clang-tidy CMAKE_CXX_STANDARD=17
 
       - name: cpplint
-        run: |
-          make cpplint
+        run: make cpplint
 
       - name: python-format
-        run: |
-          make python-format
+        run: make python-format
 
       - name: ruff
-        run: |
-          make ruff
+        run: make ruff
 
       - name: pylint
-        run: |
-          make pylint
+        run: make pylint
 
       - name: mypy
-        run: |
-          make mypy
+        run: make mypy
 
       - name: doctest
-        run: |
-          make doctest
+        run: make doctest
 
       - name: addlicense
-        run: |
-          make addlicense
+        run: make addlicense
 
       - name: docstyle
-        run: |
-          make docstyle
+        run: make docstyle
 
       - name: spelling
         run: |

.github/workflows/tests-with-pydebug.yml

@@ -220,9 +220,8 @@ jobs:
         id: pip-cache
         uses: actions/cache@v4
         with:
-          path: |
-            ${{ env.PIP_CACHE_DIR }}
-          key: pip-${{ runner.os }}-${{ runner.arch }}-${{ matrix.python-version }}${{ matrix.python-abiflags }}-${{ hashFiles('pyproject.toml', '**/requirements.txt') }}
+          path: ${{ env.PIP_CACHE_DIR }}
+          key: pip-${{ runner.os }}-${{ runner.arch }}-${{ matrix.python-version }}${{ matrix.python-abiflags }}-${{ hashFiles('pyproject.toml', 'requirements*.txt', '*/requirements*.txt') }}$
 
       - name: Set up Environment
         shell: bash
@@ -250,8 +249,10 @@ jobs:
           "${PYTHON_EXE}" -m venv venv  # PATH is already updated in step setup-pyenv
           echo "::group::Python executables"
           if [[ "${{ runner.os }}" != 'Windows' ]]; then
+            source venv/bin/activate
             ls -alh venv/bin
           else
+            source venv/Scripts/activate
             ls -alh venv/Scripts
           fi
           echo "::endgroup::"
@@ -316,6 +317,12 @@ jobs:
           github.event_name == 'pull_request' &&
           contains(github.event.pull_request.labels.*.name, 'test-with-nightly-pybind11')
         run: |
+          if [[ "${{ runner.os }}" != 'Windows' ]]; then
+            source venv/bin/activate
+          else
+            source venv/Scripts/activate
+          fi
+
           ${{ env.PYTHON }} .github/workflows/set_setup_requires.py
           echo "::group::pyproject.toml"
           cat pyproject.toml
@@ -324,16 +331,36 @@ jobs:
 
       - name: Test buildable without Python frontend
         if: runner.os != 'Windows'
+        shell: bash
         run: |
+          if [[ "${{ runner.os }}" != 'Windows' ]]; then
+            source venv/bin/activate
+          else
+            source venv/Scripts/activate
+          fi
+
           make cmake-build PYTHON="${{ env.PYTHON }}" && make clean
 
       - name: Install OpTree
+        shell: bash
         run: |
+          if [[ "${{ runner.os }}" != 'Windows' ]]; then
+            source venv/bin/activate
+          else
+            source venv/Scripts/activate
+          fi
+
           ${{ env.PYTHON }} -m pip install -v --editable '.[test]'
 
       - name: Test with pytest
         shell: bash
         run: |
+          if [[ "${{ runner.os }}" != 'Windows' ]]; then
+            source venv/bin/activate
+          else
+            source venv/Scripts/activate
+          fi
+
           set -x
           ulimit -c unlimited
           ulimit -a

.github/workflows/tests.yml

@@ -85,7 +85,8 @@ jobs:
           cache: pip
           cache-dependency-path: |
             pyproject.toml
-            **/requirements.txt
+            requirements*.txt
+            */requirements*.txt
 
       - name: Set up Environment
         shell: bash
@@ -237,8 +238,7 @@ jobs:
           fi
 
       - name: Install OpTree (with system CMake)
-        run: |
-          ${{ env.PYTHON }} -m pip install -v --editable '.[test]'
+        run: ${{ env.PYTHON }} -m pip install -v --editable '.[test]'
 
       - name: Check installable with CMake from PyPI (with venv'ed CMake)
         shell: bash

.pre-commit-config.yaml

@@ -30,15 +30,15 @@ repos:
         args: [--ignore-case]
         files: ^docs/source/spelling_wordlist\.txt$
   - repo: https://github.com/pre-commit/mirrors-clang-format
-    rev: v21.1.5
+    rev: v21.1.6
     hooks:
       - id: clang-format
   - repo: https://github.com/cpplint/cpplint
     rev: 2.0.2
     hooks:
       - id: cpplint
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.4
+    rev: v0.14.6
     hooks:
       - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix]

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-XuehaiPan@pku.edu.cn.
+[XuehaiPan@pku.edu.cn](mailto:XuehaiPan@pku.edu.cn).
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

@@ -45,7 +45,7 @@ make uninstall
 
 We use several tools to secure code quality, including:
 
-- Python code style: `black`, `isort`, `pylint`, `flake8`, `ruff`
+- Python code style: `ruff`, `isort`, `pylint`
 - Type hint check: `mypy`
 - C++ code style: `cpplint`, `clang-format`, `clang-tidy`
 - License: `addlicense`
@@ -80,7 +80,7 @@ You will need to install [`docker`](https://www.docker.com) first.
 Then run the following command:
 
 ```bash
-pip3 install --upgrade cibuildwheel
+python3 -m pip install --upgrade cibuildwheel
 
 python3 -m cibuildwheel --platform=linux --output-dir=wheelhouse --config-file=pyproject.toml
 ```

README.md

@@ -53,8 +53,7 @@ pip3 install git+https://github.com/metaopt/optree.git#egg=optree
 Or, clone this repo and install manually:
 
 ```bash
-git clone --depth=1 https://github.com/metaopt/optree.git
-cd optree
+git clone --depth=1 https://github.com/metaopt/optree.git && cd optree
 
 pip3 install .
 ```
@@ -68,6 +67,7 @@ export CMAKE_CXX_STANDARD="20"  # C++17 is tested on Linux/macOS (C++20 is requi
 export OPTREE_CXX_WERROR="OFF"
 export _GLIBCXX_USE_CXX11_ABI="1"
 export pybind11_DIR="/path/to/custom/pybind11"
+
 pip3 install .
 ```