Skip to content

Document the build and test variables added in 2.0.1 #415

Open

Description

@novatechflow

Docs improvement, not a release blocker. Found during the 2.0.1 QA on 3961b83.

#411 and #413 added build and test variables that aren't documented anywhere. None of them are runtime component settings, so the docs/operations.md environment variable index has no gap. Contributors running the release build or the browser demo test locally can't find these without reading the scripts.

Variable Read by What it does
REPO_ROOT addons/processors/iceberg-processor/Dockerfile (build arg, default .), deploy/docker/docker-bake.json, iceberg Makefile Path copied into the build as /src when building against the local platform source
DEMO_TEST_SKIP_BUILD scripts/test_browser_demo.sh 1 skips building the images and uses ones that already exist
DEMO_BASE_URL lfs-client-sdk/js-browser/demo/playwright.config.mjs (set by scripts/test_browser_demo.sh) Base URL for the Playwright demo tests, default http://127.0.0.1:3072
PUBLISH_IMAGES scripts/build_release_images.sh true pushes the release images, false (default) only builds; any other value fails
RELEASE_TAG scripts/build_release_images.sh Image tag and org.opencontainers.image.version label; must match v* and GITHUB_REF must be a tag when publishing
SOURCE_REVISION scripts/build_release_images.sh org.opencontainers.image.revision label

Suggested fix:

  • Add a short "Build and test variables" section to docs/development.md (or wherever the contributor build docs live) with the table above, defaults and allowed values.
  • Link it from the browser demo section of deploy/docker-compose/README.md (DEMO_TEST_SKIP_BUILD, DEMO_BASE_URL) and from the iceberg processor developer.md (REPO_ROOT next to USE_LOCAL_PLATFORM and MODULE_DIR).
  • Note that PUBLISH_IMAGES, RELEASE_TAG and SOURCE_REVISION are set by the release workflow and normally aren't set by hand.

Activity

  1. nextammy commented on Nov 20, 2026

    @nextammy

    Happy to take this one. I will add the build and test variables section to docs/development.md using the table from the issue, and link it from the compose README and the iceberg processor developer guide.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions