Skip to content

Commit

Permalink
fix: github actions image name to lowercase (#27)
Browse files Browse the repository at this point in the history
* fix gh actions image name to lowercase
* fix readme image name to lowercase
* fix def files image name to lowercase
* fix docs image name to lowercase
* fix repo readme image name to lowercase
  • Loading branch information
susrei authored Dec 23, 2023
1 parent 62fefa1 commit 8b48337
Show file tree
Hide file tree
Showing 12 changed files with 29 additions and 31 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docker-publish-bioconductor-spatial.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:

env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
IMAGE_NAME: nbisweden/workshop-scrnaseq
IMAGE_TAG: 2023-bioconductor_spatial-r4.3.0


Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docker-publish-bioconductor.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:

env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
IMAGE_NAME: nbisweden/workshop-scrnaseq
IMAGE_TAG: 2023-bioconductor-r4.3.0


Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docker-publish-scanpy-spatial.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:

env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
IMAGE_NAME: nbisweden/workshop-scrnaseq
IMAGE_TAG: 2023-scanpy_spatial-py3.10


Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docker-publish-scanpy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:

env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
IMAGE_NAME: nbisweden/workshop-scrnaseq
IMAGE_TAG: 2023-scanpy-py3.10


Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docker-publish-seurat-spatial.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:

env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
IMAGE_NAME: nbisweden/workshop-scrnaseq
IMAGE_TAG: 2023-seurat_spatial-r4.3.0


Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docker-publish-seurat.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:

env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
IMAGE_NAME: nbisweden/workshop-scrnaseq
IMAGE_TAG: 2023-seurat-r4.3.0


Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ git push origin

```
# for seurat labs
docker pull ghcr.io/NBISweden/workshop-scRNAseq:2023-seurat-r4.3.0
docker pull ghcr.io/nbisweden/workshop-scrnaseq:2023-seurat-r4.3.0
# for bioconductor labs
docker pull ghcr.io/NBISweden/workshop-scRNAseq:2023-bioconductor-r4.3.0
docker pull ghcr.io/nbisweden/workshop-scrnaseq:2023-bioconductor-r4.3.0
# for python labs
docker pull ghcr.io/NBISweden/workshop-scRNAseq:2023-scanpy-py3.10
docker pull ghcr.io/nbisweden/workshop-scrnaseq:2023-scanpy-py3.10
```

## Run labs (locally)
Expand All @@ -38,8 +38,8 @@ docker pull ghcr.io/NBISweden/workshop-scRNAseq:2023-scanpy-py3.10
- To run Seurat or Bioconductor labs in RStudio

```
docker run --rm -ti --platform=linux/amd64 -p 8787:8787 -e PASSWORD=scrnaseq -v $PWD:/home/rstudio/workdir ghcr.io/NBISweden/workshop-scRNAseq:2023-seurat-r4.3.0
docker run --rm -ti --platform=linux/amd64 -p 8787:8787 -e PASSWORD=scrnaseq -v $PWD:/home/rstudio/workdir ghcr.io/NBISweden/workshop-scRNAseq:2023-bioconductor-r4.3.0
docker run --rm -ti --platform=linux/amd64 -p 8787:8787 -e PASSWORD=scrnaseq -v $PWD:/home/rstudio/workdir ghcr.io/nbisweden/workshop-scrnaseq:2023-seurat-r4.3.0
docker run --rm -ti --platform=linux/amd64 -p 8787:8787 -e PASSWORD=scrnaseq -v $PWD:/home/rstudio/workdir ghcr.io/nbisweden/workshop-scrnaseq:2023-bioconductor-r4.3.0
```

- Open in browser: `http://localhost:8787/`, login: rstudio, pass: scrnaseq
Expand All @@ -48,7 +48,7 @@ docker run --rm -ti --platform=linux/amd64 -p 8787:8787 -e PASSWORD=scrnaseq -v
- To run Python labs in JupyterLab

```
docker run --rm -ti --platform=linux/amd64 -p 8888:8888 -v $PWD:/home/jovyan/workdir ghcr.io/NBISweden/workshop-scRNAseq:2023-scanpy-py3.10
docker run --rm -ti --platform=linux/amd64 -p 8888:8888 -v $PWD:/home/jovyan/workdir ghcr.io/nbisweden/workshop-scrnaseq:2023-scanpy-py3.10
```

- Open in browser: `http://127.0.0.1:8888/lab?token=xxxx` (Use exact token from terminal on launch)
Expand All @@ -61,19 +61,19 @@ Instructions to render the `.qmd` files to `.html`.
- For Seurat labs

```
docker run --rm -ti --platform=linux/amd64 -p 8787:8787 -e PASSWORD=scrnaseq -v $PWD:/home/rstudio/workdir ghcr.io/NBISweden/workshop-scRNAseq:2023-seurat-r4.3.0 quarto render /home/rstudio/workdir/labs/seurat/seurat_01_qc.qmd
docker run --rm -ti --platform=linux/amd64 -p 8787:8787 -e PASSWORD=scrnaseq -v $PWD:/home/rstudio/workdir ghcr.io/nbisweden/workshop-scrnaseq:2023-seurat-r4.3.0 quarto render /home/rstudio/workdir/labs/seurat/seurat_01_qc.qmd
```

- For Bioconductor labs

```
docker run --rm -ti --platform=linux/amd64 -p 8787:8787 -e PASSWORD=scrnaseq -v $PWD:/home/rstudio/workdir ghcr.io/NBISweden/workshop-scRNAseq:2023-bioconductor-r4.3.0 quarto render /home/rstudio/workdir/labs/bioc/bioc_01_qc.qmd
docker run --rm -ti --platform=linux/amd64 -p 8787:8787 -e PASSWORD=scrnaseq -v $PWD:/home/rstudio/workdir ghcr.io/nbisweden/workshop-scrnaseq:2023-bioconductor-r4.3.0 quarto render /home/rstudio/workdir/labs/bioc/bioc_01_qc.qmd
```

- For Python labs

```
docker run --rm -ti --platform=linux/amd64 -p 8888:8888 -v $PWD:/home/jovyan/workdir ghcr.io/NBISweden/workshop-scRNAseq:2023-scanpy-py3.10 quarto render /home/jovyan/workdir/labs/scanpy/scanpy_01_qc.qmd
docker run --rm -ti --platform=linux/amd64 -p 8888:8888 -v $PWD:/home/jovyan/workdir ghcr.io/nbisweden/workshop-scrnaseq:2023-scanpy-py3.10 quarto render /home/jovyan/workdir/labs/scanpy/scanpy_01_qc.qmd
```

- Successfully rendered outputs are moved to `docs` folder and chunks are cached under `_freeze`.
Expand Down
10 changes: 5 additions & 5 deletions containers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Here we use three different toolkits, namely `Seurat` (R/RStudio), `Bioconductor
The different images are differentiated by the following `registry/username/image:tag` convention:

```
ghcr.io/NBISweden/workshop-scRNAseq:<YEAR>-<TOOLKIT>-<LANGUAGE-VERSION>
ghcr.io/nbisweden/workshop-scrnaseq:<YEAR>-<TOOLKIT>-<LANGUAGE-VERSION>
```

Each image contains the required packages so that, for each toolkit, the following analysis steps can be performed:
Expand Down Expand Up @@ -95,8 +95,8 @@ For the Python based image, you can install packages using `mamba`, `pip`, or `c
### R Based Images

```bash
docker pull ghcr.io/NBISweden/workshop-scRNAseq:<TAG>
docker run --rm -ti -p 8787:8787 -e PASSWORD=scrnaseq -v /path/to/workdir:/home/rstudio/workdir ghcr.io/NBISweden/workshop-scRNAseq:<TAG>
docker pull ghcr.io/nbisweden/workshop-scrnaseq:<TAG>
docker run --rm -ti -p 8787:8787 -e PASSWORD=scrnaseq -v /path/to/workdir:/home/rstudio/workdir ghcr.io/nbisweden/workshop-scrnaseq:<TAG>
```

In the browser, go to [localhost:8787](localhost:8787).
Expand All @@ -107,8 +107,8 @@ Use the following credentials to log in to the RStudio Server:
### Python Based Image

```bash
docker pull ghcr.io/NBISweden/workshop-scRNAseq:<TAG>
docker run --rm -ti -p 8888:8888 -v /path/to/workdir:/home/jovyan/workshop-scRNAseq ghcr.io/NBISweden/workshop-scRNAseq:<TAG>
docker pull ghcr.io/nbisweden/workshop-scrnaseq:<TAG>
docker run --rm -ti -p 8888:8888 -v /path/to/workdir:/home/jovyan/workshop-scRNAseq ghcr.io/nbisweden/workshop-scrnaseq:<TAG>
```

In the browser, go to [localhost:8888](localhost:8888).
Expand Down
12 changes: 6 additions & 6 deletions containers/docs/run-containers.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,8 @@ To avoid running out of memory, restart R (_Session > Restart R_) after each lab

```bash
cd /path/to/workshop-dir # replace this with the full path to the workshop folder
docker pull ghcr.io/NBISweden/workshop-scRNAseq:2023-seurat-r4.3.0
docker run --rm -ti -p 8787:8787 -e PASSWORD=scrnaseq -v ${PWD}:/home/rstudio/workdir ghcr.io/NBISweden/workshop-scRNAseq:2023-seurat-r4.3.0
docker pull ghcr.io/nbisweden/workshop-scrnaseq:2023-seurat-r4.3.0
docker run --rm -ti -p 8787:8787 -e PASSWORD=scrnaseq -v ${PWD}:/home/rstudio/workdir ghcr.io/nbisweden/workshop-scrnaseq:2023-seurat-r4.3.0
```

In the browser, go to [localhost:8787](localhost:8787).
Expand All @@ -144,8 +144,8 @@ To avoid running out of memory, restart R (_Session > Restart R_) after each lab

```bash
cd /path/to/workshop-dir # replace this with the full path to the workshop folder
docker pull ghcr.io/NBISweden/workshop-scRNAseq:2023-bioconductor-r4.3.0
docker run --rm -ti -p 8787:8787 -e PASSWORD=scrnaseq -v ${PWD}:/home/rstudio/workdir ghcr.io/NBISweden/workshop-scRNAseq:2023-bioconductor-r4.3.0
docker pull ghcr.io/nbisweden/workshop-scrnaseq:2023-bioconductor-r4.3.0
docker run --rm -ti -p 8787:8787 -e PASSWORD=scrnaseq -v ${PWD}:/home/rstudio/workdir ghcr.io/nbisweden/workshop-scrnaseq:2023-bioconductor-r4.3.0
```

In the browser, go to [localhost:8787](localhost:8787). Use the following credentials to log in to the RStudio Server:
Expand All @@ -166,8 +166,8 @@ To avoid running out of memory, restart the kernel (_Kernel > Restart Kernel_) a

```bash
cd /path/to/workshop-dir # replace this with the full path to the workshop folder
docker pull ghcr.io/NBISweden/workshop-scRNAseq:2023-scanpy-py3.10
docker run --rm -ti -p 8888:8888 -v ${PWD}:/home/jovyan/workdir ghcr.io/NBISweden/workshop-scRNAseq:2023-scanpy-py3.10
docker pull ghcr.io/nbisweden/workshop-scrnaseq:2023-scanpy-py3.10
docker run --rm -ti -p 8888:8888 -v ${PWD}:/home/jovyan/workdir ghcr.io/nbisweden/workshop-scrnaseq:2023-scanpy-py3.10
```

At the end of the prompt, you will see a URL that starts with `http://127.0.0.1`, similar to the one below:
Expand Down
3 changes: 1 addition & 2 deletions containers/uppmax/singularity_bioconductor.def
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
Bootstrap: docker
From: ghcr.io/NBISweden/workshop-scRNAseq:2023-bioconductor-r4.3.0
From: ghcr.io/nbisweden/workshop-scrnaseq:2023-bioconductor-r4.3.0

%post
chmod -R 777 /opt/conda
chmod -R 777 /opt/venv

2 changes: 1 addition & 1 deletion containers/uppmax/singularity_scanpy.def
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Bootstrap: docker
From: ghcr.io/NBISweden/workshop-scRNAseq:2023-scanpy-py3.10
From: ghcr.io/nbisweden/workshop-scrnaseq:2023-scanpy-py3.10

%post
chmod -R 777 /opt/conda
3 changes: 1 addition & 2 deletions containers/uppmax/singularity_seurat.def
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
Bootstrap: docker
From: ghcr.io/NBISweden/workshop-scRNAseq:2023-seurat-r4.3.0
From: ghcr.io/nbisweden/workshop-scrnaseq:2023-seurat-r4.3.0

%post
chmod -R 777 /opt/conda
chmod -R 777 /opt/venv

0 comments on commit 8b48337

Please sign in to comment.