|
1 | 1 | # Updating the docker container and making a new module release |
2 | 2 |
|
3 | 3 | 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`. |
6 | 6 |
|
7 | 7 | To update this tool: |
8 | 8 |
|
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: |
10 | 11 |
|
11 | 12 | ```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 |
13 | 16 | + ARG CELLPHENO_NIS_VERSION=<new version> |
14 | 17 | ``` |
15 | 18 |
|
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: |
17 | 21 |
|
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`. |
0 commit comments