Skip to content

build: generate fvsOL's prms + help data artifacts (fix keyword-edito…#24

Merged
RoopsyDaisy merged 2 commits into
mainfrom
fvsol-data-artifacts
Jun 2, 2026
Merged

build: generate fvsOL's prms + help data artifacts (fix keyword-edito…#24
RoopsyDaisy merged 2 commits into
mainfrom
fvsol-data-artifacts

Conversation

@RoopsyDaisy

Copy link
Copy Markdown
Owner

…r crash)

fvsOL's makefile generates two data objects from source and gitignores them: data/prms.RData (the keyword-parameter catalog) and data/fvsOnlineHelpRender.RData (in-app help). Our build runs roxygenize + install but NOT the makefile's generation step, so both were missing from the WebGUI image. At runtime data(prms) fails ("data set 'prms' not found") and the GUI's keyword-component editor + help break. Basic runs/exports are unaffected, which is why it shipped unnoticed (and why only a GUI click-through surfaced it).

This is a fvs-containers build gap, not an upstream fvsOL bug (the makefile generates these correctly) and is unrelated to the RSQLite/encoding patches.

Fix: generate both artifacts before installing fvsOL, in both build paths:

  • docker/Dockerfile (webgui target): Rscript parms/mkpkeys.R + inst/extdata/mkhelp.R
  • .devcontainer/postCreate.sh: same, via R source() with renv active

Regression guard: smoke_test.R gains an fvsOL/data-artifacts check that asserts prms, fvsOnlineHelpRender, and treeforms all load (fvsOnlineHelpRender.RData loads as object fvshelp, so it checks each dataset loads something, not a fixed name). smoke_test.R gates both ci.yaml and publish.yaml, so a build that drops the generation step now goes red. Validated: guard FALSE without the artifacts, TRUE with them.

What & why

Checklist

  • CI is green (build + in-image smoke test + R test suite).
  • Docs updated to match any code/behaviour change (this repo has drifted before — keep prose true).
  • Tests added/updated for the change (tests/unit or tests/integration), or N/A.
  • No data, secrets, or chat history committed (inventory CSVs stay out — see data/README.md).

RoopsyDaisy and others added 2 commits June 2, 2026 21:26
…r crash)

fvsOL's makefile generates two data objects from source and gitignores them:
data/prms.RData (the keyword-parameter catalog) and data/fvsOnlineHelpRender.RData
(in-app help). Our build runs roxygenize + install but NOT the makefile's
generation step, so both were missing from the WebGUI image. At runtime
`data(prms)` fails ("data set 'prms' not found") and the GUI's keyword-component
editor + help break. Basic runs/exports are unaffected, which is why it shipped
unnoticed (and why only a GUI click-through surfaced it).

This is a fvs-containers build gap, not an upstream fvsOL bug (the makefile
generates these correctly) and is unrelated to the RSQLite/encoding patches.

Fix: generate both artifacts before installing fvsOL, in both build paths:
- docker/Dockerfile (webgui target): Rscript parms/mkpkeys.R + inst/extdata/mkhelp.R
- .devcontainer/postCreate.sh: same, via R source() with renv active

Regression guard: smoke_test.R gains an fvsOL/data-artifacts check that asserts
prms, fvsOnlineHelpRender, and treeforms all load (fvsOnlineHelpRender.RData
loads as object `fvshelp`, so it checks each dataset loads *something*, not a
fixed name). smoke_test.R gates both ci.yaml and publish.yaml, so a build that
drops the generation step now goes red. Validated: guard FALSE without the
artifacts, TRUE with them.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…hadolint DL3003)

The webgui data-artifact generation step used `RUN cd /src/fvs-interface/fvsOL
&& ...`, which trips hadolint DL3003 ("Use WORKDIR to switch to a directory") and
fails the blocking pre-commit lint gate. Switch to WORKDIR (the repo's convention;
.hadolint.yaml deliberately doesn't ignore DL3003). The relative mkpkeys.R/mkhelp.R
paths still resolve, the roxygenize/install uses absolute paths, and the existing
`WORKDIR /work` below resets cwd for runtime -- no behavior change.

https://claude.ai/code/session_011C6wxKosiwHnEYvAPJfmcW
@RoopsyDaisy RoopsyDaisy merged commit cfea260 into main Jun 2, 2026
6 checks passed
@RoopsyDaisy RoopsyDaisy deleted the fvsol-data-artifacts branch June 3, 2026 02:01
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