Skip to content

Commit 1e243f3

Browse files
committed
cellpheno/nis: align version to 1.0.2; fix README
Container tag, versions-topic string and Dockerfile VERSION were still 1.0.0 while the pinned source and bioconda package are 1.0.2 -> align all to 1.0.2. Fix README (binary is installed as cellpheno-nis, not main; accurate release steps). Regenerate stub snapshot.
1 parent 6ed3122 commit 1e243f3

5 files changed

Lines changed: 27 additions & 16 deletions

File tree

modules/nf-core/cellpheno/nis/Dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ COPY --from=build /src/cpp/build/main /usr/local/bin/cellpheno-nis
7272

7373
# Single authoritative version source. The module reads the NIS version from this file into versions.yml, so the container tag and the
7474
# reported version stay in lockstep. Bump together with the `container` tag in main.nf.
75-
ARG CELLPHENO_NIS_VERSION=1.0.0
75+
ARG CELLPHENO_NIS_VERSION=1.0.2
7676
RUN mkdir -p /usr/local/share/cellpheno-nis \
7777
&& echo "${CELLPHENO_NIS_VERSION}" > /usr/local/share/cellpheno-nis/VERSION
7878

@@ -83,7 +83,7 @@ LABEL org.opencontainers.image.authors="Ziquan Wei (@Chrisa142857)" \
8383
org.opencontainers.image.description="Whole-brain 3D nuclei instance segmentation for lightsheet microscopy" \
8484
org.opencontainers.image.source="https://github.com/Chrisa142857/Lightsheet_microscopy_image_3D_nuclei_instance_segmentation" \
8585
org.opencontainers.image.licenses="MIT" \
86-
org.opencontainers.image.version="1.0.0"
86+
org.opencontainers.image.version="1.0.2"
8787

8888
ENTRYPOINT []
8989
CMD ["cellpheno-nis", "--help"]
Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
11
# Updating the docker container and making a new module release
22

33
The CellPheno NIS container is built from the [`Dockerfile`](./Dockerfile) in this
4-
directory. It clones the source repository and compiles the C++/LibTorch/CUDA executable,
5-
then ships it on `PATH` as `main`.
4+
directory. It clones a pinned release of the source repository, compiles the
5+
C++/LibTorch/CUDA executable, and installs it on `PATH` as `cellpheno-nis`.
66

77
To update this tool:
88

9-
1. Edit the version (and, for a fixed build, the pinned source ref) in the `Dockerfile`:
9+
1. In the [`Dockerfile`](./Dockerfile), pin the source to the new release tag and bump the
10+
reported version:
1011

1112
```diff
12-
- ARG CELLPHENO_NIS_VERSION=1.0.0
13+
- ARG NIS_SOURCE_REF=v1.0.2
14+
+ ARG NIS_SOURCE_REF=<new release tag>
15+
- ARG CELLPHENO_NIS_VERSION=1.0.2
1316
+ ARG CELLPHENO_NIS_VERSION=<new version>
1417
```
1518

16-
and bump the `container` tag in [`main.nf`](./main.nf) to match.
19+
2. In [`main.nf`](./main.nf), bump the `container` tag and the version string in the
20+
`versions` topic to match:
1721

18-
2. Open a PR against [nf-core/modules](https://github.com/nf-core/modules), push the
19-
changes, and the `Dockerfile` will be built and uploaded to
20-
`quay.io/nf-core/cellpheno-nis`.
22+
```diff
23+
- container "quay.io/nf-core/cellpheno-nis:1.0.2"
24+
+ container "quay.io/nf-core/cellpheno-nis:<new version>"
25+
...
26+
- tuple val("${task.process}"), val('cellpheno-nis'), val('1.0.2'), topic: versions, ...
27+
+ tuple val("${task.process}"), val('cellpheno-nis'), val('<new version>'), topic: versions, ...
28+
```
29+
30+
3. Open a PR against [nf-core/modules](https://github.com/nf-core/modules) and push the
31+
changes; the `Dockerfile` is built and uploaded to `quay.io/nf-core/cellpheno-nis`.

modules/nf-core/cellpheno/nis/main.nf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ process CELLPHENO_NIS {
88
// It has no Conda/Bioconda package and requires a CUDA runtime, so it is
99
// distributed only as a dedicated GPU container image (cf. the parabricks and
1010
// numorph/3dunet modules, which likewise ship a vendor GPU image with no conda).
11-
container "quay.io/nf-core/cellpheno-nis:1.0.0"
11+
container "quay.io/nf-core/cellpheno-nis:1.0.2"
1212

1313
input:
1414
tuple val(meta), path(tile_dir)
@@ -17,7 +17,7 @@ process CELLPHENO_NIS {
1717
output:
1818
tuple val(meta), path("*_NIScpp_results_*.zip"), emit: nis
1919
tuple val(meta), path("*_remap.zip") , emit: remap, optional: true
20-
tuple val("${task.process}"), val('cellpheno-nis'), val('1.0.0'), topic: versions, emit: versions_cellpheno_nis // WARN: Version information not provided by tool on CLI. Please update this string when bumping container versions.
20+
tuple val("${task.process}"), val('cellpheno-nis'), val('1.0.2'), topic: versions, emit: versions_cellpheno_nis // WARN: Version information not provided by tool on CLI. Please update this string when bumping container versions.
2121

2222
when:
2323
task.ext.when == null || task.ext.when

modules/nf-core/cellpheno/nis/meta.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ output:
7474
- "cellpheno-nis":
7575
type: string
7676
description: The name of the tool
77-
- "1.0.0":
77+
- "1.0.2":
7878
type: string
7979
description: The expression to obtain the version of the tool
8080
topics:
@@ -85,7 +85,7 @@ topics:
8585
- "cellpheno-nis":
8686
type: string
8787
description: The name of the tool
88-
- "1.0.0":
88+
- "1.0.2":
8989
type: string
9090
description: The expression to obtain the version of the tool
9191
authors:

modules/nf-core/cellpheno/nis/tests/main.nf.test.snap

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
[
3030
"CELLPHENO_NIS",
3131
"cellpheno-nis",
32-
"1.0.0"
32+
"1.0.2"
3333
]
3434
],
3535
"nis": [
@@ -59,7 +59,7 @@
5959
[
6060
"CELLPHENO_NIS",
6161
"cellpheno-nis",
62-
"1.0.0"
62+
"1.0.2"
6363
]
6464
]
6565
}

0 commit comments

Comments
 (0)