Release OpenPNM v3.2.0 #minor

.github/release.yml

@@ -0,0 +1,34 @@
+# .github/release.yml
+
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+    authors:
+      - octocat
+  categories:
+    - title: Breaking Changes ⚠️
+      labels:
+        - Semver-Major
+        - breaking-change
+        - api
+    - title: New Features 🎉
+      labels:
+        - Semver-Minor
+        - enhancement
+        - new
+    - title: Maintenance 🛠
+      labels:
+        - Semver-Patch
+        - maint
+    - title: Documentation 📗
+      labels:
+        - doc
+        - example
+    - title: Big Fixes 🐛
+      labels:
+        - Semver-Patch
+        - bug
+    - title: Other Changes ❓
+      labels:
+        - "*"

.github/workflows/bump-version-dev.yml

@@ -16,9 +16,9 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
-        python-version: 3.9
+        python-version: '3.9'
 
     - name: Set env variables
       run: |

.github/workflows/bump-version.yml

@@ -11,15 +11,15 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         persist-credentials: false  # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
         fetch-depth: 0              # otherwise, you will failed to push refs to dest repo
 
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
-        python-version: 3.8
+        python-version: '3.9'
 
     - name: Set env variables
       run: |
@@ -77,7 +77,7 @@ jobs:
       with:
         source_branch: "release"                          # If blank, default: triggered branch
         destination_branch: "dev"                         # If blank, default: master
-        pr_title: "Don't forget to merge release back into dev!"
+        pr_title: "Merge release branch back into dev"
         pr_body: "Changes made to the release branch (e.g. hotfixes), plus the version bump."
         pr_assignee: "jgostick,ma-sadeghi"                # Comma-separated list (no spaces)
         pr_label: "high priority"                         # Comma-separated list (no spaces)

.github/workflows/cleanup-tags.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Clean up tags
       run: |

.github/workflows/examples.yml

@@ -13,21 +13,21 @@ jobs:
     strategy:
       max-parallel: 1
       matrix:
-        python-version: [3.8]
+        python-version: ['3.9']
         os: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Cache pip
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('setup.py') }}
           restore-keys: |
             ${{ runner.os }}-pip-
 

.github/workflows/gh-pages.yml

@@ -13,31 +13,29 @@ jobs:
     defaults:
       run:
         shell: bash -l {0}
-
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - name: Set up Python 3.8
-        uses: actions/setup-python@v1
+      - name: Set up Python
+        uses: actions/setup-python@v4
         with:
-          python-version: 3.8
+          python-version: '3.10'
 
-      - name: Set up Mamba
-        uses: conda-incubator/setup-miniconda@v2
+      - name: Cache pip
+        uses: actions/cache@v3
         with:
