Merge pull request #18 from spraakbanken/extend-ci

Extend ci

.github/DOCS.md

@@ -0,0 +1,27 @@
+# Github config and workflows
+
+In this folder there is configuration for codecoverage, dependabot and ci workflows.
+
+This folder can be merged using a `--allow-unrelated-histories` merge strategy from <https://github.com/spraakbanken/python-pdm-ci-conf> which provides a reasonably sensible base for writing your own ci on. By using this strategy the history of the CI repo is included in your repo, and future updates to the CI can be merged later.
+
+The workflows in this folder requires a root Makefile with a couple of targets defined.
+As base can the Makefile in <https://github.com/spraakbanken/python-pdm-make-conf> be used.
+
+To perform this merge run:
+
+```shell
+git remote add ci [email protected]:spraakbanken/python-pdm-ci-conf.git
+git fetch ci
+git merge --allow-unrelated-histories ci/main
+```
+
+or add the remote as `git remote add ci https://github.com/spraakbanken/python-pdm-ci-conf.git`
+
+To later merge updates to this repo, just run:
+
+```shell
+git fetch ci
+get merge ci/main
+```
+
+This setup is inspired by <https://github.com/jonhoo/rust-ci-conf>.

.github/codecov.yml

@@ -0,0 +1,21 @@
+# ref: https://docs.codecov.com/docs/codecovyml-reference
+coverage:
+  # Hold ourselves to a high bar
+  range: 85..100
+  round: down
+  precision: 1
+  status:
+    # ref: https://docs.codecov.com/docs/commit-status
+    project:
+      default:
+        # Avoid false negatives
+        threshold: 1%
+
+# Test files aren't important for coverage
+ignore:
+  - "tests"
+
+# Make comments less noisy
+comment:
+  layout: "files"
+  require_changes: true

.github/dependabot.yml

@@ -5,12 +5,21 @@
 
 version: 2
 updates:
-  - package-ecosystem: "pip" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "weekly"
   # Maintain dependencies for GitHub Actions
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "weekly"
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"
+    ignore:
+      - dependency-name: "*"
+        # patch and minor updates don't matter for libraries as consumers of this library build
+        # with their own lockfile, rather than the version specified in this library's lockfile
+        # remove this ignore rule if your package has binaries to ensure that the binaries are
+        # built with the exact set of dependencies and those are up to date.
+        update-types:
+          - "version-update:semver-patch"
+          - "version-update:semver-minor"

.github/workflows/check.yml

@@ -0,0 +1,105 @@
+name: check
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  merge_group:
+
+permissions:
+  contents: read
+
+env:
+  MINIMUM_PYTHON_VERSION: "3.9"
+
+# If new code is pushed to a PR branch, then cancel in progress workflows for that PR. Ensures that
+# we don't waste CI time, and returns results quicker https://github.com/jonhoo/rust-ci-conf/pull/5
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  fmt:
+    runs-on: ubuntu-latest
+    name: ubuntu / fmt
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up the python ${{ env.MINIMUM_PYTHON_VERSION }}
+        uses: pdm-project/setup-pdm@v4
+        id: setup-python
+        with:
+          python-version: ${{ env.MINIMUM_PYTHON_VERSION }}
+
+      - name: Load cached venv
+        id: cached-venv
+        uses: actions/cache@v4
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/pyproject.toml') }}-${{ hashFiles('.github/workflows/check.yml') }}
+
+      - name: Install dependencies
+        if: steps.cached-venv.outputs.cache-hit != 'true'
+        run: make install-dev
+
+      - name: check formatting
+        run: make check-fmt
+  lint:
+    runs-on: ubuntu-latest
+    name: ubuntu / lint
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up the python ${{ env.MINIMUM_PYTHON_VERSION }}
+        uses: pdm-project/setup-pdm@v4
+        id: setup-python
+        with:
+          python-version: ${{ env.MINIMUM_PYTHON_VERSION }}
+      - name: Load cached venv
+        id: cached-venv
+        uses: actions/cache@v4
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/pyproject.toml') }}-${{ hashFiles('.github/workflows/check.yml') }}
+      - name: Install dependencies
+        if: steps.cached-venv.outputs.cache-hit != 'true'
+        run: make install-dev
+      - name: lint code
+        run: make lint
+  type-check:
+    runs-on: ubuntu-latest
+    name: ubuntu / type-check
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up the python ${{ env.MINIMUM_PYTHON_VERSION }}
+        uses: pdm-project/setup-pdm@v4
+        id: setup-python
+        with:
+          python-version: ${{ env.MINIMUM_PYTHON_VERSION }}
+      - name: Load cached venv
+        id: cached-venv
+        uses: actions/cache@v4
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/pyproject.toml') }}-${{ hashFiles('.github/workflows/check.yml') }}
+      - name: Install dependencies
+        if: steps.cached-venv.outputs.cache-hit != 'true'
+        run: make install-dev
+      - name: type-check code
+        run: make lint
+
+  # https://github.com/marketplace/actions/alls-green#why used for branch protection checks
+  check-check:
+    if: always()
+    needs: 
+      - fmt
+      - lint
+      - type-check
+    runs-on: ubuntu-latest
+    permissions: {}
+    steps:
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}
+          allowed-failures: upload-coverage

.github/workflows/scheduled.yml

@@ -0,0 +1,70 @@
+# Run scheduled (rolling) jobs on a nightly basis, as your crate may break independently of any
+# given PR. E.g., updates to rust nightly and updates to this crates dependencies. See check.yml for
+# information about how the concurrency cancellation and workflow triggering works
+permissions:
+  contents: read
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  schedule:
+    - cron:  '7 7 * * *'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+name: rolling
+
+jobs:
+  # https://twitter.com/mycoliza/status/1571295690063753218
+  nightly:
+    runs-on: ubuntu-latest
+    name: ubuntu / 3.13-dev
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install pdm
+        uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: "3.11"
+      - name: Install python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13-dev"
+      - run: python --version
+      - name: pdm lock
+        if: hashFiles('pdm.lock') == ''
+        run: pdm lock
+      - name: pdm sync --dev
+        run: pdm sync --dev
+      - name: make test
+        run: make test
+  # https://twitter.com/alcuadrado/status/1571291687837732873
+  update:
+    # This action checks that updating the dependencies of this crate to the latest available that
+    # satisfy the versions in Cargo.toml does not break this crate. This is important as consumers
+    # of this crate will generally use the latest available crates. This is subject to the standard
+    # Cargo semver rules (i.e cargo does not update to a new major version unless explicitly told
+    # to).
+    runs-on: ubuntu-latest
+    name: ubuntu / 3.12 / updated
+    # There's no point running this if no Cargo.lock was checked in in the first place, since we'd
+    # just redo what happened in the regular test job. Unfortunately, hashFiles only works in if on
+    # steps, so we repeat it.
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install 3.12
+        if: hashFiles('pdm.lock') != ''
+        uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: "3.12"
+      - name: pdm update
+        if: hashFiles('pdm.lock') != ''
+        run: pdm update
+      - name: pdm sync --dev
+        if: hashFiles('pdm.lock') != ''
+        run: pdm sync --dev
+      - name: make test
+        if: hashFiles('pdm.lock') != ''
+        run: make test