Minor release: v3.6.0

.github/workflows/bump-version.yml

@@ -1,113 +1,52 @@
-name: Bump Version (release)
+name: Bump Version
 
 on:
   push:
-    branches:
-      - release
+    branches: [dev, release]
 
 jobs:
-  build:
-    name: Bump version
+  bump:
+    if: ${{ !contains(github.event.head_commit.message, '[skip bump]') }}
     runs-on: ubuntu-latest
 
     steps:
-    - 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@v4
-      with:
-        python-version: '3.9'
-
-    - name: Set env variables
-      run: |
-        # The next line is very important, otherwise the line after triggers
-        # git to track the permission change, which breaks bump2version API (needs clean git folder)
-        git config core.filemode false
-        chmod +x .github/workflows/utils.sh
-        echo "VERSION_FILE=openpnm/__version__.py" >> $GITHUB_ENV
-        echo "SETUP_CFG_FILE=setup.cfg" >> $GITHUB_ENV
-        echo "${{ github.event.head_commit.message }}"
-
-    - name: Install dependencies
-      run: |
-        pip install bump2version
-
-    - name: Bump version (patch)
-      if: contains(github.event.head_commit.message, '#patch')
-      run: |
-        source .github/workflows/utils.sh
-        bump_version patch $VERSION_FILE
-        echo "TAG_NEW=v$(get_version $VERSION_FILE)" >> $GITHUB_ENV
-
-    - name: Bump version (minor)
-      if: contains(github.event.head_commit.message, '#minor')
-      run: |
-        source .github/workflows/utils.sh
-        bump_version minor $VERSION_FILE
-        echo "TAG_NEW=v$(get_version $VERSION_FILE)" >> $GITHUB_ENV
-
-    - name: Bump version (major)
-      if: contains(github.event.head_commit.message, '#major')
-      run: |
-        source .github/workflows/utils.sh
-        bump_version major $VERSION_FILE
-        echo "TAG_NEW=v$(get_version $VERSION_FILE)" >> $GITHUB_ENV
-
-    - name: Strip .dev0 suffix from version file
-      if:
-        contains(github.event.head_commit.message, '#patch') ||
-        contains(github.event.head_commit.message, '#minor') ||
-        contains(github.event.head_commit.message, '#major')
-      run: |
-        # Remove .dev0 suffix from the version file for releases
-        sed -i "s/\.dev0'/'/g" $VERSION_FILE
-        echo "Release version: $(cat $VERSION_FILE)"
-
-    - name: Commit files
-      if:
-        contains(github.event.head_commit.message, '#patch') ||
-        contains(github.event.head_commit.message, '#minor') ||
-        contains(github.event.head_commit.message, '#major')
-      run: |
-        REPOSITORY=${INPUT_REPOSITORY:-$GITHUB_REPOSITORY}
-        remote_repo="https://${GITHUB_ACTOR}:${{ secrets.PUSH_ACTION_TOKEN }}@github.com/${REPOSITORY}.git"
-
-        git config --local user.email "action@github.com"
-        git config --local user.name "GitHub Action"
-
-        # Commit version bump to release
-        git commit -m "Bump version number" -a
-        git push "${remote_repo}" release
-
-    - name: Create Pull Request to merge back release into dev
-      uses: repo-sync/pull-request@v2
-      with:
-        source_branch: "release"                          # If blank, default: triggered branch
-        destination_branch: "dev"                         # If blank, default: master
-        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)
-        pr_draft: false                                   # Creates pull request as draft
-        pr_allow_empty: true                              # Creates pull request even if there are no changes
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: Trim the 4th digit from the tag
-      run:
-        echo "TAG_NEW=${TAG_NEW%.dev?}" >> $GITHUB_ENV
-
-    - name: Create new tag
-      run: |
-        REPOSITORY=${INPUT_REPOSITORY:-$GITHUB_REPOSITORY}
-        remote_repo="https://${GITHUB_ACTOR}:${{ secrets.PUSH_ACTION_TOKEN }}@github.com/${REPOSITORY}.git"
-        if [ -z "$TAG_NEW" ]
-        then
-            echo "New tag not created."
-        else
-            git tag $TAG_NEW
-            git push "${remote_repo}" $TAG_NEW
-            echo "Pushed a new tag: $TAG_NEW"
-        fi
+      - uses: actions/checkout@v6
+        with:
+          token: ${{ secrets.PAT }}
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@v7
+        with:
+          python-version: "3.12"
+          enable-cache: false
+
+      - name: Configure Git
+        run: |
+          git config user.name "GitHub Action"
+          git config user.email "action@github.com"
+
+      - name: Bump version (dev)
+        if: github.ref == 'refs/heads/dev'
+        run: |
+          uvx bump-my-version bump pre_n --no-tag
+          git push
+
+      - name: Bump version (release)
+        if: github.ref == 'refs/heads/release'
+        run: |
+          if [[ "${{ github.event.head_commit.message }}" == *"#patch"* ]]; then
+            uvx bump-my-version bump patch
+          elif [[ "${{ github.event.head_commit.message }}" == *"#minor"* ]]; then
+            uvx bump-my-version bump minor
+          elif [[ "${{ github.event.head_commit.message }}" == *"#major"* ]]; then
+            uvx bump-my-version bump major
+          fi
+          git push --follow-tags
+
+      - name: Merge release back into dev
+        if: github.ref == 'refs/heads/release'
+        run: |
+          git fetch origin dev
+          git checkout dev
+          git merge --no-ff origin/release -m "maint: merge release into dev [skip bump]"
+          git push origin dev

.github/workflows/generate-docs.yml

@@ -0,0 +1,42 @@
+name: Deploy Documentation
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - release
+
+jobs:
+  deploy-docs:
+
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          cache-dependency-glob: "**/pyproject.toml"
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          uv sync --group docs --group interactive
+
+      - name: Build the documentation
+        run: |
+          cd docs
+          uv run make html
+
+      - name: Publish the documentation to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_build/html
+          cname: openpnm.org

.github/workflows/generate-release-notes.yml

@@ -0,0 +1,37 @@
+name: Release Notes
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    name: Release notes
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Generate changelog
+        id: changelog
+        run: |
+          git fetch --all --tags --force
+          chmod +x .github/workflows/logger.sh
+          chmod +x .github/workflows/utils.sh
+          source .github/workflows/utils.sh
+          bash .github/workflows/logger.sh
+          echo "TAG=$(get_most_recent_tag)" >> $GITHUB_OUTPUT
+
+      - name: Create GitHub release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create "${{ steps.changelog.outputs.TAG }}" \
+            --title "${{ steps.changelog.outputs.TAG }}" \
+            --notes-file CHANGELOG.md \
+            --draft