PR#8: Rename jwflory.teleirc => teleirc. - sig-teleirc/infrastructure

sig-teleirc / infrastructure

#8 Rename jwflory.teleirc => teleirc.

Closed 4 years ago by jflory7. Opened 4 years ago by tjzabel.

sig-teleirc/ tjzabel/infrastructure update/docs into master

Tim Zabel • 4 years ago

0d0bedd

playbooks/telegram-irc.yml

file modified

+1 -1

		`@@ -5,4 +5,4 @@`

		`roles:`
		`- { role: firewalld, tags: firewalld }`
		`- - { role: jwflory.teleirc, tags: teleirc }`
		`+ - { role: teleirc, tags: teleirc }`

roles/teleirc/LICENSE.txt ~~roles/jwflory.teleirc/LICENSE.txt~~

file renamed

file was moved with no change to the file

roles/teleirc/README.md ~~roles/jwflory.teleirc/README.md~~

file renamed

+2 -2

		`@@ -12,7 +12,7 @@`
		```yaml
		`- hosts: servers`
		`roles:`
		`- - role: jwflory.teleirc`
		`+ - role: teleirc`
		`become: yes`
		```

		`@@ -97,7 +97,7 @@`
		```yaml
		`- hosts: servers`
		`roles:`
		`- - role: jwflory.teleirc`
		`+ - role: teleirc`
		```

		`## License`

roles/teleirc/defaults/main.yml ~~roles/jwflory.teleirc/defaults/main.yml~~

file renamed

file was moved with no change to the file

roles/teleirc/handlers/main.yml ~~roles/jwflory.teleirc/handlers/main.yml~~

file renamed

file was moved with no change to the file

roles/teleirc/meta/.galaxy_install_info ~~roles/jwflory.teleirc/meta/.galaxy_install_info~~

file renamed

file was moved with no change to the file

roles/teleirc/meta/main.yml ~~roles/jwflory.teleirc/meta/main.yml~~

file renamed

file was moved with no change to the file

roles/teleirc/tasks/dependencies.yml ~~roles/jwflory.teleirc/tasks/dependencies.yml~~

file renamed

file was moved with no change to the file

roles/teleirc/tasks/imports.yml ~~roles/jwflory.teleirc/tasks/imports.yml~~

file renamed

file was moved with no change to the file

roles/teleirc/tasks/install.yml ~~roles/jwflory.teleirc/tasks/install.yml~~

file renamed

file was moved with no change to the file

roles/teleirc/tasks/main.yml ~~roles/jwflory.teleirc/tasks/main.yml~~

file renamed

file was moved with no change to the file

roles/teleirc/tasks/user-management.yml ~~roles/jwflory.teleirc/tasks/user-management.yml~~

file renamed

file was moved with no change to the file

roles/teleirc/templates/env ~~roles/jwflory.teleirc/templates/env~~

file renamed

file was moved with no change to the file

roles/teleirc/templates/teleirc.service ~~roles/jwflory.teleirc/templates/teleirc.service~~

file renamed

file was moved with no change to the file

roles/teleirc/tests/inventory ~~roles/jwflory.teleirc/tests/inventory~~

file renamed

file was moved with no change to the file

roles/teleirc/tests/test.yml ~~roles/jwflory.teleirc/tests/test.yml~~

file renamed

file was moved with no change to the file

roles/teleirc/vars/example_main.yml ~~roles/jwflory.teleirc/vars/example_main.yml~~

file renamed

file was moved with no change to the file

roles/teleirc/vars/example_vault.yml ~~roles/jwflory.teleirc/vars/example_vault.yml~~

file renamed

file was moved with no change to the file

roles/teleirc/vars/main.yml ~~roles/jwflory.teleirc/vars/main.yml~~

file renamed

file was moved with no change to the file

roles/teleirc/vars/vault.yml ~~roles/jwflory.teleirc/vars/vault.yml~~

file renamed

file was moved with no change to the file

no initial comment

tjzabel commented 4 years ago

@jflory7 I decided to rename the jwflory.teleirc role to just be teleirc since this project is now out of your github. Also, the documentation for the SIG on how to create a new bridge already uses the /roles/teleirc/ tree structure.

What do you think? Do you think it makes sense to rename it this way?

jflory7 commented 4 years ago

@tjzabel It's named this way because it is the namespace used by the upstream Ansible Galaxy role used in this repo:

https://galaxy.ansible.com/jwflory/teleirc

ansible-galaxy install jwflory.teleirc

At the time of creating this repo, there is no way to give custom names to cloned Ansible Galaxy roles. Keeping the same namespace as Ansible Galaxy makes it easier to update the role when a new version is tagged upstream. For that reason, I prefer to keep the name as it is within the repo now to simplify updating. The docs do need to be updated though.

I am closing this PR, but does this explanation make sense? Let me know if anything is not clear.

Pull-Request has been closed by jflory7

4 years ago

tjzabel commented 4 years ago

Sure thing! It totally makes sense.

With that being said, the "Creating a Bot" docs use the /roles/teleirc/ path instead of /roles/jwflory.teleirc/, so I'll just submit a PR to fix that :)