Merge branch 'main' into fields-sorter

.github/workflows/build.yaml

@@ -0,0 +1,45 @@
+name: Build and Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      # url: https://pypi.org/p/qref 
+      url: https://test.pypi.org/p/qref
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+      - name: Install pypa/build
+        run: python -m pip install build --user
+      - name: Setup poetry
+        uses: abatilo/actions-poetry@v2
+      - name: Build the package
+        # run: poetry config pypi-token.pypi ${{ secrets.TWINE_PASSWORD  }}
+        run: poetry config pypi-token.pypi ${{ secrets.TEST_TWINE_PASSWORD  }}
+
+
+
+      - name: Publish the package
+        run: poetry publish --build
+      ## Uncomment the below after IT trusted publisher pypi request has been submitted
+      # - name: Publish package distributions to PyPI
+      #   uses: pypa/gh-action-pypi-publish@release/v1
+      - name: Build docs
+        run: mike deploy $RELEASE_VERSION  latest --update-aliases
+        env:
+          RELEASE_VERSION: ${GITHUB_REF#refs/*/} # or #{{ github.ref }}
+
+      - name: Push docs
+        run: git push origin gh-pages:gh-pages
+
+

.github/workflows/quality_checks.yaml

@@ -49,8 +49,8 @@ jobs:
       - name: Run quality checks
         run: |
           poetry install
-          pip install pre-commit
-          pre-commit install
+          pip install pre-commit 
+          pre-commit install --hook-type commit-msg
           pre-commit run -a
       - name: Run mypy
         run: MYPYPATH=src poetry run mypy --install-types --non-interactive src

.github/workflows/release.yaml

@@ -1,26 +1,21 @@
-name: Build and release
+name: Manual Trigger
 
 on:
-  release:
-    types: [published]
+  workflow_dispatch:
 
 jobs:
-  publish:
+  release-please:
     runs-on: ubuntu-latest
-    environment:
-      name: pypi
-      url: https://pypi.org/p/qref # TODO: test PyPI
-    permissions:
-      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v4
+      - name: Increment version
+        uses: googleapis/release-please-action@v4
         with:
-          python-version: 3.9
-      - name: Install pypa/build
-        run: python -m pip install build --user
-      - name: Build binary wheel and source tarball
-        run: python -m build --sdist --wheel --outdir dist/
-      - name: Publish distribution to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
+          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
+          release-type: python
+          skip-github-releases: false
+          skip-github-pull-request: true
+
+# bumps z in x.y.z if the commit message is: "fix: blah blah blah" (patch)
+# bumps y in x.y.z if the commit message is: "feature: blah blah blah" (minor)
+# bumps x in x.y.z if the commit message is "fix! or feature!: blah blah blah" (major)

.pre-commit-config.yaml

@@ -34,3 +34,10 @@ repos:
     rev: 6.0.0
     hooks:
       - id: flake8
+
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v3.2.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: []