ci(workflows): skip duplicate runs and update configurations

liblaf · liblaf · commit eb0f91cc5cea · 2025-08-15T17:31:29.000+08:00
Add pre-job to skip duplicate workflow runs using liblaf/actions-ts/pre action
- Implemented in all workflows (bench, build, docs, release, test)
- Reduces CI resource usage by preventing redundant executions
- Added dist** to branches-ignore patterns

Update pyright configuration
- Added reportPrivateImportUsage and reportRedeclaration rules
- Reordered configuration properties for consistency

Refactor template files
- Standardized Jinja comment syntax to use # %% for statements
- Improved .gitignore organization
- Added *.dvc pattern to VSCode excludes
- Renamed lazy_loader import to _lazy for consistency
diff --git a/copier.yaml b/copier.yaml
@@ -7,6 +7,10 @@ _answers_file: .config/copier/.copier-answers.python.yaml
 _external_data:
   shared: "{{ answers_file_shared }}"
 
+_envops:
+  line_statement_prefix: "# %%"
+  line_comment_prefix: "# ##"
+
 _migrations: &migrations
   - rm --force --verbose '__builtins__.pyi'
   - rm --force --verbose '.config/copier/direnv/00-python.sh'
diff --git a/template/.config/copier/{{ _copier_conf.answers_file }}.jinja b/template/.config/copier/{{ _copier_conf.answers_file }}.jinja
@@ -1,4 +1,4 @@
-# -*- mode: yaml; -*-
+# ## -*- mode: yaml; -*-
 # This file is @generated by <https://github.com/liblaf/copier-python>.
 # DO NOT EDIT!
 # prettier-ignore
diff --git a/template/.config/linters/pyrightconfig.json b/template/.config/linters/pyrightconfig.json
@@ -1,13 +1,11 @@
 {
   "$schema": "https://raw.githubusercontent.com/microsoft/pyright/main/packages/vscode-pyright/schemas/pyrightconfig.schema.json",
-
   "enableTypeIgnoreComments": false,
-
   "typeCheckingMode": "standard",
-
   "reportArgumentType": "information",
   "reportAssignmentType": "information",
-  "reportRedeclaration": "none",
   "reportIncompatibleMethodOverride": "warning",
-  "reportIncompatibleVariableOverride": "warning"
+  "reportIncompatibleVariableOverride": "warning",
+  "reportPrivateImportUsage": "none",
+  "reportRedeclaration": "none",
 }
diff --git a/template/.config/mise/conf.d/10-python.toml b/template/.config/mise/conf.d/10-python.toml
@@ -1,4 +1,3 @@
-# -*- mode: toml -*-
 #:schema https://mise.jdx.dev/schema/mise.json
 # This file is @generated by <https://github.com/liblaf/copier-python>.
 # DO NOT EDIT!
diff --git a/template/.github/workflows/bench.yaml b/template/.github/workflows/bench.yaml
@@ -7,13 +7,31 @@ on:
   push:
     branches-ignore:
       - assets**
+      - dist**
       - gh-pages
   pull_request:
   workflow_dispatch:
 
 jobs:
+  pre:
+    name: Pre
+    permissions:
+      actions: write
+    runs-on: ubuntu-latest
+    outputs:
+      should-skip: ${{ steps.pre.outputs.should-skip }}
+    steps:
+      - id: pre
+        name: Skip Duplicate Actions
+        uses: liblaf/actions-ts/pre@dist
+        with:
+          cancel-others: true
+
   detect:
     name: Detect
+    needs:
+      - pre
+    if: needs.pre.outputs.should-skip != 'true'
     runs-on: ubuntu-latest
     outputs:
       bench: ${{ steps.bench.outcome == 'success' }}
diff --git a/template/.github/workflows/build.yaml b/template/.github/workflows/build.yaml
@@ -7,13 +7,31 @@ on:
   push:
     branches-ignore:
       - assets**
+      - dist**
       - gh-pages
   pull_request:
   workflow_dispatch:
 
 jobs:
+  pre:
+    name: Pre
+    permissions:
+      actions: write
+    runs-on: ubuntu-latest
+    outputs:
+      should-skip: ${{ steps.pre.outputs.should-skip }}
+    steps:
+      - id: pre
+        name: Skip Duplicate Actions
+        uses: liblaf/actions-ts/pre@dist
+        with:
+          cancel-others: true
+
   build:
     name: Build
+    needs:
+      - pre
+    if: needs.pre.outputs.should-skip != 'true'
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
diff --git a/template/.github/workflows/docs.yaml b/template/.github/workflows/docs.yaml
@@ -6,19 +6,35 @@ on:
   push:
     branches-ignore:
       - assets**
