@@ -2,11 +2,50 @@

 An [Ansible][] [role][] for deploying [dotfile][]s on [Unix-like][]s.

+Takes [Git][] repository [URL][]s in the variable `dotfiles`, clones them into

+subdirectories of `$HOME/.dotfiles` (overridable with the variable

+`dotfiles_dir`) and uses [`stow`][] (which must be present on the target

+system!) to [symlink][] the contents into the parent directory of

+`dotfiles_dir` (overridable with the variable `dotfiles_target`).

+

 [`ansible-role-dotfiles`]: https://git.rcrnstn.net/rcrnstn/ansible-role-dotfiles

 [Ansible]: https://docs.ansible.com/ansible

 [role]: https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html

 [dotfile]: https://en.wikipedia.org/wiki/Hidden_file_and_hidden_directory#Unix_and_Unix-like_environments

 [Unix-like]: https://en.wikipedia.org/wiki/Unix-like

+[Git]: https://git-scm.com

+[URL]: https://en.wikipedia.org/wiki/URL

+[symlink]: https://en.wikipedia.org/wiki/Symbolic_link

+[`stow`]: https://www.gnu.org/software/stow/

+

+## Usage

+

+Example [`requirements.yml`][]:

+

+```yaml

+---

+

+roles:

+  - name: 'dotfiles'

+    src: 'https://git.rcrnstn.net/rcrnstn/ansible-role-dotfiles'

+    scm: 'git'

+```

+

+Example [playbook][]:

+

+```yaml

+---

+

+- hosts: 'all'

+  roles:

+    - role: 'dotfiles'

+      dotfiles:

+        - 'https://github.com/user/dotfiles-program1'

+        - 'https://github.com/user/dotfiles-program2'

+```

+

+[`requirements.yml`]: https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#installing-multiple-roles-from-a-file

+[playbook]: https://docs.ansible.com/ansible/latest/user_guide/playbooks.html

 ## License

new file mode 100644

@@ -0,0 +1,4 @@

+---

+

+dotfiles_dir:    '{{ ansible_env.HOME }}/.dotfiles'

+dotfiles_target: '{{ dotfiles_dir     }}/..'

new file mode 100644

@@ -0,0 +1,20 @@

+---

+

+- name: 'Clone {{ item | basename }}'

+  git:

+    repo: '{{ item }}'

+    dest: '{{ dotfiles_dir }}/{{ item | basename }}'

+

+- name: 'Stow {{ item | basename }}'

+  command:

+    argv:

+      - 'stow'

+      - '--verbose'

+      - '--no-folding'

+      - '--dir'

+      - '{{ dotfiles_dir }}'

+      - '--target'

+      - '{{ dotfiles_target }}'

+      - '{{ item | basename }}'

+  register: result

+  changed_when: result.stderr != ''

new file mode 100644

@@ -0,0 +1,14 @@

+---

+

+- name: 'Dotfiles'

+  include_tasks: 'dotfiles.yml'

+  loop: '{{ dotfiles }}'

+

+- name: 'Check stow: {{ dotfiles_target }}'

+  command:

+    argv:

+      - 'chkstow'

+      - '--target'

+      - '{{ dotfiles_target }}'

+  register: result

+  changed_when: result.stdout != ''