Renovate updates and config templates (#301)

* chore(deps): update tschm/.config-templates action to v0.1.19

* chore(deps): lock file maintenance

* chore: sync config files from .config-templates

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: tschm <[email protected]>

Author: tschm

.github/CONTRIBUTING.md

@@ -4,7 +4,7 @@ This file is part of the tschm/.config-templates repository.
 
 This document is a guide to contributing to the project.
 
-We welcome all contributions. You don't need to be an expert (in optimization)
+We welcome all contributions. You don't need to be an expert
 to help out.
 
 ## Checklist
@@ -13,10 +13,10 @@ Contributions are made through
 [pull requests](https://help.github.com/articles/using-pull-requests/).
 Before sending a pull request, make sure you do the following:
 
-- Run 'make fmt' to make sure your code adheres to our [coding style](#code-style).
-  This step also includes our license on top of your new files.
-- [Write unit tests](#writing-unit-tests)
-- Run the [unit tests](#running-unit-tests) and check that they're passing
+- Run 'make check' to make sure your code adheres to our [coding style](#code-style)
+and all tests pass.
+- [Write unit tests](#writing-unit-tests) for new functionality added.
+
 
 ## Building from source
 
@@ -58,10 +58,6 @@ following:
 - Browse the open issues,
   and look for the issues tagged "help wanted".
 
-## License
-
-A license is added to new files automatically as a pre-commit hook.
-
 ## Code style
 
 We use black and ruff to enforce our Python coding style.

.github/workflows/book.yml

@@ -20,8 +20,9 @@ name: "BOOK"
 on:
   push:
     branches:
+      # please use either main or master as your default branch
       - main
-
+      - master
 
 jobs:
   parse-env:
@@ -68,9 +69,11 @@ jobs:
       contents: read
     steps:
       - name: "Build the virtual environment for ${{ github.repository }}"
+        if: hashFiles('pyproject.toml') != ''
         uses: tschm/cradle/actions/[email protected]
 
       - uses: tschm/cradle/actions/[email protected]
+        if: hashFiles('pyproject.toml') != ''
         with:
           source-folder: ${{ needs.parse-env.outputs.source-folder }}
 
@@ -82,9 +85,11 @@ jobs:
       contents: read
     steps:
       - name: "Build the virtual environment for ${{ github.repository }}"
+        if: hashFiles('pyproject.toml') != ''
         uses: tschm/cradle/actions/[email protected]
 
       - uses: tschm/cradle/actions/[email protected]
+        if: hashFiles('pyproject.toml') != ''
         with:
           tests-folder: ${{ needs.parse-env.outputs.tests-folder }}
           source-folder: ${{ needs.parse-env.outputs.source-folder }}
@@ -103,6 +108,7 @@ jobs:
 
     steps:
       - uses: tschm/cradle/actions/[email protected]
+        if: hashFiles('pyproject.toml') != ''
         with:
           title: ${{ needs.parse-env.outputs.title }}
           links: |
@@ -112,3 +118,12 @@ jobs:
               "Test Report": "./tests/html-report/report.html",
               "Notebooks": "./marimushka/index.html"
             }
+
+      - uses: tschm/cradle/actions/[email protected]
+        if: hashFiles('pyproject.toml') == ''
+        with:
+          title: ${{ needs.parse-env.outputs.title }}
+          links: |
+            {
+              "Notebooks": "./marimushka/index.html"
+            }

.github/workflows/ci.yml

@@ -34,10 +34,12 @@ jobs:
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       - name: "Build the virtual environment for ${{ github.repository }}"
+        if: hashFiles('pyproject.toml') != ''
         uses: tschm/cradle/actions/[email protected]
         with:
           python-version: ${{ matrix.python-version }}
 
       - uses: tschm/cradle/actions/[email protected]
+        if: hashFiles('pyproject.toml') != ''
         with:
           tests-folder: src/tests

.github/workflows/deptry.yml

@@ -45,6 +45,7 @@ jobs:
 
     steps:
       - name: Run deptry
+        if: hashFiles('pyproject.toml') != ''
         uses: tschm/cradle/actions/[email protected]
         with:
           source-folder: ${{ needs.parse-env.outputs.source-folder }}

.github/workflows/release.yml

@@ -51,63 +51,44 @@ jobs:
           git push origin ${{ github.event.inputs.tag }}
 
   build:
-    name: Build with Hatch
+    name: Build
     runs-on: ubuntu-latest
     needs: tag
-    outputs:
-      built: ${{ steps.set_output.outputs.built }}
     steps:
       - name: Checkout Code
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      - name: Check if pyproject.toml exists
-        id: check_file
-        run: |
-          if [ -f "pyproject.toml" ]; then
-            echo "exists=true" >> $GITHUB_OUTPUT
-          else
-            echo "exists=false" >> $GITHUB_OUTPUT
-          fi
-
       - name: Set up Python
-        if: steps.check_file.outputs.exists == 'true'
         uses: actions/setup-python@v5
         with:
             python-version: '3.13'
 
-      - name: Install Hatch
-        if: steps.check_file.outputs.exists == 'true'
+      - name: Build
+        if: hashFiles('pyproject.toml') != ''
         run: |
           pip install --upgrade pip
           pip install hatch
 
-      - name: Set version from tag in pyproject.toml
-        if: steps.check_file.outputs.exists == 'true'
-        run: |
           version=${{ github.event.inputs.tag }}
           version=${version#v}
           echo "Setting version to $version"
           sed -i.bak "s/^version = .*/version = \"$version\"/" pyproject.toml
           rm pyproject.toml.bak
 
-      - name: Build Package
-        if: steps.check_file.outputs.exists == 'true'
-        run: hatch build
+          hatch build
+
+          echo "Uploading dist/"
+          tar -cf dist.tar dist
 
-      - name: Upload dist/
-        if: steps.check_file.outputs.exists == 'true'
+      - name: Upload dist artifact
+        # not tested at runtime!
+        if: hashFiles('pyproject.toml') != ''
         uses: actions/upload-artifact@v4
         with:
           name: dist
-          path: dist/
-
-      - name: Set build output
-        id: set_output
-        run: |
-          echo "built=${{ steps.check_file.outputs.exists }}" >> $GITHUB_OUTPUT
-
+          path: dist.tar
 
   release:
     name: Create GitHub Release
@@ -120,45 +101,65 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Download dist artifact (if any)
-        if: needs.build.outputs.built == 'true'
+      - name: Download dist artifact
+        if: hashFiles('pyproject.toml') != ''
         uses: actions/download-artifact@v4
         with:
           name: dist
           path: dist
 
-      - name: Create GitHub Release with artifacts
-        if: needs.build.outputs.built == 'true'
-        uses: softprops/[email protected]
-        with:
-          tag_name: ${{ github.event.inputs.tag }}
-          name: ${{ github.event.inputs.tag }}
-          generate_release_notes: true
-          files: dist/*
+      - name: Extract dist.tar
+        if: hashFiles('pyproject.toml') != ''
+        run: |
+          if [[ -f dist/dist.tar ]]; then
+            echo "Extracting dist.tar"
+            tar -xf dist/dist.tar -C dist
+            rm dist/dist.tar
+          else
+            echo "No dist.tar found; skipping extract"
+          fi
 
-      - name: Create GitHub Release without artifacts
-        if: needs.build.outputs.built == 'false'
+      #- name: Warn if no artifacts found
+      #  run: |
+      #    if [[ ! -d dist || -z "$(ls -A dist)" ]]; then
+      #      echo "::warning::No files found in dist/. Release will be created without artifacts."
+      #    fi
+
+      - name: Create GitHub Release with artifacts
         uses: softprops/[email protected]
         with:
           tag_name: ${{ github.event.inputs.tag }}
           name: ${{ github.event.inputs.tag }}
           generate_release_notes: true
+          files: "dist/**"
 
   pypi:
     name: Publish to PyPI
     runs-on: ubuntu-latest
     environment: release
     needs: [build, tag]
-    if: needs.build.outputs.built == 'true'
 
     steps:
       - name: Download dist artifact
         uses: actions/download-artifact@v4
         with:
           name: dist
           path: dist
+        continue-on-error: true
+
+      - name: Check if dist contains artifacts
+        id: check_dist
+        if: hashFiles('pyproject.toml') != ''
+        run: |
+          if [[ ! -d dist || -z "$(ls -A dist)" ]]; then
+            echo "::warning::No artifacts found in dist/. Skipping PyPI publish."
+            echo "should_publish=false" >> $GITHUB_OUTPUT
+          else
+            echo "should_publish=true" >> $GITHUB_OUTPUT
+          fi
 
       - name: Publish to PyPI
+        if: steps.check_dist.outputs.should_publish == 'true'
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           packages-dir: dist/

.pre-commit-config.yaml

@@ -43,7 +43,7 @@ repos:
     hooks:
       - id: validate-pyproject
 
-  - repo: https://github.com/crate-ci/typos
-    rev: v1.35.1
-    hooks:
-      - id: typos
+  #- repo: https://github.com/crate-ci/typos
+  #  rev: v1.35.1
+  #  hooks:
+  #    - id: typos

Makefile

@@ -16,10 +16,11 @@ endif
 SOURCE_FOLDER ?= src
 TESTS_FOLDER ?= src/tests
 MARIMO_FOLDER ?= book/marimo
+OPTIONS ?=
 
 .DEFAULT_GOAL := help
 
-.PHONY: help verify install fmt lint test build check marimo clean docs
+.PHONY: help verify install fmt lint deptry test build check marimo clean docs pyproject
 
 ##@ Development Setup
 
@@ -36,7 +37,7 @@ install: uv ## Install all dependencies using uv
 
 fmt: uv ## Run code formatters only
 	@printf "$(BLUE)Running formatters...$(RESET)\n"
-	@uvx ruff format src
+	@uvx ruff format .
 
 lint: uv ## Run linters only
 	@printf "$(BLUE)Running linters...$(RESET)\n"
@@ -45,6 +46,10 @@ lint: uv ## Run linters only
 check: lint test ## Run all checks (lint and test)
 	@printf "$(GREEN)All checks passed!$(RESET)\n"
 
+deptry: uv ## Run deptry (use OPTIONS="--your-options" to pass options)
+	@printf "$(BLUE)Running deptry...$(RESET)\n"
+	@uvx deptry $(SOURCE_FOLDER) $(OPTIONS)
+
 ##@ Testing
 
 test: install ## Run all tests