Remove the unused --output-dir flag; clarify project and custom-image guidance - #315
Merged
divyashreepathihalli merged 2 commits intoAug 19, 2026
Conversation
… guidance jobs_options declared --output-dir (envvar KINETIC_OUTPUT_DIR), but its only consumer, `kinetic jobs list`, never read the parameter. The flag was inert: KINETIC_OUTPUT_DIR is resolved at submit time in backend/execution.py, not by any jobs subcommand. Drop the option and mark the CLI column n/a in the configuration precedence table. The "project is required" errors named only --project and KINETIC_PROJECT, skipping the primary path: cli/main.py injects active profile fields into Click's default_map, so `kinetic init` is what most users want. Both the CLI (_ensure_project) and library (get_required_project) messages now lead with it. remote_runner.py imports absl at module load, so a custom image without absl-py fails at pod startup before the payload is unpickled. Name it in the --dockerfile help, the build_and_push_prebuilt_image docstring, and the containers guide. The auto-generated image is unaffected: _CORE_DEPS pins keras-kinetic, which depends on absl-py.
Apply the docs style rules to the prose from the previous commit: active voice, one idea per sentence, no passive constructions, and no gerund chains. - checkpointing.md: replace "by passing/by setting" and "Both are read" with imperative steps and an active statement of when Kinetic reads the value. - configuration.md: name the subject instead of the pronoun, and state the missing CLI flag as a fact about Kinetic. - containers.md and the --dockerfile help: split "must install X and COPY Y" into two sentences, because install and copy are separate actions. Say why the three packages are mandatory. Assert the package list against the authored help string. Click wraps at hyphens, so a rendered "google-cloud-storage" can span two lines.
JyotinderSingh
requested review from
divyashreepathihalli and
jeffcarp
as code owners
August 15, 2026 18:59
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request removes the unused --output-dir CLI option from the kinetic jobs commands and updates the documentation and tests accordingly. It also adds absl-py to the list of required packages for custom Dockerfiles and updates the error messages when no GCP project is configured to guide users to run kinetic init first. There are no review comments, so no feedback is provided.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #315 +/- ##
=======================================
Coverage ? 36.74%
=======================================
Files ? 83
Lines ? 15250
Branches ? 0
=======================================
Hits ? 5603
Misses ? 9647
Partials ? 0 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
divyashreepathihalli
approved these changes
Aug 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
jobs_optionsdeclared--output-dir(envvarKINETIC_OUTPUT_DIR), but its only consumer,kinetic jobs list, never read the parameter. The flag was inert:KINETIC_OUTPUT_DIRis resolved at submit time in backend/execution.py, not by any jobs subcommand. This change drops the option and mark the CLI column n/a in the configuration precedence table.The
"project is required"errors named only--projectandKINETIC_PROJECT, skipping the primary path: cli/main.py injects active profile fields into Click's default_map, sokinetic initis what most users want. Both the CLI (_ensure_project) and library (get_required_project) messages now lead with it.remote_runner.py imports absl at module load, so a custom image without absl-py fails at pod startup before the payload is unpickled. Name it in the --dockerfile help, the
build_and_push_prebuilt_imagedocstring, and the containers guide. The auto-generated image is unaffected: _CORE_DEPS pins keras-kinetic, which depends on absl-py.Contributor Agreement