Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gantsign/ansible_role_git_user

Ansible role for configuring the Git user name and email
https://github.com/gantsign/ansible_role_git_user

ansible ansible-role git

Last synced: 12 days ago
JSON representation

Ansible role for configuring the Git user name and email

Awesome Lists containing this project

README

        

Ansible Role: Git User
======================

[![Tests](https://github.com/gantsign/ansible_role_git_user/workflows/Tests/badge.svg)](https://github.com/gantsign/ansible_role_git_user/actions?query=workflow%3ATests)
[![Ansible Galaxy](https://img.shields.io/badge/ansible--galaxy-gantsign.git__user-blue.svg)](https://galaxy.ansible.com/gantsign/git_user)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/gantsign/ansible_role_git_user/master/LICENSE)

Role to configure the username and email address for users of Git.

Requirements
------------

* Ansible >= 2.9

* Linux Distribution

* Debian Family

* Debian

* Stretch (9)
* Buster (10)
* Bullseye (11)

* Ubuntu

* Bionic (18.04)
* Focal (20.04)

* RedHat Family

* Rocky Linux

* 8

* Fedora

* 35

* SUSE Family

* openSUSE

* 15.3

* Note: other versions are likely to work but have not been tested.

Role Variables
--------------

The following variables will change the behavior of this role:

```yaml
# Users to configure the Git user name and email address for
users: []
```

Users are configured as follows:

```yaml
users:
- username: # Unix user name
git_user_name: # Optional. User name to use for Git
git_user_email: # Optional. Email address to use for Git
git_user_force: # Optional. (yes/no) wether to overwrite the current values
```

Example Playbook
----------------

```yaml
- hosts: servers
roles:
- role: gantsign.git_user
users:
- username: joe
git_user_name: Joe Bloggs
git_user_email: [email protected]
git_user_force: no
```

More Roles From GantSign
------------------------

You can find more roles from GantSign on
[Ansible Galaxy](https://galaxy.ansible.com/gantsign).

Development & Testing
---------------------

This project uses [Molecule](http://molecule.readthedocs.io/) to aid in the
development and testing; the role is unit tested using
[Testinfra](http://testinfra.readthedocs.io/) and
[pytest](http://docs.pytest.org/).

To develop or test you'll need to have installed the following:

* Linux (e.g. [Ubuntu](http://www.ubuntu.com/))
* [Docker](https://www.docker.com/)
* [Python](https://www.python.org/) (including python-pip)
* [Ansible](https://www.ansible.com/)
* [Molecule](http://molecule.readthedocs.io/)

Because the above can be tricky to install, this project includes
[Molecule Wrapper](https://github.com/gantsign/molecule-wrapper). Molecule
Wrapper is a shell script that installs Molecule and it's dependencies (apart
from Linux) and then executes Molecule with the command you pass it.

To test this role using Molecule Wrapper run the following command from the
project root:

```bash
./moleculew test
```

Note: some of the dependencies need `sudo` permission to install.

License
-------

MIT

Author Information
------------------

John Freeman

GantSign Ltd.
Company No. 06109112 (registered in England)