-          mamba-version: "*"
-          miniforge-variant: Mambaforge
-          allow-softlinks: true
-          use-only-tar-bz2: true
-          show-channel-urls: false
-          auto-activate-base: true
-          channel-priority: strict
-          python-version: 3.8
+          # This path is specific to Ubuntu
+          path: ~/.cache/pip
+          # Look to see if there is a cache hit for the corresponding requirements file
+          key: ${{ runner.os }}-pip-${{ hashFiles('setup.py') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+            ${{ runner.os }}-
 
       - name: Install dependencies
         run: |
-          mamba install --file requirements/docs.txt
           pip install -r requirements.txt
+          pip install -r requirements/docs.txt
 
       - name: Build the documentation
         run: |

.github/workflows/logger.sh

@@ -48,6 +48,12 @@ function filter_commits_by_tag_interval {
     temp=$(git log --merges "${1}..${2}" --format=%B)
     # Remove those merge commits for updating feature branches
     temp=$(echo "${temp}" | grep -v -E "Merge branch")
+    # Remove default merge commit messages
+    temp=$(echo "${temp}" | grep -v -E "Merge pull request")
+    # Remove merge backs from release to dev (which is done after every release)
+    temp=$(echo "${temp}" | grep -v -E "back into dev")
+    # Find lines that start with "# " and replace them with ""
+    temp=$(echo "${temp}" | sed -r 's/^# //')
     echo "$temp"
 }
 

.github/workflows/nightly.yml

@@ -16,7 +16,7 @@ jobs:
       fail-fast: false
       max-parallel: 9
       matrix:
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.9', '3.10', '3.11']
         # Add macos-latest to the next line once #2451 is fixed
         os: [ubuntu-latest, windows-latest, macos-latest]
         include:
@@ -29,21 +29,21 @@ jobs:
 
     steps:
       - name: Cache pip
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ${{ matrix.path }}
           key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Install dependencies (pip)
+      - name: Install dependencies
         run: |
           pip install \
             -r requirements.txt \

.github/workflows/publish-to-pypi.yml

@@ -11,14 +11,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         ref: release  # the production branch name (for proper version #)
 
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
-        python-version: 3.8
+        python-version: '3.9'
 
     - name: Set env variables
       run: |
@@ -49,15 +49,15 @@ jobs:
 
     - name: Publish distribution 📦 to PyPI
       if: startsWith(github.event.ref, 'refs/tags') && contains(env.TAG_MISMATCH, 'false')
-      uses: pypa/gh-action-pypi-publish@master
+      uses: pypa/gh-action-pypi-publish@release/v1
       with:
         user: __token__
         password: ${{ secrets.PYPI_TOKEN }}
-        skip_existing: true
+        skip-existing: true
 
     # - name: Publish distribution 📦 to TestPyPI
     #   if: startsWith(github.event.ref, 'refs/tags') && contains(env.TAG_MISMATCH, 'false')
-    #   uses: pypa/gh-action-pypi-publish@master
+    #   uses: pypa/gh-action-pypi-publish@release/v1
     #   with:
     #     user: __token__
     #     password: ${{ secrets.TESTPYPI_TOKEN }}

.github/workflows/style-check.yml

@@ -12,7 +12,7 @@ jobs:
       - name: Set up Python environment
         uses: actions/setup-python@v2
         with:
-          python-version: "3.10"
+          python-version: '3.10'
       - name: flake8 Lint
         uses: py-actions/flake8@v2
         with:

.github/workflows/tests.yml

@@ -14,7 +14,7 @@ jobs:
       fail-fast: false
       max-parallel: 9
       matrix:
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.9', '3.10', '3.11']
         # Add macos-latest to the next line once #2451 is fixed
         os: [ubuntu-latest, windows-latest, macos-latest]
         include:
@@ -27,28 +27,28 @@ jobs:
 
     steps:
       - name: Cache pip
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ${{ matrix.path }}
-          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('setup.py') }}
           restore-keys: |
             ${{ runner.os }}-pip-
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Install dependencies (pip)
+      - name: Install dependencies
         run: |
           pip install \
             -r requirements.txt \
             -r requirements/tests.txt
 
       - name: Disable numba JIT for codecov to include jitted methods
-        if: (matrix.python-version == 3.8) && (matrix.os == 'ubuntu-latest')
+        if: (matrix.python-version == 3.9) && (matrix.os == 'ubuntu-latest')
         run: |
           echo "NUMBA_DISABLE_JIT=1" >> $GITHUB_ENV
 
@@ -61,7 +61,7 @@ jobs:
 
       - name: Upload coverage to Codecov
         if: (matrix.python-version == 3.9) && (matrix.os == 'ubuntu-latest')
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           file: ./coverage.xml

.github/workflows/verify-pip-installation.yml

@@ -8,11 +8,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
-        python-version: 3.8
+        python-version: '3.9'
 
     - name: Set branch name as env variable
       run: |

docs/_examples/index.rst

@@ -11,6 +11,7 @@ The examples are categorized into the following categories:
 .. toctree::
    :maxdepth: 2
 
+   ../examples/getting_started
    tutorials
    applications
    reference