split release CI

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,4 @@
-<!--- Thank you for submitting a Pull Request! In order to make our work smoother, please make sure your Pull Request meets the following requirements: 1. Provide a general summary of your changes in the Title above; 2. Add appropriate prefixes to titles, such as `build:`, `chore:`, `ci:`, `deps:`, `doc:`, `docs:`, `feat:`, `fix:`, `perf:`, `ref:`, `refactor:`, `revert:`, `style:`, `test:`, `tests:`. -->
+<!--- Thank you for submitting a Pull Request! In order to make our work smoother, please make sure your Pull Request meets the following requirements: 1. Provide a general summary of your changes in the Title above; 2. Add appropriate prefixes to titles, such as `build:`, `chore:`, `ci:`, `docs:`, `feat:`, `fix:`, `perf:`, `refactor:`, `revert:`, `style:`, `test:`(Ref: https://www.conventionalcommits.org/). -->
 
 ## Description
 <!--- Describe your changes in detail -->

.github/workflows/ci.yml

@@ -0,0 +1,70 @@
+concurrency:
+  cancel-in-progress: true
+  group: ${{ github.workflow }}-${{ github.ref }}
+jobs:
+  ci:
+    if: ${{ !cancelled() && ! failure() }}
+    needs: dependabot
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: recursive
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          cache: pip
+          python-version: ${{ matrix.python-version }}
+      - run: env | sort
+      - run: make dev
+      - name: lint test docs and build
+        run: make lint docs-gen # test docs build
+    strategy:
+      matrix:
+        python-version:
+          - '3.10'
+          - '3.11'
+  dependabot:
+    if: ${{ github.actor == 'dependabot[bot]' && startsWith(github.head_ref, 'dependabot/pip/') }}
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.head_ref }}
+      - name: Set up Git
+        run: |
+          git config --global user.name github-actions
+          git config --global user.email [email protected]
+      - name: Set up Python with multiple versions.
+        uses: actions/setup-python@v5
+        with:
+          cache: pip
+          python-version: |
+            3.10
+            3.11
+      - name: Install pipenv using pipx
+        run: pipx install pipenv
+      - name: Generate constraints for all supported Python versions
+        run: |
+          CI= PYTHON_VERSION=3.10 make constraints
+          CI= PYTHON_VERSION=3.11 make constraints
+      - name: Push changes if applicable
+        run: |
+          if [[ -n `git status --porcelain` ]]; then
+            git commit -a -m "build: Update constraints for dependabot."
+            git push
+          fi
+name: CI
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+  push:
+    branches:
+      - main

.github/workflows/pr.yml

@@ -7,7 +7,7 @@ jobs:
     steps:
       - name: Check PR Title for Conventional Commit Format
         run: |
-          if ! echo "${{ github.event.pull_request.title }}" | grep -Pq '^(build|chore|ci|deps|doc|docs|feat|fix|perf|ref|refactor|revert|style|test|tests|Bump version)(\(\w+\))?!?:\s.*'; then
+          if ! echo "${{ github.event.pull_request.title }}" | grep -Pq '^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\(\w+\))?!?:\s.*'; then
             echo 'The title does not conform to the Conventional Commit.'
             echo 'Please refer to "https://www.conventionalcommits.org/"'
             exit 1

.github/workflows/release.yml

@@ -31,23 +31,7 @@ jobs:
       - name: Release please
         uses: googleapis/release-please-action@v4
         with:
+          # The current PAT (personal access token) was created on 2024-08-05,
+          # since the maximum validity of PAT is 1 year, you need to change the PAT before 2025-08-05.
           token: ${{ secrets.PAT }}
           release-type: simple
-  # package:
-  #   needs: release
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: actions/checkout@v4
-  #     - name: Set up Python
-  #       uses: actions/setup-python@v5
-  #       with:
-  #         cache: pip
-  #         python-version: '3.10'
-  #     - run: env | sort
-  #     - run: make dev
-  #     - run: make build
-  #     - env:
-  #         TWINE_USERNAME: __token__
-  #         TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
-  #       run: |
-  #         make upload

.github/workflows/upload.yml

@@ -0,0 +1,27 @@
+name: Package and upload to pypi
+on:
+  pull_request:
+    types:
+      - closed
+jobs:
+  # package:
+  #   if: |
+  #     github.event.pull_request.merged == true &&
+  #     startsWith(github.event.pull_request.title, 'chore(main): release')
+  #   needs: release
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #     - name: Set up Python
+  #       uses: actions/setup-python@v5
+  #       with:
+  #         cache: pip
+  #         python-version: '3.10'
+  #     - run: env | sort
+  #     - run: make dev
+  #     - run: make build
+  #     - env:
+  #         TWINE_USERNAME: __token__
+  #         TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+  #       run: |
+  #         make upload

pyproject.toml

@@ -3,6 +3,7 @@ build-backend = "setuptools.build_meta"
 requires = [
   "setuptools",
   "setuptools-scm",
+  "wheel",
 ]
 
 [project]
@@ -108,6 +109,8 @@ package = {file = ["requirements/package.txt"]}
 test = {file = ["requirements/test.txt"]}
 
 [tool.setuptools_scm]
+version_scheme = "post-release"
+local_scheme = "no-local-version"
 
 [tool.tomlsort]
 all = true

requirements/package.txt

@@ -2,3 +2,4 @@
 build
 setuptools-scm
 twine
+wheel