Repository navigation
Docs: keep changes out of the clone - #389
Draft
jackspiering wants to merge 2 commits into
Draft
jackspiering wants to merge 2 commits into
jackspiering wants to merge 2 commits into
Conversation
Add an optional README section for running a stack from a copy of its service directory, or from a compose.override.yaml, so git pull no longer collides with local changes. Refs #317.
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.
Description
Adds an optional README section, "Keep your changes out of the clone", placed after "Update a stack". It describes two ways to stop local changes from colliding with
git pull:.env, the Tailscale state, and the application data live outside the clone. It also says how to compare the copy'scompose.yamland.envwith upstream after agit pull, so that new variables are not missed.compose.override.yaml(singular, the name Compose loads automatically). Entries involumesreplace the entry with the same container path, so an override can also move data out of the clone. It does not cover.env.The Quick Start is unchanged, and no
compose.yamlor default data path changes. This is a reduced version of the proposal in #317, which also asks to move every default data path outside the repository. I left that out because it would need an "Upgrading" section for every stack.Draft, to discuss the scope before review.
Related Issues
Verification
docker compose config --quietfrom each changed service directory: not applicable, no service changedrumdl check --config .markdownlint.yml .on the whole repository (0.2.78, the version CI pins), andgit diff --check origin/maincompose.override.yamlthat mounts other host paths on/configand/var/lib/tailscale,docker compose config(Compose v5.6.0) showed the new bind sources and no old mount on those paths.Impact on existing users
Checklist
Additional Context
Open question for the maintainers: whether this belongs in the README at all, or only in
documentation/standard-setup.md, given that it adds a second workflow next to the Quick Start.