+      - dist**
       - gh-pages
+  pull_request:
   workflow_dispatch:
 
 jobs:
+  pre:
+    name: Pre
+    permissions:
+      actions: write
+    runs-on: ubuntu-latest
+    outputs:
+      should-skip: ${{ steps.pre.outputs.should-skip }}
+    steps:
+      - id: pre
+        name: Skip Duplicate Actions
+        uses: liblaf/actions-ts/pre@dist
+        with:
+          cancel-others: true
+
   docs:
     name: Docs
     permissions:
       contents: write
       pages: write
+    needs:
+      - pre
+    if: needs.pre.outputs.should-skip != 'true'
     runs-on: ubuntu-latest
-    concurrency:
-      group: ${{ github.workflow }}-${{ github.ref }}-docs
-      cancel-in-progress: true
     steps:
       - id: auth
         name: Auth App
diff --git a/template/.github/workflows/release.yaml b/template/.github/workflows/release.yaml
@@ -10,8 +10,25 @@ on:
   workflow_dispatch:
 
 jobs:
+  pre:
+    name: Pre
+    permissions:
+      actions: write
+    runs-on: ubuntu-latest
+    outputs:
+      should-skip: ${{ steps.pre.outputs.should-skip }}
+    steps:
+      - id: pre
+        name: Skip Duplicate Actions
+        uses: liblaf/actions-ts/pre@dist
+        with:
+          cancel-others: true
+
   build:
     name: Build
+    needs:
+      - pre
+    if: needs.pre.outputs.should-skip != 'true'
     runs-on: ubuntu-latest
     outputs:
       artifact-name: ${{ steps.build.outputs.artifact-name }}
@@ -31,7 +48,7 @@ jobs:
     if: startsWith(github.ref, 'refs/tags/v')
     runs-on: ubuntu-latest
     concurrency:
-      group: ${{ github.workflow }}-${{ github.ref }}-publish
+      group: ${{ github.workflow }} @ ${{ github.ref }}
       cancel-in-progress: true
     steps:
       - name: Download Artifacts
@@ -51,7 +68,7 @@ jobs:
     if: startsWith(github.ref, 'refs/tags/v')
     runs-on: ubuntu-latest
     concurrency:
-      group: ${{ github.workflow }}-${{ github.ref }}-release
+      group: ${{ github.workflow }} @ ${{ github.ref }}
       cancel-in-progress: true
     steps:
       - name: Checkout
diff --git a/template/.github/workflows/test.yaml b/template/.github/workflows/test.yaml
@@ -9,13 +9,31 @@ on:
   push:
     branches-ignore:
       - assets**
+      - dist**
       - gh-pages
   pull_request:
   workflow_dispatch:
 
 jobs:
+  pre:
+    name: Pre
+    permissions:
+      actions: write
+    runs-on: ubuntu-latest
+    outputs:
+      should-skip: ${{ steps.pre.outputs.should-skip }}
+    steps:
+      - id: pre
+        name: Skip Duplicate Actions
+        uses: liblaf/actions-ts/pre@dist
+        with:
+          cancel-others: true
+
   detect:
     name: Detect
+    needs:
+      - pre
+    if: needs.pre.outputs.should-skip != 'true'
     runs-on: ubuntu-latest
     outputs:
       test: ${{ steps.test.outcome == 'success' }}
diff --git a/template/.gitignore b/template/.gitignore
@@ -175,20 +175,18 @@ poetry.toml
 
 # End of https://www.toptal.com/developers/gitignore/api/python
 
-*.log
-*.log.gz
-*.log.jsonl
-*.log.jsonl.gz
-playground/
-
 # hatch-vcs
 _version.py
 
 # pytest
 junit.xml
 
+# pytest-benchmark
+.benchmarks/
+
 # pytest-codspeed
 .codspeed/
 
-# pytest-benchmark
-.benchmarks/
+*.log
+*.log.*
+playground/
diff --git a/template/.readthedocs.yaml.jinja b/template/.readthedocs.yaml.jinja
@@ -1,4 +1,4 @@
-# -*- mode: yaml; -*-
+# ## -*- mode: yaml; -*-
 # yaml-language-server: $schema=https://raw.githubusercontent.com/readthedocs/readthedocs.org/master/readthedocs/rtd_tests/fixtures/spec/v2/schema.json
 # This file is @generated by <https://github.com/liblaf/copier-python>.
 # DO NOT EDIT!
@@ -19,36 +19,36 @@ build:
 
     # ref: <https://docs.readthedocs.com/platform/stable/build-customization.html#install-dependencies-with-uv>
     pre_create_environment:
-      # {%- if package_manager == "pixi" %}
+      # %% if package_manager == "pixi":
       - asdf plugin add pixi
       - asdf install pixi latest
       - asdf global pixi latest
-      # {%- elif package_manager == "uv" %}
+      # %% elif package_manager == "uv":
       - asdf plugin add uv
       - asdf install uv latest
       - asdf global uv latest
-      # {%- endif %}
+      # %% endif
 
-    # {%- if package_manager == "uv" %}
+    # %% if package_manager == "uv":
     create_environment:
       - uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
-    # {%- endif %}
+    # %% endif
 
     install:
-      # {%- if package_manager == "pixi" %}
+      # %% if package_manager == "pixi":
       - pixi install --frozen
-      # {%- elif package_manager == "uv" %}
+      # %% elif package_manager == "uv":
       - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --all-extras --all-groups --frozen --link-mode copy
-      # {%- endif %}
+      # %% endif
 
     pre_build:
-      - if test -f "docs/scripts/pre-build.sh"; then bash "docs/scripts/pre-build.sh"; fi
+      - if test -f 'docs/scripts/pre-build.sh'; then bash 'docs/scripts/pre-build.sh'; fi
 
-    # {%- if package_manager == "pixi" %}
+    # %% if package_manager == "pixi":
     build:
       html:
         - pixi run mkdocs build --site-dir "$READTHEDOCS_OUTPUT/html/"
-    # {%- endif %}
+    # %% endif
 
 mkdocs:
   configuration: mkdocs.yaml
diff --git a/template/.vscode/settings.json b/template/.vscode/settings.json
@@ -7,6 +7,7 @@
     "**/.pytest_cache/": true,
     "**/.ruff_cache/": true,
     "**/.venv/": true,
+    "**/*.dvc": true,
     "**/junit.xml": true
   },
   "python.analysis.diagnosticMode": "workspace",
diff --git a/template/mkdocs.yaml.jinja b/template/mkdocs.yaml.jinja
@@ -1,12 +1,4 @@
-# -*- mode: yaml; -*-
-
+# ## -*- mode: yaml; -*-
 INHERIT: .config/copier/mkdocs.yaml
 site_name: "{{ project_name }}"
 site_description: TODO
-
-plugins:
-  mkdocstrings:
-    handlers:
-      python:
-        inventories:
-          - https://docs.python.org/3/objects.inv
diff --git a/template/pyproject.toml.jinja b/template/pyproject.toml.jinja
@@ -1,4 +1,4 @@
-# -*- mode: toml; -*-
+# ## -*- mode: toml; -*-
 #:schema https://json.schemastore.org/pyproject.json
 # ref: <https://packaging.python.org/en/latest/specifications/pyproject-toml/>
 
@@ -86,7 +86,7 @@ packages = ["src/{{ wheel_package_dir }}/"]
 [tool.hatch.version]
 source = "vcs"
 
-# {%- if package_manager == "pixi" %}
+# %% if package_manager == "pixi":
 [tool.pixi.environments]
 default = { features = ["build", "dev", "docs", "test"] }
 
@@ -102,13 +102,13 @@ platforms = ["linux-64"]
 cuda = "12"
 libc = { family = "glibc", version = "2.41" }
 linux = "6.12"
-# {%- endif %}
+# %% endif
 
 [tool.pytest.ini_options]
 addopts = ["--showlocals", "--strict-config", "--strict-markers"]
 testpaths = ["benches/", "tests/"]
 
-# {%- if package_manager == "uv" %}
+# %% if package_manager == "uv":
 [tool.uv]
 default-groups = "all"
-# {%- endif %}
+# %% endif
diff --git a/template/src/{{ package_dir }}/__init__.py b/template/src/{{ package_dir }}/__init__.py
@@ -1,5 +1,5 @@
-# tangerine-start: lazy-loader.py.jinja
-import lazy_loader as lazy
+# tangerine-start: lazy-loader.py
+import lazy_loader as _lazy
 
-__getattr__, __dir__, __all__ = lazy.attach_stub(__name__, __file__)
+__getattr__, __dir__, __all__ = _lazy.attach_stub(__name__, __file__)
 # tangerine-end

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# -- mode: yaml; --`
	`1`	`+# ## -- mode: yaml; --`
`2`	`2`	`# This file is @generated by <https://github.com/liblaf/copier-python>.`
`3`	`3`	`# DO NOT EDIT!`
`4`	`4`	`# prettier-ignore`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-# -- mode: toml --`
`2`	`1`	`#:schema https://mise.jdx.dev/schema/mise.json`
`3`	`2`	`# This file is @generated by <https://github.com/liblaf/copier-python>.`
`4`	`3`	`# DO NOT EDIT!`