1 true 2009-01-21T00:16:22+00:00 27076 66 add-git-clean-to-prevent-sub-module-detritus 0 8716 hold git patch 2009-08-04T10:20:56+01:00 1379 Lee Hambley Darrell Fuhriman http://capistrano.lighthouseapp.com/projects/8716/tickets/66 If a git submodule is removed through the course of development, its files will never be removed from the cached-copy, potentially causing problems in the deployed version. See some discussion here: http://groups.google.com/group/capistrano/browse_thread/thread/a4ef2f940d090644 The attached patch adds a 'git clean' after the 'git reset --hard' to remove any remaining submodules. Another possibility could be to optionally define a set of directories/files which the git clean would affect instead of acting on the entire repository. For instance, only execute the git-clean in the vendor directory. If a git submodule is removed through the course of development, its files will never be removed from the cached-copy, potentially causing problems in the deployed version. See some discussion here: http://groups.google.com/group/capistrano/browse_thread/thread/a4ef2f940d090644 The attached patch adds a 'git clean' after the 'git reset --hard' to remove any remaining submodules. Another possibility could be to optionally define a set of directories/files which the git clean would affect instead of acting on the entire repository. For instance, only execute the git-clean in the vendor directory. <div><p>If a git submodule is removed through the course of development, its files will never be removed from the cached-copy, potentially causing problems in the deployed version.</p> <p>See some discussion here: <a href="http://groups.google.com/group/capistrano/browse_thread/thread/a4ef2f940d090644"> http://groups.google.com/group/c...</a></p> <p>The attached patch adds a 'git clean' after the 'git reset --hard' to remove any remaining submodules.</p> <p>Another possibility could be to optionally define a set of directories/files which the git clean would affect instead of acting on the entire repository. For instance, only execute the git-clean in the vendor directory.</p></div> 15202 0 If a git submodule is removed through the course of development, its files will never be removed from the cached-copy, potentially causing problems in the deployed version. See some discussion here: http://groups.google.com/group/capistrano/browse_thread/thread/a4ef2f940d090644 The attached patch adds a 'git clean' after the 'git reset --hard' to remove any remaining submodules. Another possibility could be to optionally define a set of directories/files which the git clean would affect instead of acting on the entire repository. For instance, only execute the git-clean in the vendor directory. <div><p>If a git submodule is removed through the course of development, its files will never be removed from the cached-copy, potentially causing problems in the deployed version.</p> <p>See some discussion here: <a href="http://groups.google.com/group/capistrano/browse_thread/thread/a4ef2f940d090644"> http://groups.google.com/group/c...</a></p> <p>The attached patch adds a 'git clean' after the 'git reset --hard' to remove any remaining submodules.</p> <p>Another possibility could be to optionally define a set of directories/files which the git clean would affect instead of acting on the entire repository. For instance, only execute the git-clean in the vendor directory.</p></div> false 2009-01-21T00:16:22+00:00 27076 --- {} 66 add-git-clean-to-prevent-sub-module-detritus 0 8716 new git patch 2009-01-21T00:16:24+00:00 27076 Darrell Fuhriman Darrell Fuhriman http://capistrano.lighthouseapp.com/projects/8716/tickets/66 Jamis Buck 15202 1 I worry, somewhat, about using git clean like this. I'm not entirely sure that it wouldn't lead to a situation where files are removed that were not intended to be removed. It is true that if git.sync(...) is used only internally by the deployment code, this patch is probably fine. But the fact is that people continually surprise me with the ways they use this stuff, and I'd hate for someone to lose valuable files (like customer images or something) that just happened to be where we weren't expecting them to be. The fact is, it's just not something you'd expect "scm.sync" to do: deleting untracked files. I think it might be best if, instead of making the git clean part of the sync operation, you did it as a task that you hooked onto the end of the update-code hook. e.g. @@@ task :cleanup_stuff do run "cd #{release_path} && git clean -dxf" end after "deploy:update_code", :cleanup_stuff @@@ What are your thoughts on this? Does a post-update hook like that work in your case? <div><p>I worry, somewhat, about using git clean like this. I'm not entirely sure that it wouldn't lead to a situation where files are removed that were not intended to be removed. It is true that if git.sync(...) is used only internally by the deployment code, this patch is probably fine. But the fact is that people continually surprise me with the ways they use this stuff, and I'd hate for someone to lose valuable files (like customer images or something) that just happened to be where we weren't expecting them to be.</p> <p>The fact is, it's just not something you'd expect "scm.sync" to do: deleting untracked files.</p> <p>I think it might be best if, instead of making the git clean part of the sync operation, you did it as a task that you hooked onto the end of the update-code hook. e.g.</p> <pre><code> task :cleanup_stuff do run &quot;cd #{release_path} &amp;&amp; git clean -dxf&quot; end after &quot;deploy:update_code&quot;, :cleanup_stuff </code></pre> <p>What are your thoughts on this? Does a post-update hook like that work in your case?</p></div> false 2009-02-05T04:22:57+00:00 27076 --- :state: new 66 add-git-clean-to-prevent-sub-module-detritus 0 8716 open git patch 2009-02-05T04:23:00+00:00 15202 Jamis Buck Darrell Fuhriman http://capistrano.lighthouseapp.com/projects/8716/tickets/66 Jamis Buck 15202 1 Yes, that should work. It also occurs to me that simply finding and cleaning only removed submodule directories that are not tracked anymore might help. That should be relatively safe, although finding those directories is a bit of a pain. Maybe like this: if git_enable_submodules paths=`git whatchanged -m -p .gitmodules`.map{ |l| if l =~ /^-\s+path\s*=\s*(.*)/ $1 else nil end }.compact untracked=`git ls-files --others --exclude-standard --directory`.split("\n") paths.each do |p| next unless untracked[p] `git clean -df #{p}` end end Although I have to admit I'm worried it would be a bit too fragile, but then again, maybe not. <div><p>Yes, that should work. It also occurs to me that simply finding and cleaning only removed submodule directories that are not tracked anymore might help. That should be relatively safe, although finding those directories is a bit of a pain. Maybe like this:</p> <p>if git_enable_submodules paths=<code>git whatchanged -m -p .gitmodules</code>.map{ |l| if l =~ /^-\s+path\s<em>=\s</em>(.*)/</p> <pre> <code>$1 </code> </pre> <p>else</p> <pre> <code>nil </code> </pre> <p>end }.compact untracked=<code>git ls-files --others --exclude-standard --directory</code>.split("\n") paths.each do |p| next unless untracked[p]</p> <pre> <code>`git clean -df #{p}` </code> </pre> <p>end end</p> <p>Although I have to admit I'm worried it would be a bit too fragile, but then again, maybe not.</p></div> false 2009-02-05T18:59:04+00:00 27076 --- {} 66 add-git-clean-to-prevent-sub-module-detritus 0 8716 open git patch 2009-02-05T18:59:07+00:00 27076 Darrell Fuhriman Darrell Fuhriman http://capistrano.lighthouseapp.com/projects/8716/tickets/66 Jamis Buck 15202 1 apparently, I should have wrapped that code. Sorry. @@@ if :git_enable_submodules == true paths=`git whatchanged -m -p .gitmodules`.map{ |l| if l =~ /^-\s+path\s*=\s*(.*)/ $1 else nil end }.compact untracked=`git ls-files --others --exclude-standard --directory`.split("\n") paths.each do |p| next if untracked[p] `git clean -df #{p}` end end @@@ <div><p>apparently, I should have wrapped that code. Sorry.</p> <pre><code> if :git_enable_submodules == true paths=`git whatchanged -m -p .gitmodules`.map{ |l| if l =~ /^-\s+path\s*=\s*(.*)/ $1 else nil end }.compact untracked=`git ls-files --others --exclude-standard --directory`.split(&quot;\n&quot;) paths.each do |p| next if untracked[p] `git clean -df #{p}` end end </code></pre></div> false 2009-02-05T19:04:13+00:00 27076 --- {} 66 add-git-clean-to-prevent-sub-module-detritus 0 8716 open git patch 2009-02-05T19:04:18+00:00 27076 Darrell Fuhriman Darrell Fuhriman http://capistrano.lighthouseapp.com/projects/8716/tickets/66 Jamis Buck 15202 1 And further, I should post the version with the right logic. *sigh* Time for more coffee... @@@ if :git_enable_submodules paths=`git whatchanged -m -p .gitmodules`.map{ |l| if l =~ /^-\s+path\s*=\s*(.*)/ $1 else nil end }.compact untracked=`git ls-files --others --exclude-standard --directory`.split("\n") paths.each do |p| next unless untracked[p] `git clean -df #{p}` end end @@@ <div><p>And further, I should post the version with the right logic. <em>sigh</em> Time for more coffee...</p> <pre><code> if :git_enable_submodules paths=`git whatchanged -m -p .gitmodules`.map{ |l| if l =~ /^-\s+path\s*=\s*(.*)/ $1 else nil end }.compact untracked=`git ls-files --others --exclude-standard --directory`.split(&quot;\n&quot;) paths.each do |p| next unless untracked[p] `git clean -df #{p}` end end </code></pre></div> false 2009-02-05T19:19:25+00:00 27076 --- {} 66 add-git-clean-to-prevent-sub-module-detritus 0 8716 open git patch 2009-02-05T19:19:29+00:00 27076 Darrell Fuhriman Darrell Fuhriman http://capistrano.lighthouseapp.com/projects/8716/tickets/66 Jamis Buck 1 How would people like this ticket to be handled, it looks like a consensus was reached here and this can be closed as [invalid]? <div><p>How would people like this ticket to be handled, it looks like a consensus was reached here and this can be closed as <a href= "/projects/8716/changesets/invalid" title= "Changeset [invalid]">[invalid]</a>?</p></div> true 2009-08-04T10:20:51+01:00 27076 --- :state: open :assigned_user: 15202 66 add-git-clean-to-prevent-sub-module-detritus 0 8716 hold git patch 2009-08-04T10:20:56+01:00 1379 Lee Hambley Darrell Fuhriman http://capistrano.lighthouseapp.com/projects/8716/tickets/66 15593373592d038ce5d4b2fd5951b1161634b9f1 text/plain 2009-01-21T00:16:22+00:00 git_clean.patch 80286 638 27076 http://capistrano.lighthouseapp.com/attachments/80286/git_clean.patch