From 5b023a9c63c79754897dd7cfe5f25f971e4551ab Mon Sep 17 00:00:00 2001 From: Ivan Ruiz Manuel <72193617+irm-codebase@users.noreply.github.com> Date: Fri, 1 May 2026 10:44:39 +0200 Subject: [PATCH 1/3] fix template check and add manual run option. --- README.md | 4 ++-- template/.github/workflows/check-version.yml | 4 ++++ template/README.md.jinja | 1 + 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 22f2a82..f79dc26 100644 --- a/README.md +++ b/README.md @@ -58,8 +58,8 @@ We require [`pixi`](https://pixi.sh/) as a package manager. Once installed, do t copier copy https://github.com/modelblocks-org/data-module-template.git ./ ``` - > [!TIP] - > If your terminal does not have access to `copier` then you may need to update your `PATH` variable to include `~/.pixi/bin`. +> [!TIP] +> If your terminal does not have access to `copier` then you may need to update your `PATH` variable to include `~/.pixi/bin`. 3. Answer some questions so can we pre-fill licensing, citation files, etc... 4. Initialise the `pixi` project environment of your new module. diff --git a/template/.github/workflows/check-version.yml b/template/.github/workflows/check-version.yml index 0a4a602..7bde778 100644 --- a/template/.github/workflows/check-version.yml +++ b/template/.github/workflows/check-version.yml @@ -1,9 +1,13 @@ # Check for changes in the upstream template. If changes are found, an issue is created name: Template check. on: + workflow_dispatch: schedule: - cron: '0 0 1 * *' # Runs at 00:00 UTC on the 1st day of every month jobs: copier-update: + permissions: + contents: read + issues: write uses: modelblocks-org/data-module-template/.github/workflows/template-check-version.yml@latest diff --git a/template/README.md.jinja b/template/README.md.jinja index dbaa545..263de7b 100644 --- a/template/README.md.jinja +++ b/template/README.md.jinja @@ -18,6 +18,7 @@ and the `snakemake` [documentation](https://snakemake.readthedocs.io/en/stable/s Data processing steps: + 1. 2. From 1ce2bc57509c82c6f630cf9992f2c68e476c4138 Mon Sep 17 00:00:00 2001 From: Ivan Ruiz Manuel <72193617+irm-codebase@users.noreply.github.com> Date: Fri, 1 May 2026 10:48:34 +0200 Subject: [PATCH 2/3] fix Snakemake version and all rule logging --- template/workflow/Snakefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/template/workflow/Snakefile b/template/workflow/Snakefile index 30e6c63..1f8f266 100644 --- a/template/workflow/Snakefile +++ b/template/workflow/Snakefile @@ -2,7 +2,7 @@ import yaml from snakemake.utils import min_version, validate -min_version("8.10") +min_version("9.19") # !!!!! IMPORTANT !!!!! @@ -43,7 +43,7 @@ rule all: output: "INVALID", log: - stderr="logs/all.stderr", + stderr="/all.stderr", conda: "envs/shell.yaml" shell: From 87bbe30a4c764fbc548b53eda32e188db11e0683 Mon Sep 17 00:00:00 2001 From: Ivan Ruiz Manuel <72193617+irm-codebase@users.noreply.github.com> Date: Fri, 1 May 2026 11:12:02 +0200 Subject: [PATCH 3/3] Fix PR logging path --- template/.github/workflows/pr-ci.yml | 2 +- template/pixi.toml.jinja | 2 +- .../integration/{% if true %}Snakefile{% endif %}.jinja | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/template/.github/workflows/pr-ci.yml b/template/.github/workflows/pr-ci.yml index 728b9c5..0e17ea4 100644 --- a/template/.github/workflows/pr-ci.yml +++ b/template/.github/workflows/pr-ci.yml @@ -33,7 +33,7 @@ jobs: uses: actions/upload-artifact@v4 with: name: integration-test-logs-${{ matrix.os }} - path: tests/integration/results/integration_test/logs + path: tests/integration/resources/module/logs if-no-files-found: ignore retention-days: 30 - name: Fail if integration or linting failed diff --git a/template/pixi.toml.jinja b/template/pixi.toml.jinja index 5e49752..207e14e 100644 --- a/template/pixi.toml.jinja +++ b/template/pixi.toml.jinja @@ -19,7 +19,7 @@ pytest = ">=8.3.5" python = ">=3.12" ruff = ">=0.9.9" snakefmt = ">=0.10.2" -snakemake-minimal = ">=8.29.0" +snakemake-minimal = ">=9.19.0" pytz = ">=2026.1.post1" [tasks] diff --git a/template/tests/integration/{% if true %}Snakefile{% endif %}.jinja b/template/tests/integration/{% if true %}Snakefile{% endif %}.jinja index 8e89702..1317149 100644 --- a/template/tests/integration/{% if true %}Snakefile{% endif %}.jinja +++ b/template/tests/integration/{% if true %}Snakefile{% endif %}.jinja @@ -30,9 +30,9 @@ module {{module_short_name}}: # Redirect specific module results (outputs) combined_text="results/output/combined_text.md", # Redirect intermediate files that are internal to the module - logs="resources/{{module_short_name}}/logs", - resources="resources/{{module_short_name}}/resources", - results="resources/{{module_short_name}}/results" + logs="resources/module/logs", + resources="resources/module/resources", + results="resources/module/results" # rename all module rules with a prefix, to avoid naming conflicts.