Some updated from rerun_template

Author: emilk

.github/workflows/cpp.yml

@@ -1,5 +1,10 @@
 # Copied from https://github.com/rerun-io/rerun_template
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+    types: [ opened, synchronize ]
 
 name: C++
 
@@ -10,7 +15,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - uses: prefix-dev/[email protected].0
+      - uses: prefix-dev/[email protected].1
         with:
           pixi-version: v0.26.1
           cache: true

.github/workflows/links.yml

@@ -1,5 +1,10 @@
 # Copied from https://github.com/rerun-io/rerun_template
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+    types: [ opened, synchronize ]
 
 name: Link checker
 

pixi.toml

@@ -37,12 +37,12 @@ print-env = { cmd = "echo $PATH" }
 prepare = "cmake -G 'Ninja' -B build -S . -DCMAKE_BUILD_TYPE=RelWithDebInfo"
 
 # Build C++ example
-build = { cmd = "cmake --build build --config RelWithDebInfo --target all", depends_on = [
+build = { cmd = "cmake --build build --config RelWithDebInfo --target all", depends-on = [
     "prepare",
 ] }
 
 # Run C++ example
-example = { cmd = "build/rerun_vrs_example", depends_on = ["build"] }
+example = { cmd = "build/rerun_vrs_example", depends-on = ["build"] }
 
 # Format C++ code
 cpp-fmt = { cmd = "clang-format -i src/*.[hc]pp" }
@@ -55,9 +55,14 @@ cpp-fmt-check = { cmd = "clang-format --dry-run --Werror -i src/*.[hc]pp" }
 
 # Run first ruff fix, then ruff format, order is important see also https://twitter.com/charliermarsh/status/1717229721954799727
 py-fmt = "ruff check --fix --config pyproject.toml . && ruff format --config pyproject.toml ."
-py-fmt-check = "ruff format --check --config pyproject.toml"
+py-fmt-check = "ruff check --config pyproject.toml . && ruff format --check --config pyproject.toml"
 py-lint = "mypy --install-types --non-interactive --no-warn-unused-ignore"
 
+# ------------------------------------------------------------------------------------------
+# General stuff:
+lint-typos = "typos"
+
+
 [dependencies]
 # C++ build-tools:
 boost = "1.84.0.*"
@@ -82,5 +87,8 @@ ruff = "0.3.7"
 
 types-requests = ">=2.31,<3" # mypy type hint stubs for generate_changelog.py
 
+# General stuff:
+typos = ">=1.16.20"
+
 [target.linux-64.dependencies]
-sysroot_linux-64 = ">=2.17,<3" # rustc 1.78+ requires glibc 2.17+, see https://blog.rust-lang.org/2022/08/01/Increasing-glibc-kernel-requirements.html
+sysroot_linux-64 = ">=2.17,<3" # rustc 1.64+ requires glibc 2.17+, see https://blog.rust-lang.org/2022/08/01/Increasing-glibc-kernel-requirements.html

scripts/template_update.py

@@ -14,62 +14,82 @@
 You can also use `--dry-run` to see what would happen without actually changing anything.
 """
 
+from __future__ import annotations
+
 import argparse
 import os
 import shutil
 import tempfile
-from typing import Set
 
-from git import Repo
+from git import Repo  # pip install GitPython
 
 OWNER = "rerun-io"
 
-# Files requires by C++, but not by both Python or Rust.
+# Don't overwrite these when updating existing repository from the template
+DO_NOT_OVERWRITE = {
+    "Cargo.lock",
+    "CHANGELOG.md",
+    "main.py",
+    "pixi.lock",
+    "README.md",
+    "requirements.txt",
+}
+
+# Files required by C++, but not by _both_ Python and Rust
 CPP_FILES = {
     ".clang-format",
     ".github/workflows/cpp.yml",
     "CMakeLists.txt",
-    "pixi.lock",  # Not needed by Rust
-    "pixi.toml",  # Not needed by Rust
-    "src/main.cpp",
+    "pixi.lock",  # Pixi is only C++ & Python - For Rust we only use cargo
+    "pixi.toml",  # Pixi is only C++ & Python - For Rust we only use cargo
     "src/",
+    "src/main.cpp",
 }
 
-# Files requires by Python, but not by both C++ or Rust
+# Files required by Python, but not by _both_ C++ and Rust
 PYTHON_FILES = {
     ".github/workflows/python.yml",
     ".mypy.ini",
-    "pixi.lock",  # Not needed by Rust
-    "pixi.toml",  # Not needed by Rust
+    "main.py",
+    "pixi.lock",  # Pixi is only C++ & Python - For Rust we only use cargo
+    "pixi.toml",  # Pixi is only C++ & Python - For Rust we only use cargo
     "pyproject.toml",
+    "requirements.txt",
 }
 
-# Files requires by Rust, but not by both C++ or Python
+# Files required by Rust, but not by _both_ C++ and Python
 RUST_FILES = {
+    ".github/workflows/cargo_shear.yml",
     ".github/workflows/rust.yml",
     "bacon.toml",
     "Cargo.lock",
     "Cargo.toml",
+    "CHANGELOG.md",  # We only keep a changelog for Rust crates at the moment
     "clippy.toml",
     "Cranky.toml",
     "deny.toml",
+    "RELEASES.md",
     "rust-toolchain",
     "scripts/clippy_wasm/",
     "scripts/clippy_wasm/clippy.toml",
+    "scripts/generate_changelog.py",  # We only keep a changelog for Rust crates at the moment
+    "src/",
     "src/lib.rs",
     "src/main.rs",
-    "src/",
 }
 
+# Files we used to have, but have been removed in never version of rerun_template
+DEAD_FILES = ["bacon.toml", "Cranky.toml"]
+
 
-def parse_languages(lang_str: str) -> Set[str]:
+def parse_languages(lang_str: str) -> set[str]:
     languages = lang_str.split(",") if lang_str else []
     for lang in languages:
         assert lang in ["cpp", "python", "rust"], f"Unsupported language: {lang}"
     return set(languages)
 
 
-def calc_deny_set(languages: Set[str]) -> Set[str]:
+def calc_deny_set(languages: set[str]) -> set[str]:
     """The set of files to delete/ignore."""
     files_to_delete = CPP_FILES | PYTHON_FILES | RUST_FILES
     if "cpp" in languages:
@@ -81,29 +101,41 @@ def calc_deny_set(languages: Set[str]) -> Set[str]:
     return files_to_delete
 
 
-def init(languages: Set[str], dry_run: bool) -> None:
+def init(languages: set[str], dry_run: bool) -> None:
     print("Removing all language-specific files not needed for languages {languages}.")
     files_to_delete = calc_deny_set(languages)
     delete_files_and_folder(files_to_delete, dry_run)
 
 
-def delete_files_and_folder(paths: Set[str], dry_run: bool) -> None:
+def remove_file(filepath: str) -> None:
+    try:
+        os.remove(filepath)
+    except FileNotFoundError:
+        pass
+
+
+def delete_files_and_folder(paths: set[str], dry_run: bool) -> None:
     repo_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
     for path in paths:
         full_path = os.path.join(repo_path, path)
         if os.path.exists(full_path):
             if os.path.isfile(full_path):
                 print(f"Removing file {full_path}…")
                 if not dry_run:
-                    os.remove(full_path)
+                    remove_file(full_path)
             elif os.path.isdir(full_path):
                 print(f"Removing folder {full_path}…")
                 if not dry_run:
                     shutil.rmtree(full_path)
 
 
-def update(languages: Set[str], dry_run: bool) -> None:
-    files_to_ignore = calc_deny_set(languages)
+def update(languages: set[str], dry_run: bool) -> None:
+    for file in DEAD_FILES:
+        print(f"Removing dead file {file}…")
+        if not dry_run:
+            remove_file(file)
+
+    files_to_ignore = calc_deny_set(languages) | DO_NOT_OVERWRITE
     repo_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
 
     with tempfile.TemporaryDirectory() as temp_dir:
@@ -117,17 +149,15 @@ def update(languages: Set[str], dry_run: bool) -> None:
                     continue
                 if rel_path.startswith("src/"):
                     continue
-
-                if rel_path in {"README.md", "pixi.lock", "Cargo.lock"}:
+                if rel_path in files_to_ignore:
                     continue
 
-                if rel_path not in files_to_ignore:
-                    dest_path = os.path.join(repo_path, rel_path)
+                dest_path = os.path.join(repo_path, rel_path)
 
-                    print(f"Updating {rel_path}…")
-                    if not dry_run:
-                        os.makedirs(os.path.dirname(dest_path), exist_ok=True)
-                        shutil.copy2(src_path, dest_path)
+                print(f"Updating {rel_path}…")
+                if not dry_run:
+                    os.makedirs(os.path.dirname(dest_path), exist_ok=True)
+                    shutil.copy2(src_path, dest_path)
 
 
 def main() -> None: