docs update#82
Merged
Merged
Conversation
suryaoruganti
approved these changes
May 5, 2026
Comment on lines
+140
to
+151
| **Remove untracked files and directories:** | ||
|
|
||
| It might be useful to remove some secret files that were added during the job, | ||
| before making a snapshot. | ||
|
|
||
| - _git clean_: removes untracked files from the local git repo. | ||
| - _-f (force)_: forces the removal of files and directories. | ||
| - _-f (force again)_: if `git config clean.requireForce true` is present, some files | ||
| may not be removed without this flag. | ||
| - _-d (directories)_: removes directories not just files. | ||
| - _-x (ignore .gitignore)_: removes files and directories that are ignored by git. | ||
|
|
Collaborator
There was a problem hiding this comment.
do we need to write explaination for the git command here? It looks out of scope for this snapshot doc.
PrashantRaj18198
approved these changes
May 5, 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.
Note
Low Risk
Documentation-only changes that clarify supported runner types and recommended snapshot workflows; no code or behavior changes.
Overview
Updates
README.mdto clarify that snapshot runners only work on WarpBuild-managed Ubuntu runners (and that snapshot labels are ignored on unsupported runners), document snapshot retention (15 days) and/tmpnon-persistence, and add notes about slower boot times.Replaces prior conditional/container-focused examples with two clearer workflows: clean snapshot creation on
mainusingsnapshot.enabled=trueplus a gatedsnapshot-save, and incremental snapshots on feature branches usingsnapshot.key, along with expanded cleanup guidance (rm -rfcreds andgit clean -ffdx).Reviewed by Cursor Bugbot for commit 84b4764. Configure here.