Skip to content

feat(examples): add requirements.txt to all example workloads - #880

Merged
janzak-dev merged 4 commits into
mainfrom
feat/examples-requirements
Sep 15, 2026
Merged

janzak-dev merged 4 commits into
mainfrom
feat/examples-requirements

Conversation

@janzak-dev

@janzak-dev janzak-dev commented Sep 15, 2026 •

Copy link
Copy Markdown
Collaborator

🥞 Stack Navigation


🏛️ Role in PR Stack Architecture

This PR serves as Layer 1 (Dependency Foundation & Packaging) within the 4-part multi-example execution and validation stack.

  • Stack Objective: Establish an automated, robust, end-to-end multi-example workload execution and validation framework running against xmc-nightly.
  • Layer 1 Role: Establishes standard Python requirements.txt manifests across all 12 example workloads and documents their usage in README.md files. This allows subsequent layers (the parallel CI runner in Layer 2 and test validator environments in Layers 3 & 4) to deterministically provision isolated client virtual environments.

Summary

Introduces standalone requirements.txt dependency manifests and setup documentation across all example workloads in examples/.

Motivation & Context

Each example workload directory requires explicit Python dependencies for local execution, CI matrix triggers, and isolated hermetic environments. By providing explicit manifests, we eliminate implicit environment assumptions and ensure deterministic CI builds.

Key Changes

  • Added requirements.txt manifests and documentation updates across all example workloads:
    • examples/chart_artifact_job/
    • examples/clickhouse_metrics_job/
    • examples/demo_workload/
    • examples/init_container_job/
    • examples/managed_xprof_artifact_job/
    • examples/metrics_dashboard_job/
    • examples/metrics_job/
    • examples/multipod_job/
    • examples/pathways_job/
    • examples/per_job_node_selector/
    • examples/sidecar/
    • examples/xdash_dashboard/

Assumptions

None — requirements were fully specified.

Verification & Testing

  • Commands Executed: ./.githooks/pre-commit check
  • Coverage & Test Status: Pre-commit hooks passed 100% (Buildifier, gofmt, addlicense, ruff, determinism).

Related Issues / Bugs

N/A

TAG=agy
CONV=606f1e41-6785-4137-b85b-cd0f56237339

Add standalone requirements.txt dependency manifests across all example
workload directories to enable isolated and hermetic environment setup
during test execution and multi-example runners.

TAG=agy
CONV=2889d5f4-f25d-4694-93f6-70447e012e6b

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request introduces requirements.txt files for various example workloads in the repository. The review feedback highlights that several of these files (specifically for pathways_job, per_job_node_selector, and xdash_dashboard) contain outdated dependency versions compared to other examples, and some are missing the protobuf dependency entirely. It is recommended to align these dependency versions across all examples to ensure consistency and prevent potential runtime issues.

Comment thread examples/pathways_job/requirements.txt Resolved
…eview

TAG=agy
CONV=606f1e41-6785-4137-b85b-cd0f56237339
…ADMEs

TAG=agy
CONV=606f1e41-6785-4137-b85b-cd0f56237339
…e READMEs

TAG=agy
CONV=606f1e41-6785-4137-b85b-cd0f56237339
@janzak-dev janzak-dev added the priority::2-high top of mind. should not wait. label Sep 15, 2026
@janzak-dev
janzak-dev marked this pull request as ready for review September 15, 2026 08:34
@github-actions
github-actions Bot requested a review from pachopepe September 15, 2026 08:34
@janzak-dev
janzak-dev added this pull request to the merge queue Sep 15, 2026
Merged via the queue into main with commit 36be0c3 Sep 15, 2026
12 checks passed
@janzak-dev
janzak-dev deleted the feat/examples-requirements branch September 15, 2026 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority::2-high top of mind. should not wait.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants