Action_updates (#24)

* Update deps, add action and yml linting

* Standardise format

* bump version

* Add cff manager actions

* Update deps and format

* Use official astral ruff action

* add typechecking mode standard

* add example data path

* Fix py310 and py311 f-string escape sequence issues

Author: Adamtaranto

.github/workflows/cff-validator.yml

@@ -0,0 +1,17 @@
+name: CITATION.cff Validator
+on:
+  push:
+    paths:
+      - CITATION.cff
+  workflow_dispatch:
+jobs:
+  Validate-CITATION-cff:
+    runs-on: ubuntu-latest
+    name: Validate CITATION.cff
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+      - name: Validate CITATION.cff
+        uses: dieghernan/cff-validator@v4

.github/workflows/publish.yml

@@ -1,35 +1,27 @@
 name: Publish to PyPI
-
 on:
   release:
     types:
       - published
-
 jobs:
   publish:
     runs-on: ubuntu-latest
-
     permissions:
       contents: read
       packages: write
-
     steps:
-    - name: Check out the code
-      uses: actions/checkout@v3
-
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.x'
-
-    - name: Install Hatch
-      run: pip install hatch
-
-    - name: Build the package with Hatch
-      run: hatch build
-
-    - name: Publish to PyPI
-      env:
-        HATCH_INDEX_USER: __token__
-        HATCH_INDEX_AUTH: ${{ secrets.FLEXIDOT_PYPI_TOKEN }}
-      run: hatch publish
+      - name: Check out the code
+        uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.x'
+      - name: Install Hatch
+        run: pip install hatch
+      - name: Build the package with Hatch
+        run: hatch build
+      - name: Publish to PyPI
+        env:
+          HATCH_INDEX_USER: __token__
+          HATCH_INDEX_AUTH: ${{ secrets.FLEXIDOT_PYPI_TOKEN }}
+        run: hatch publish

.github/workflows/pytest.yml

@@ -1,35 +1,27 @@
 name: Python Tests
-
 on: [pull_request]
-
 jobs:
   test:
     runs-on: ubuntu-latest
-
     strategy:
       matrix:
         python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
-
     steps:
       # Checkout the latest commit associated with the PR
-      - uses: actions/checkout@v4
-
+      - uses: actions/checkout@v5
       - name: Debug matrix value
         run: echo "Python version is ${{ matrix.python-version }}"
-
       # Set up Miniconda
       - name: Set up Miniconda
-        uses: conda-incubator/setup-miniconda@v2
+        uses: conda-incubator/setup-miniconda@v3
         with:
-          auto-update-conda: true  # Optional: update Conda to the latest version
+          auto-update-conda: true # Optional: update Conda to the latest version
           python-version: ${{ matrix.python-version }}
-
       # Install any additional dependencies not included in the pyproject.toml file
       - name: Install additional dependencies
         run: |
           pip install '.[tests]'  # Install all dependencies, including test-specific ones
         shell: bash -l {0}
-
       # Run pytest on the specified directory
       - name: Run tests
         run: |

.github/workflows/ruff.yml

@@ -9,23 +9,23 @@ jobs:
       contents: write # Allows reading and writing repository contents (e.g., commits)
       pull-requests: write # Allows reading and writing pull requests
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           ref: ${{ github.sha }}
           token: ${{ secrets.GITHUB_TOKEN }}
-      - uses: chartboost/ruff-action@v1
+      - uses: astral-sh/ruff-action@v3
         with:
-          src: './src/flexidot ./tests'
-          args: 'format'
-      - uses: chartboost/ruff-action@v1
+          src: "./src ./tests"
+          args: "format"
+      - uses: astral-sh/ruff-action@v3
         with:
-          src: './src/flexidot ./tests'
-          args: 'check'
+          src: "./src ./tests"
+          args: "check --fix"
       - uses: isort/isort-action@v1
         with:
           configuration: "--settings-path=./pyproject.toml"
-          paths: "./src/flexidot ./tests"
-      - uses: stefanzweifel/git-auto-commit-action@v5
+          paths: "./src ./tests"
+      - uses: stefanzweifel/git-auto-commit-action@v7
         id: auto-commit-action
         with:
-          commit_message: 'Style fixes by Ruff'
+          commit_message: "Style fixes by Ruff"

.github/workflows/update-citation-cff.yml

@@ -0,0 +1,23 @@
+name: Update CITATION.cff on Tag
+on:
+  push:
+    tags:
+      # Match semantic version tags: v1.0.0, v1.2.3, v2.0.0-beta, etc.
+      # Excludes moving tags: v1, v2
+      - "v[0-9]+.[0-9]+.[0-9]+*"
+permissions:
+  contents: write
+  pull-requests: write
+jobs:
+  update-citation:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - uses: Adamtaranto/citation-sync-action@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          # Create PR instead of pushing to main
+          use-pull-request: true
+          update-mode: "match"

.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: check-toml
       - id: check-yaml
@@ -20,14 +20,21 @@ repos:
       - id: end-of-file-fixer
       - id: name-tests-test
         args: [--pytest-test-first]
-
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.4
+    rev: v0.14.4
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix, --show-fixes, --config=pyproject.toml]
       - id: ruff-format
         args: [--config=pyproject.toml]
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.8
+    hooks:
+      - id: actionlint
+  - repo: https://github.com/google/yamlfmt
+    rev: v0.20.0
+    hooks:
+      - id: yamlfmt
 
 ## Activate this after adding docstrings to all functions
 #  - repo: https://github.com/numpy/numpydoc

.vscode/settings.json

@@ -5,5 +5,6 @@
         "tests"
     ],
     "python.testing.unittestEnabled": false,
-    "python.testing.pytestEnabled": true
+    "python.testing.pytestEnabled": true,
+    "python.analysis.typeCheckingMode": "standard"
 }