license & doc & ci improvements (Smirkey#5)

.github/workflows/CI.yml → .github/workflows/cd.yml

@@ -1,34 +1,20 @@
-# This file is autogenerated by maturin v1.2.3
-# To update, run
-#
-#    maturin generate-ci github
-#
-name: CI
+name: cd
 
 on:
-  push:
-    branches:
-      - main
-      - master
-    tags:
-      - '*'
-  pull_request:
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
+  tags: "*"
+
 jobs:
   linux:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        target: [x86_64, x86, aarch64, armv7, s390x, ppc64le]
+        target: [x86_64, x86]
+        python: ["3.8", "3.9", "3.10", "3.11", "3.12"]
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: ${{ matrix.python }}
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:
@@ -47,12 +33,12 @@ jobs:
     strategy:
       matrix:
         target: [x64, x86]
+        python: ["3.8", "3.9", "3.10", "3.11", "3.12"]
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
-          architecture: ${{ matrix.target }}
+          python-version: ${{ matrix.python }}
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:
@@ -70,11 +56,12 @@ jobs:
     strategy:
       matrix:
         target: [x86_64, aarch64]
+        python: ["3.8", "3.9", "3.10", "3.11", "3.12"]
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: ${{ matrix.python }}
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:
@@ -105,7 +92,6 @@ jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
-    if: "startsWith(github.ref, 'refs/tags/')"
     needs: [linux, windows, macos, sdist]
     steps:
       - uses: actions/download-artifact@v3

.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: ci
+
+on:
+  pull_request:
+    types:
+    - opened
+    - synchronize
+    - reopened
+    - closed
+    branches:
+    - main
+concurrency:
+  group: ${{ github.workflow }}/${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  rust-tests:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+        override: true
+    - name: Check
+      run: cargo check --no-default-features
+    - name: Build
+      run: cargo build --verbose
+    - name: Run tests
+      run: cargo test --verbose
+    - name: Check formatting
+      run: cargo fmt -- --check
+    - name: code-coverage
+      env:
+        TOKEN: ${{secrets.CODECOV_TOKEN}}
+      run: |
+        cargo install cargo-tarpaulin --force --git https://github.com/xd009642/tarpaulin --branch develop
+        cargo tarpaulin --out xml
+        bash <(curl -s https://codecov.io/bash)
+

.github/workflows/codespeed.yml

@@ -1,13 +1,17 @@
 name: codspeed-benchmarks
 
 on:
-  push:
-    branches:
-      - "main"
   pull_request:
-  # `workflow_dispatch` allows CodSpeed to trigger backtest
-  # performance analysis in order to generate initial data.
-  workflow_dispatch:
+    types:
+    - opened
+    - synchronize
+    - reopened
+    - closed
+    branches:
+    - main
+concurrency:
+  group: ${{ github.workflow }}/${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
 
 jobs:
   benchmarks: