Skip to content

Commit 85a78f3

Browse files
authored
Fix template check + minor fixes (#52)
* fix template check and add manual run option. * fix Snakemake version and all rule logging * Fix PR logging path
1 parent 37d1063 commit 85a78f3

7 files changed

Lines changed: 14 additions & 9 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ We require [`pixi`](https://pixi.sh/) as a package manager. Once installed, do t
5858
copier copy https://github.com/modelblocks-org/data-module-template.git ./<module_name>
5959
```
6060

61-
> [!TIP]
62-
> If your terminal does not have access to `copier` then you may need to update your `PATH` variable to include `~/.pixi/bin`.
61+
> [!TIP]
62+
> If your terminal does not have access to `copier` then you may need to update your `PATH` variable to include `~/.pixi/bin`.
6363
6464
3. Answer some questions so can we pre-fill licensing, citation files, etc...
6565
4. Initialise the `pixi` project environment of your new module.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# Check for changes in the upstream template. If changes are found, an issue is created
22
name: Template check.
33
on:
4+
workflow_dispatch:
45
schedule:
56
- cron: '0 0 1 * *' # Runs at 00:00 UTC on the 1st day of every month
67

78
jobs:
89
copier-update:
10+
permissions:
11+
contents: read
12+
issues: write
913
uses: modelblocks-org/data-module-template/.github/workflows/template-check-version.yml@latest

template/.github/workflows/pr-ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
uses: actions/upload-artifact@v4
3434
with:
3535
name: integration-test-logs-${{ matrix.os }}
36-
path: tests/integration/results/integration_test/logs
36+
path: tests/integration/resources/module/logs
3737
if-no-files-found: ignore
3838
retention-days: 30
3939
- name: Fail if integration or linting failed

template/README.md.jinja

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ and the `snakemake` [documentation](https://snakemake.readthedocs.io/en/stable/s
1818
<!-- Please describe the processing stages of this module here -->
1919

2020
Data processing steps:
21+
2122
1.
2223
2.
2324

template/pixi.toml.jinja

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ pytest = ">=8.3.5"
1919
python = ">=3.12"
2020
ruff = ">=0.9.9"
2121
snakefmt = ">=0.10.2"
22-
snakemake-minimal = ">=8.29.0"
22+
snakemake-minimal = ">=9.19.0"
2323
pytz = ">=2026.1.post1"
2424

2525
[tasks]

template/tests/integration/{% if true %}Snakefile{% endif %}.jinja

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ module {{module_short_name}}:
3030
# Redirect specific module results (outputs)
3131
combined_text="results/output/combined_text.md",
3232
# Redirect intermediate files that are internal to the module
33-
logs="resources/{{module_short_name}}/logs",
34-
resources="resources/{{module_short_name}}/resources",
35-
results="resources/{{module_short_name}}/results"
33+
logs="resources/module/logs",
34+
resources="resources/module/resources",
35+
results="resources/module/results"
3636

3737

3838
# rename all module rules with a prefix, to avoid naming conflicts.

template/workflow/Snakefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import yaml
22

33
from snakemake.utils import min_version, validate
44

5-
min_version("8.10")
5+
min_version("9.19")
66

77

88
# !!!!! IMPORTANT !!!!!
@@ -43,7 +43,7 @@ rule all:
4343
output:
4444
"INVALID",
4545
log:
46-
stderr="logs/all.stderr",
46+
stderr="<logs>/all.stderr",
4747
conda:
4848
"envs/shell.yaml"
4949
shell:

0 commit comments

Comments
 (0)