Skip to content

docs: link cwl-docker-extract from CWL_SINGULARITY_CACHE help (#1537)#2289

Draft
arimu1 wants to merge 2 commits into
common-workflow-language:mainfrom
arimu1:docs/1537-document-singularity-cache
Draft

docs: link cwl-docker-extract from CWL_SINGULARITY_CACHE help (#1537)#2289
arimu1 wants to merge 2 commits into
common-workflow-language:mainfrom
arimu1:docs/1537-document-singularity-cache

Conversation

@arimu1

@arimu1 arimu1 commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Summary

Addresses #1537, which asked to document CWL_SINGULARITY_CACHE and link to the cwl-utils Pull the all referenced software container images reference.

The variable is now listed in the environment-variable table (introduced when the CLI groups were reorganized), so it appears in cwltool --help and the autogenerated Sphinx CLI docs. What was still missing is the second half of the request: pointing users at how to pre-populate that cache.

Change

Extend the CWL_SINGULARITY_CACHE entry in cwltool/argparser.py to link to cwl-utils' cwl-docker-extract, which pre-pulls all referenced container images into a directory. It uses the existing [link=...] markup (same as the ORCID entry), so it renders correctly in both outputs:

cwltool --help (terminal hyperlink):

CWL_SINGULARITY_CACHE │ directory path to find already downloaded
                      │ Singularity images; dockerFile images will also be
                      │ searched for and stored here. Images can be
                      │ pre-pulled into this directory using
                      │ cwl-docker-extract from cwl-utils

Sphinx CLI docs (reStructuredText):

.. envvar:: CWL_SINGULARITY_CACHE

    directory path to find already downloaded Singularity images; ``dockerFile`` images
    will also be searched for and stored here. Images can be pre-pulled into this directory
    using `cwl-docker-extract <https://github.com/common-workflow-language/cwl-utils#pull-the-all-referenced-software-container-images>`__ from cwl-utils

Verified the cwl-utils anchor still resolves, the parser still builds, and black/flake8 are clean. Docs-only string change. Once this lands, #1537 can be closed.


This change was produced with the assistance of Claude Code (model: Claude Opus). It was reviewed by a human before submission.

Comment thread cwltool/argparser.py Outdated
f"[{bt}]dockerFile[/] images will also be searched for and stored here",
f"[{bt}]dockerFile[/] images will also be searched for and stored here. "
f"Images can be pre-pulled into this directory using "
f"[link=https://github.com/common-workflow-language/cwl-utils#pull-the-all-referenced-software-container-images]cwl-docker-extract[/] from cwl-utils",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@arimu1

arimu1 commented Jun 20, 2026

Copy link
Copy Markdown
Contributor Author

Good call — switched the link to the stable cwl-utils docs page: https://cwl-utils.readthedocs.io/en/latest/#cwl-docker-extract (confirmed the #cwl-docker-extract anchor is present). Pushed.

@mr-c mr-c marked this pull request as draft June 25, 2026 13:35
@arimu1 arimu1 force-pushed the docs/1537-document-singularity-cache branch from f949b67 to 09ee1f1 Compare June 28, 2026 06:39
@codecov

codecov Bot commented Jun 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.18%. Comparing base (5634342) to head (cb0e671).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2289   +/-   ##
=======================================
  Coverage   85.18%   85.18%           
=======================================
  Files          46       46           
  Lines        8593     8593           
  Branches     2011     2011           
=======================================
  Hits         7320     7320           
  Misses        807      807           
  Partials      466      466           

☔ View full report in Codecov by Harness.
📢 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@arimu1 arimu1 force-pushed the docs/1537-document-singularity-cache branch 3 times, most recently from 1695a60 to 01b644b Compare June 28, 2026 10:38
arimu1 and others added 2 commits July 11, 2026 10:17
…-workflow-language#1537)

Issue common-workflow-language#1537 asked to document CWL_SINGULARITY_CACHE and link to the
cwl-utils "pull all referenced software container images" reference.

The variable itself is now listed in the environment-variable table
(shown in `cwltool --help` and the Sphinx CLI docs), but it did not
point users at how to pre-populate the cache. Add a link to
cwl-utils' cwl-docker-extract, using the existing [link=...] markup
so it renders both as a terminal hyperlink and as a reStructuredText
link in the generated docs.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…workflow-language#1537)

Per review feedback, link to the stable cwl-utils documentation page
(https://cwl-utils.readthedocs.io/en/latest/#cwl-docker-extract) instead
of the GitHub README anchor.
@arimu1 arimu1 force-pushed the docs/1537-document-singularity-cache branch from 01b644b to cb0e671 Compare July 11, 2026 03:17
@arimu1

arimu1 commented Jul 11, 2026

Copy link
Copy Markdown
Contributor Author

Updated per review — the link now points to https://cwl-utils.readthedocs.io/en/latest/#cwl-docker-extract instead of the GitHub README anchor. Also rebased onto current main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants