[RFC] move gitignore file to .devbox directory and ignore gen/profile/shell_history #215
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
|
Current dependencies on/for this PR: This comment was auto-generated by Graphite. |
savil
commented
Oct 6, 2022
tmpl/.gitignore.tmpl
Outdated
Comment on lines
1
to
4
| profile* | ||
| nix-profile/ | ||
| shell_history |
There was a problem hiding this comment.
alternatively, this could be changed to:
*
.*
and later if adding features we want checked in, then we can modify this file as:
*
.*
!<feature>
There was a problem hiding this comment.
discussed IRL, and we'll move to this way.
savil
force-pushed
the
savil/gitignore-devbox
branch
from
bdfcedf to
8f34151
Compare
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.
Summary
With the recent use of nix-profile, the
profilesymlinks are showing up in git history.This is regrettable.
This PR adds a
.gitignorefile to.devboxdirectory and ignoring thegen/,profile*,
nix-profileandshell-historysymlinks.Going forward, we should avoid editing this file. Each edit will need to be checked
in by our users. So, this PR is a breaking change, in a sense.
New features we add that generate files in
.devboxshould be added insidegen/if they want to be gitignored.
New features that we do want users to check in (like a lock file) can be placed
in
.devbox/(and not.devbox/gen).How was it tested?
in a new devbox project, with
git initand initial files already committed:devbox shellto generate the gitignore and other filesgit statusto inspect changes and found no new file changes were reported.ls -al .devboxand saw the other files (like gen/ and profile* were generated) as well as.devbox/.gitignore.