docs: clarify --prune scope for streamlit deploy#3067
Open
afeld wants to merge 1 commit into
Open
Conversation
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
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.
Pre-review checklist
If my changes add or modify user-facing interface (commands, flags, output formats), I consulted maintainers and got sign-off beforehand (how).RELEASE-NOTES.md(see when and how).Changes description
snow streamlit deploy --prunehelp text says "Delete files that exist in the stage, but not in the local filesystem." This is ambiguous — it implies the entire stage is pruned, when in fact pruning is scoped to the individual app's subdirectory (@<stage>/<app-name>/) … as far as I can tell. I used Cortex Code to inspect the code paths, and here was its explanation:Slightly difficult to troubleshoot, so would love verification on this.
This matters when multiple apps share the same default
streamlitstage: users may avoid--pruneunnecessarily, fearing it will delete other apps' files.There could/should be tests for this, but to be honest, I don't have time to dig into that.
Thanks!