Skip to content

Conversation

@ErikDanielsson
Copy link
Contributor

@ErikDanielsson ErikDanielsson commented Aug 8, 2025

This is a follow up PR on the large nf-core pipelines download refactor PR #3634, and should be merged AFTER it.

This PR replaces the load command for Docker images that is printed to the command line in #3634 with shell scripts copied to the output container folder. I've added support for both Docker and Podman. The latter one might need more testing before releasing it into the wild since we need to manually capture the image name and tag from the manifest.json in the Docker image tar archive, and retag the images. My testing suggests that this approach works however.

The load scripts are put inside nf_core/pipelines/download/load_scripts/ and read using the importlib.resources function. If there is a better place to keep the files and load them please feel free to change this logic!

I've tested the Docker/Podman script on nf-core/bamtofastq by loading the images into Docker/Podman an dsubsequently running the pipeline with the test profile. Since the tests use the test-dataset repo I've not run it in a fully offline environment, but instead looked at the pull events from Docker/Podman. From what I can tell it looks to be working correctly. It would however be awesome if someone with experience running pipelines in a fully offline environment tested the scripts.

For diff with the base branch see: ErikDanielsson#2

PR checklist

  • This comment contains a description of changes (with reason)
  • CHANGELOG.md is updated
  • If you've fixed a bug or added code that should be tested, add tests!
  • Documentation in docs is updated

@codecov
Copy link

codecov bot commented Aug 8, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.76%. Comparing base (d745975) to head (1fa9c0d).
⚠️ Report is 23 commits behind head on dev.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ErikDanielsson ErikDanielsson added the download nf-core download label Aug 11, 2025
@ErikDanielsson
Copy link
Contributor Author

Docs updated in nf-core/website#3463

Copy link
Contributor

@JulianFlesch JulianFlesch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a check if podman/docker cli are installed. Add check if a podman machines or docker daemon is found.

@JulianFlesch JulianFlesch merged commit 7420367 into nf-core:dev Aug 28, 2025
117 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in nf-core infrastructure projects Aug 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

download nf-core download

Projects

Development

Successfully merging this pull request may close these issues.

3 participants