Skip to content

Commit 3c4b801

Browse files
committed
major changes in the containers push
1 parent f475c72 commit 3c4b801

File tree

2 files changed

+75
-6
lines changed

2 files changed

+75
-6
lines changed

.github/workflows/quantms-containers.yml

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,14 @@ jobs:
4848
registry: ghcr.io
4949
username: ${{ github.actor }}
5050
password: ${{ secrets.GHCR_TOKEN }}
51+
52+
- name: Install GitHub CLI
53+
run: |
54+
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
55+
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
56+
sudo apt update
57+
sudo apt install gh
58+
gh auth login --with-token <<< "${{ secrets.GHCR_TOKEN }}"
5159
5260
- name: Extract metadata for Docker
5361
id: meta
@@ -73,6 +81,8 @@ jobs:
7381
cache-from: type=gha
7482
cache-to: type=gha,mode=max
7583
provenance: false
84+
85+
# Note: DiaNN containers remain private as per license requirements
7686

7787
- name: Set up Singularity
7888
if: ${{ (github.event.inputs.push_images == true || github.event.inputs.push_images == '') }}
@@ -106,6 +116,8 @@ jobs:
106116
# Push with version tag
107117
singularity push diann-2.1.0.sif oras://ghcr.io/bigbio/diann-sif:2.1.0
108118
119+
# Note: DiaNN containers remain private as per license requirements
120+
109121
# If this is a release event, also tag as latest
110122
if [[ "${{ env.IS_RELEASE }}" == "true" || "${{ github.event_name }}" == "release" ]]; then
111123
singularity push diann-2.1.0.sif oras://ghcr.io/bigbio/diann-sif:latest
@@ -130,7 +142,8 @@ jobs:
130142
packages: write
131143

132144
env:
133-
OPENMS_VERSION: "2025.04.14" # Manually defined version for OpenMS
145+
# This version should be manually updated for each release
146+
OPENMS_VERSION: "2025.04.12" # Format: YYYY.MM.DD
134147

135148
steps:
136149
- name: Checkout repository
@@ -145,6 +158,14 @@ jobs:
145158
registry: ghcr.io
146159
username: ${{ github.actor }}
147160
password: ${{ secrets.GHCR_TOKEN }}
161+
162+
- name: Install GitHub CLI
163+
run: |
164+
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
165+
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
166+
sudo apt update
167+
sudo apt install gh
168+
gh auth login --with-token <<< "${{ secrets.GHCR_TOKEN }}"
148169
149170
- name: Pull OpenMS Docker container
150171
id: pull_docker
@@ -172,6 +193,13 @@ jobs:
172193
docker push $TARGET_CONTAINER
173194
}
174195
196+
# Make the package public
197+
echo "Making package public"
198+
gh api --method PATCH /orgs/bigbio/packages/container/openms-tools-thirdparty/visibility \
199+
-f visibility="public" \
200+
-H "Accept: application/vnd.github+json" \
201+
-H "X-GitHub-Api-Version: 2022-11-28"
202+
175203
# If this is a release push or a GitHub release event, also tag as latest
176204
if [[ "${{ github.event.inputs.push_release }}" == "true" || "${{ github.event_name }}" == "release" ]]; then
177205
LATEST_IMAGE="ghcr.io/bigbio/openms-tools-thirdparty:latest"
@@ -225,6 +253,13 @@ jobs:
225253
singularity push openms-tools-thirdparty.sif oras://ghcr.io/bigbio/openms-tools-thirdparty-sif:${{ env.OPENMS_VERSION }}
226254
}
227255
256+
# Make the SIF package public
257+
echo "Making SIF package public"
258+
gh api --method PATCH /orgs/bigbio/packages/container/openms-tools-thirdparty-sif/visibility \
259+
-f visibility="public" \
260+
-H "Accept: application/vnd.github+json" \
261+
-H "X-GitHub-Api-Version: 2022-11-28"
262+
228263
# If this is a release push or a GitHub release event, also tag as latest
229264
if [[ "${{ github.event.inputs.push_release }}" == "true" || "${{ github.event_name }}" == "release" ]]; then
230265
echo "Pushing OpenMS SIF as latest"

README.md

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,27 +21,30 @@ These containerized versions offer:
2121

2222
### DIA-NN Containers
2323

24-
quantms team do not distribute the DIANN containers for versions superior to 1.8.0. The user has to build the container locally using the following command:
24+
**Important**: Due to licensing restrictions, DiaNN containers are not publicly distributed. Users must build these containers locally:
2525

2626
```bash
27+
# Build Docker container
28+
cd diann-2.1.0/
2729
docker build -t diann:2.1.0 .
28-
```
29-
30-
To build the singularity container, the user has to run the following command:
3130

32-
```bash
31+
# Build Singularity container from Docker
3332
singularity build diann-2.1.0.sif docker-daemon://diann:2.1.0
3433
```
3534

3635
### OpenMS Containers
3736

37+
OpenMS containers are publicly available and can be pulled directly:
38+
3839
| Container Type | Version | URL |
3940
|----------------|---------|-----|
4041
| Docker | date-tagged | `ghcr.io/bigbio/openms-tools-thirdparty:YYYY.MM.DD` |
4142
| Docker | latest | `ghcr.io/bigbio/openms-tools-thirdparty:latest` |
4243
| Singularity | date-tagged | `oras://ghcr.io/bigbio/openms-tools-thirdparty-sif:YYYY.MM.DD` |
4344
| Singularity | latest | `oras://ghcr.io/bigbio/openms-tools-thirdparty-sif:latest` |
4445

46+
The date tag (YYYY.MM.DD) is manually set for each release to ensure version stability.
47+
4548
## ⚠️ Important License Information
4649

4750
Please note the following license restrictions:
@@ -169,6 +172,37 @@ Common issues and solutions:
169172
- Increase Docker memory allocation in Docker Desktop settings
170173
- Use `--memory` flag to specify container memory limit
171174

175+
3. **OpenMS Singularity Pull Issues**
176+
177+
If you encounter an error when pulling OpenMS Singularity images:
178+
```
179+
FATAL: While pulling image from oci registry: error fetching image to cache: failed to get checksum for oras://ghcr.io/bigbio/openms-tools-thirdparty-sif:YYYY.MM.DD: GET https://ghcr.io/v2/bigbio/openms-tools-thirdparty-sif/manifests/YYYY.MM.DD: DENIED: requested access to the resource is denied
180+
```
181+
182+
Try the following:
183+
184+
- Verify you're using the correct date tag format (YYYY.MM.DD)
185+
- Check the workflow logs to confirm the exact version tag that was published
186+
- If using Nextflow, try increasing the pull timeout:
187+
```
188+
nextflow run bigbio/quantms -r dev -profile test_lfq,singularity -with-singularity --singularity.pullTimeout '2h'
189+
```
190+
- If the issue persists, please open an issue on the GitHub repository
191+
192+
4. **DiaNN Container Issues**
193+
194+
Remember that DiaNN containers must be built locally due to licensing restrictions:
195+
196+
- Follow the build instructions in the "DiaNN Containers" section
197+
- For quantms pipeline, specify your local DiaNN container path in a custom config file:
198+
```yaml
199+
process {
200+
withLabel: diann {
201+
container = '/path-to-your-singularity-file/diann-2.1.0.sif'
202+
}
203+
}
204+
```
205+
172206
## Maintainers
173207
174208
- Yasset Perez-Riverol ([@ypriverol](https://github.com/ypriverol)) - [ypriverol@gmail.com](mailto:ypriverol@gmail.com)

0 commit comments

Comments
 (0)