chore: remove deprecated --keep flag from docs, scripts, and e2e tests#2126
Open
Ygnas wants to merge 2 commits into
Open
chore: remove deprecated --keep flag from docs, scripts, and e2e tests#2126Ygnas wants to merge 2 commits into
Ygnas wants to merge 2 commits into
Conversation
The --keep flag is deprecated, hidden, and a no-op since sandboxes are kept by default. Remove references from tutorial docs and example READMEs that explain it as a real feature. - Remove --keep from sandbox create commands - Remove --keep explanation text - Clarify that sandboxes are kept by default Signed-off-by: Ignas Baranauskas <ibaranau@redhat.com>
Ygnas
requested review from
a team,
derekwaynecarr,
maxamillion and
mrunalp
as code owners
|
All contributors have signed the DCO ✍️ ✅ |
Author
|
I have read the DCO document and I hereby sign the DCO. |
Author
|
recheck |
The --keep flag is a deprecated no-op since sandboxes are kept by default. Stop passing it in internal scripts, e2e test scripts, and example demo scripts. Signed-off-by: Ignas Baranauskas <ibaranau@redhat.com>
Ygnas
changed the title
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
2 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.
Summary
Remove references to the deprecated
--keepflag from tutorials, exampleREADMEs, internal scripts, and e2e test scripts. The flag is hidden
(
hide = true), deprecated, and a no-op since sandboxes are kept by default.Users and scripts were using a flag that does nothing.
The
--keepflag definition in the CLI is not removed — it remains as ahidden, backward-compatible no-op for external users who may depend on it.
Related Issue
N/A — standalone cleanup. The
--keepflag is declared deprecatedat
crates/openshell-cli/src/main.rs:1247-1249.Changes
--keepfromsandbox createcommands in tutorials, examples,internal scripts, and e2e test scripts
--keepexplanation text that described it as a real feature--no-keepmentions where sandbox persistence is explained, so usersknow how to opt into auto-deletion
Files changed
docs/get-started/tutorials/first-network-policy.mdxdocs/get-started/tutorials/microsoft-graph-provider-refresh.mdxexamples/sandbox-policy-quickstart/README.mdexamples/policy-advisor/README.mdexamples/spiffe-token-grant-demo/README.mdscripts/agents/gator/README.mdscripts/smoke-test-network-policy.shexamples/sandbox-policy-quickstart/demo.shexamples/spiffe-token-grant-demo/demo.shtasks/scripts/vm/smoke-orphan-cleanup.she2e/policy-advisor/test.she2e/policy-advisor/wait-smoke.she2e/policy-advisor/mechanistic-smoke.shIntentionally left unchanged
scripts/agents/run.sh— Has its own--keepflag that controlswhether
--no-keepis passed to the CLI. Already correctly adapted.e2e/rust/src/harness/sandbox.rs—create_keep()passes--keepto the CLI, providing implicit backward-compatibility test coverage.
e2e/rust/tests/sync.rsandlive_policy_update.rs— Commentsreference
--keepin the context of the Rust test harness above.Testing
mise run testpassesChecklist