Afraid of `git clean`

strarsis · June 22, 2020, 3:16pm

After merging in the latest trellis from master I noticed that it now also cleans up untracked files during deploy:

roots/trellis/blob/76337fd20e1a137be6487d473d2d8d4ee7997e9e/roles/deploy/tasks/update.yml#L36




- name: Failed connection to remote repo
  fail:
    msg: |
      Git repo {{ project.repo }} cannot be accessed. Please verify the repository exists and you have SSH forwarding set up correctly.
      More info:
      > https://roots.io/trellis/docs/deploys/#ssh-keys
      > https://roots.io/trellis/docs/ssh-keys/#cloning-remote-repo-using-ssh-agent-forwarding
  when: git_clone is failed


- name: Remove untracked files from project folder # noqa 303
  command: git clean -fdx
  args:
    chdir: "{{ project_source_path }}"
  register: git_clean
  changed_when: not not(git_clean.stdout)


- include_tasks: "{{ include_path }}"
  with_items: "{{ deploy_update_after | default([]) }}"
  loop_control:
    loop_var: include_path

My first reaction to this is that I am afraid of this. How is it ensured that the uploads/ folder is spared from this?

swalkinshaw · June 22, 2020, 3:40pm

Here’s what I was about to reply:

Those folders are all git ignored so they’re all ignored from this. This cleans untracked files from directories tracked in Git.

Then I noticed the -x option. From Git docs:

Don’t use the standard ignore rules (see gitignore(5)), but still use the ignore rules given with -e options from the command line. This allows removing all untracked files, including build products.

So uhh… you’re right to be afraid but I’m probably missing something myself here If we were deleting people’s uploads I’m sure we’d have heard about it by now??

My guess: because we symlink the shared uploads directory into the release every deploy this isn’t affected.

system · August 3, 2020, 3:16pm

This topic was automatically closed after 42 days. New replies are no longer allowed.