Skip to content

Point the docs at main, and give Docker runs a writable home - #15

Merged
Paururo merged 1 commit into
mainfrom
fix/docs-links-docker-home
Sep 24, 2026
Merged

Paururo merged 1 commit into
mainfrom
fix/docs-links-docker-home

Conversation

@Paururo

@Paururo Paururo commented Sep 24, 2026

Copy link
Copy Markdown
Member

What changed and why

Three small fixes found while working on #13 and #14.

  • Dead links in the docs. Eight links in five pages, and every page's Edit this page button (edit_uri in mkdocs.yml), pointed at indel-mask, a branch merged and deleted since. They now point at main, and every target was checked to exist there.
  • HOME under the docker profile. The container runs as the invoking user (-u $(id -u):$(id -g)), who has no home in the image. So HOME was / and read-only: genmap, MultiQC and Java could not keep their settings, and software_versions.txt recorded genmap's mkdir error as its version (seen in the first end-to-end run of Run the pipeline for real in CI, on a cohort whose truth is known #14). The profile now adds -e HOME=/tmp.
  • What aa_change holds in the SNP matrix. outputs.md said that where codon_change is filled, aa_change is what the base names alone. The first complete end-to-end run of Run the pipeline for real in CI, on a cohort whose truth is known #14 showed otherwise. By default the matrix reads FreeBayes' annotated raw VCF, where two changes of one codon on the same reads are one record annotated as the codon they make (CAC>GAG gives His145Glu on both bases). The page now says which VCF gives which, and the report's help no longer implies that a row's own change is per base.

Outputs and defaults

  • Outputs: no change, except that under docker genmap's version is recorded rather than an error.
  • Cluster runs: Singularity, and so every cluster profile, is untouched.

How it was verified

ruff check .                                                   # clean
python -m pytest tests/unit -q                                 # 2218 passed, 39 skipped
node --test tests/js/*.test.mjs                                # 120 passed
mkdocs build --strict                                          # passes; the built pages link edit/main/docs
python -m pytest tests/pipeline/test_container_scheme_per_profile.py -q   # 7 passed
nextflow config -profile local,docker .                        # runOptions = '-u $(id -u):$(id -g) -e HOME=/tmp'

Checklist

  • tests/run_tests.sh passes: lint, unit and js locally; the pipeline leg in CI (a config-only change there, whose container tests pass locally)
  • ruff check . is clean, and I did not restyle code the change does not touch
  • New or changed behaviour has a test (not here: the HOME change is held by Run the pipeline for real in CI, on a cohort whose truth is known #14's end-to-end check on genmap's version once both are in)
  • A new process in modules/ has a stub: block, and -profile test_full reaches it (not applicable: no new process)
  • tests/data/ was not edited by hand
  • User-visible changes have a CHANGELOG.md entry and, where relevant, a docs update

Eight links in the docs, and every page's Edit this page button,
pointed at indel-mask, a branch merged and deleted since, so they led
nowhere. They now point at main.

Under the docker profile the container runs as the invoking user, who
has no home in the image: HOME was / and read-only, so genmap, MultiQC
and Java could not keep their settings, and genmap's version was
recorded as a mkdir error. The profile now sets HOME=/tmp.

The outputs page said that where a SNP's codon_change is filled, its
aa_change is what the base names alone. The first end-to-end run
showed otherwise: by default the matrix reads FreeBayes' raw VCF, where
two changes of one codon on the same reads are one record annotated as
the codon they make, so aa_change already names it. The page and the
report's help now say which VCF gives which.
@Paururo
Paururo merged commit db91110 into main Sep 24, 2026
7 checks passed
@Paururo
Paururo deleted the fix/docs-links-docker-home branch September 24, 2026 20:23
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.

1 participant