From 9dc571062c628e75ac0fc4b5a149e89074f8829b Mon Sep 17 00:00:00 2001 From: Kevin Veen-Birkenbach Date: Tue, 1 Apr 2025 23:57:52 +0200 Subject: [PATCH] Optimized git-config role --- roles/pc-developer-tools-arduino/README.md | 4 +-- .../pc-developer-tools-arduino/tasks/main.yml | 4 +-- roles/pc-docker/README.md | 4 +-- roles/pc-docker/tasks/main.yml | 4 +-- roles/pc-git/README.md | 29 +++++++++++++------ roles/pc-git/meta/main.yml | 22 ++++++++++++++ roles/pc-git/tasks/main.yml | 23 +++++++++++---- roles/pc-gnome-caffeine/vars/main.yml | 2 +- roles/pc-nextcloud/README.md | 6 ++-- roles/pc-nextcloud/tasks/main.yml | 8 ++--- roles/pc-nextcloud/vars/main.yml | 4 +-- tasks/personal-computer.yml | 1 - 12 files changed, 78 insertions(+), 33 deletions(-) create mode 100644 roles/pc-git/meta/main.yml diff --git a/roles/pc-developer-tools-arduino/README.md b/roles/pc-developer-tools-arduino/README.md index 753dd499..44faec09 100644 --- a/roles/pc-developer-tools-arduino/README.md +++ b/roles/pc-developer-tools-arduino/README.md @@ -12,7 +12,7 @@ The `main.yml` file in the `pc-developer-tools-arduino` role encompasses tasks c - `arduino-docs`: Documentation for Arduino, providing essential information for development. 2. **Adding User to Relevant Arduino Usergroups**: - - This task modifies the user (specified by `{{client_username}}`) to be added to the `uucp` and `lock` groups, which is necessary for accessing serial ports on Linux systems. + - This task modifies the user (specified by `{{users.client.username}}`) to be added to the `uucp` and `lock` groups, which is necessary for accessing serial ports on Linux systems. ## Dependencies The role depends on: @@ -29,7 +29,7 @@ The `pc-developer-tools-arduino` role is tailored for developers and hobbyists w To utilize this role: 1. Clone the `cymais` repository. 2. Navigate to the `roles/pc-developer-tools-arduino` directory. -3. Execute the role using Ansible, ensuring you replace `{{client_username}}` with the actual username and have the necessary system permissions. +3. Execute the role using Ansible, ensuring you replace `{{users.client.username}}` with the actual username and have the necessary system permissions. ## Customization This role can be customized to include additional Arduino-related packages or tools, depending on the user's requirements. diff --git a/roles/pc-developer-tools-arduino/tasks/main.yml b/roles/pc-developer-tools-arduino/tasks/main.yml index 07edb31d..1d52b6bb 100644 --- a/roles/pc-developer-tools-arduino/tasks/main.yml +++ b/roles/pc-developer-tools-arduino/tasks/main.yml @@ -5,7 +5,7 @@ - arduino-docs state: present -- name: Adding user {{client_username}} to relevant arduino usergroups - user: name={{client_username}} +- name: Adding user {{users.client.username}} to relevant arduino usergroups + user: name={{users.client.username}} groups=uucp lock append=yes diff --git a/roles/pc-docker/README.md b/roles/pc-docker/README.md index f02ce2bd..0212f6fd 100644 --- a/roles/pc-docker/README.md +++ b/roles/pc-docker/README.md @@ -8,7 +8,7 @@ The `main.yml` file in the `pc-docker` role consists of two primary tasks: 1. **Install Docker**: This task uses the `community.general.pacman` module to install `docker` and `docker-compose` on the system. It ensures that these packages are present on the PC. -2. **User Group Configuration**: This task adds a specified user (denoted as `{{client_username}}`) to the Docker user group. This is crucial for allowing the specified user to interact with Docker without needing superuser permissions. +2. **User Group Configuration**: This task adds a specified user (denoted as `{{users.client.username}}`) to the Docker user group. This is crucial for allowing the specified user to interact with Docker without needing superuser permissions. ## Use Case The playbook is designed for developers who require Docker in their local development environments. It simplifies the process of Docker installation and configuration, making it straightforward for developers to start containerizing their applications without the complexities often encountered in a server or production environment. @@ -25,7 +25,7 @@ To run this playbook: ## Important Notes - **Not for Server Use**: This playbook is not designed for server environments. It is optimized for individual development machines. -- **Customization**: You may need to customize the playbook, especially the `{{client_username}}` variable, to suit your specific setup. +- **Customization**: You may need to customize the playbook, especially the `{{users.client.username}}` variable, to suit your specific setup. - **Security Considerations**: While adding a user to the Docker group provides ease of use, be aware of the security implications. It grants the user elevated privileges which, if misused, can affect the entire system. ## Support & Contribution diff --git a/roles/pc-docker/tasks/main.yml b/roles/pc-docker/tasks/main.yml index f6c0497c..df17c596 100644 --- a/roles/pc-docker/tasks/main.yml +++ b/roles/pc-docker/tasks/main.yml @@ -5,8 +5,8 @@ - docker-compose state: present -- name: Adding user {{client_username}} to relevant docker usergroup +- name: Adding user {{users.client.username}} to relevant docker usergroup user: - name: "{{client_username}}" + name: "{{users.client.username}}" groups: docker append: yes diff --git a/roles/pc-git/README.md b/roles/pc-git/README.md index cfed866f..6a4d3db2 100644 --- a/roles/pc-git/README.md +++ b/roles/pc-git/README.md @@ -1,13 +1,24 @@ -# PC-Git Role +# Git for Personal Computers -## Overview -Welcome to the `pc-git` role documentation, part of the `cymais` repository. This role is focused on setting up Git, a widely-used version control system, on personal computers. The role includes tasks for installing Git and configuring global user details. +## Description -## Purpose and Usage -The `pc-git` role is essential for developers, IT professionals, and anyone who needs to utilize version control for their projects. It automates the installation of Git and the initial configuration of user identity, which is crucial for committing changes and collaborating on projects using Git. +This role installs and configures Git on the target system using the Pacman package manager (via the community.general.pacman module). In addition, it configures Git for the user by installing a custom git configuration using the [git-configurator](https://github.com/kevinveenbirkenbach/git-configurator) tool. The role ensures that Git is installed and that the configuration tasks are run only once per host. -## Customization -You can customize this role by modifying the variables for user email and name or by adding additional Git configuration tasks as needed. +## Purpose -## Support and Contributions -For support, feedback, or contributions to this role, such as adding more Git-related configurations or tools, please open an issue or submit a pull request in the `cymais` repository. Contributions that enhance Git setup and configuration are highly encouraged. \ No newline at end of file +The purpose of this role is to automate the installation and configuration of Git for personal computers. By leveraging a custom git-configurator, it sets up essential Git settings such as merge options, rebase preferences, user information, and GPG signing, ensuring a consistent environment for version control operations. + +## Features + +- **Automated Git Installation:** Installs Git using Pacman. +- **Custom Git Configuration:** Invokes the git-configurator tool to merge user-specific configuration options. +- **Idempotent Task Execution:** Uses host-level run-once artifacts to ensure that configuration tasks are executed only once per host. +- **Integration:** Works alongside the package-manager role to streamline overall system setup. + +## Credits + +Developed and maintained by **Kevin Veen-Birkenbach**. +Learn more at [www.veen.world](https://www.veen.world) +For Git configuration details, see [git-configurator on GitHub](https://github.com/kevinveenbirkenbach/git-configurator). + +License: [CyMaIS NonCommercial License (CNCL)](https://s.veen.world/cncl) diff --git a/roles/pc-git/meta/main.yml b/roles/pc-git/meta/main.yml new file mode 100644 index 00000000..793752db --- /dev/null +++ b/roles/pc-git/meta/main.yml @@ -0,0 +1,22 @@ +--- +galaxy_info: + author: "Kevin Veen-Birkenbach" + description: "Installs Git and configures it using a custom git-configurator for personal computers." + license: "CyMaIS NonCommercial License (CNCL)" + license_url: "https://s.veen.world/cncl" + company: | + Kevin Veen-Birkenbach + Consulting & Coaching Solutions + https://www.veen.world + min_ansible_version: "2.9" + platforms: + - name: Archlinux + versions: + - rolling + galaxy_tags: + - git + - configuration + - pacman + - personal-computer +dependencies: + - package-manager \ No newline at end of file diff --git a/roles/pc-git/tasks/main.yml b/roles/pc-git/tasks/main.yml index 7ede8984..34063474 100644 --- a/roles/pc-git/tasks/main.yml +++ b/roles/pc-git/tasks/main.yml @@ -1,8 +1,21 @@ -- name: Set git user email to {{user_email}} - ansible.builtin.shell: git config --global user.email "{{user_email}}" -- name: Set git user name to {{user_full_name}} - ansible.builtin.shell: git config --global user.name "{{user_full_name}}" - name: install git community.general.pacman: name: git - state: present \ No newline at end of file + state: present + become: true + +- name: install gitconfig + command: + cmd: "pkgmgr install gitconfig --clone-mode https" + when: run_once_gitconfig is not defined + become: true + +- name: setup git + command: gitconfig --merge-option rebase --name "{{users.client.full_name}}" --email "{{users.client.email}}" --website "{{users.client.website}}" --signing gpg --gpg-key "{{users.client.gpg}}" + when: run_once_the gitconfig is not defined + become: false + +- name: run the gitconfig tasks once + set_fact: + run_once_gitconfig: true + when: run_once_gitconfig is not defined \ No newline at end of file diff --git a/roles/pc-gnome-caffeine/vars/main.yml b/roles/pc-gnome-caffeine/vars/main.yml index 0dfc9601..cb4d3e5e 100644 --- a/roles/pc-gnome-caffeine/vars/main.yml +++ b/roles/pc-gnome-caffeine/vars/main.yml @@ -1 +1 @@ -auto_start_directory: "/home/{{client_username}}/.config/autostart/" \ No newline at end of file +auto_start_directory: "/home/{{users.client.username}}/.config/autostart/" \ No newline at end of file diff --git a/roles/pc-nextcloud/README.md b/roles/pc-nextcloud/README.md index 8bb93fdd..65e3cc98 100644 --- a/roles/pc-nextcloud/README.md +++ b/roles/pc-nextcloud/README.md @@ -5,8 +5,8 @@ This README details the `pc-nextcloud` role, part of the `cymais` repository. Th ## Role Variables The `vars/main.yml` file defines key variables used in this role: -- `user_home_directory`: The home directory of the user, typically `/home/{{client_username}}/`. -- `cloud_directory`: The directory path for Nextcloud cloud storage, structured as `{{user_home_directory}}Clouds/{{cloud_fqdn}}/{{client_username}}/`. +- `user_home_directory`: The home directory of the user, typically `/home/{{users.client.username}}/`. +- `cloud_directory`: The directory path for Nextcloud cloud storage, structured as `{{user_home_directory}}Clouds/{{cloud_fqdn}}/{{users.client.username}}/`. ## Role Tasks The `main.yml` file in the `pc-nextcloud` role comprises the following tasks: @@ -31,7 +31,7 @@ The `pc-nextcloud` role is designed for users who want to integrate Nextcloud, a To use this role: 1. Clone the `cymais` repository. 2. Navigate to the `roles/pc-nextcloud` directory. -3. Ensure that the `client_username` and `cloud_fqdn` variables are correctly set to match your Nextcloud account details. +3. Ensure that the `users.client.username` and `cloud_fqdn` variables are correctly set to match your Nextcloud account details. 4. Execute the role using Ansible, ensuring appropriate permissions are available for installations and configurations. ## Customization diff --git a/roles/pc-nextcloud/tasks/main.yml b/roles/pc-nextcloud/tasks/main.yml index f99cfd81..a47583c8 100644 --- a/roles/pc-nextcloud/tasks/main.yml +++ b/roles/pc-nextcloud/tasks/main.yml @@ -7,8 +7,8 @@ ansible.builtin.file: src: "{{cloud_directory}}{{item}}" dest: "{{user_home_directory}}{{item}}" - owner: "{{client_username}}" - group: "{{client_username}}" + owner: "{{users.client.username}}" + group: "{{users.client.username}}" state: link loop: - Templates @@ -27,6 +27,6 @@ ansible.builtin.file: src: "{{cloud_directory}}InstantUpload" dest: "{{user_home_directory}}Dump" - owner: "{{client_username}}" - group: "{{client_username}}" + owner: "{{users.client.username}}" + group: "{{users.client.username}}" state: link \ No newline at end of file diff --git a/roles/pc-nextcloud/vars/main.yml b/roles/pc-nextcloud/vars/main.yml index 43a6b757..6f97256f 100644 --- a/roles/pc-nextcloud/vars/main.yml +++ b/roles/pc-nextcloud/vars/main.yml @@ -1,2 +1,2 @@ -user_home_directory: "/home/{{client_username}}/" -cloud_directory: "{{user_home_directory}}Clouds/{{cloud_fqdn}}/{{client_username}}/" +user_home_directory: "/home/{{users.client.username}}/" +cloud_directory: "{{user_home_directory}}Clouds/{{cloud_fqdn}}/{{users.client.username}}/" diff --git a/tasks/personal-computer.yml b/tasks/personal-computer.yml index f63c3275..0cf2f102 100644 --- a/tasks/personal-computer.yml +++ b/tasks/personal-computer.yml @@ -54,7 +54,6 @@ - name: setup ssh client when: ("ssh" in group_names) - become: false include_role: name: pc-ssh