Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gantsign/ansible_role_hub
Ansible role for installing the Hub command line tool for GitHub
https://github.com/gantsign/ansible_role_hub
ansible ansible-role git github
Last synced: 3 months ago
JSON representation
Ansible role for installing the Hub command line tool for GitHub
- Host: GitHub
- URL: https://github.com/gantsign/ansible_role_hub
- Owner: gantsign
- License: mit
- Created: 2018-08-13T10:27:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-03T19:49:28.000Z (about 2 years ago)
- Last Synced: 2023-05-26T19:10:16.508Z (over 1 year ago)
- Topics: ansible, ansible-role, git, github
- Language: Shell
- Homepage: https://galaxy.ansible.com/gantsign/hub
- Size: 94.7 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Ansible Role: Hub
=================
[](https://github.com/gantsign/ansible_role_hub/actions?query=workflow%3ATests)
[](https://galaxy.ansible.com/gantsign/hub)
[](https://raw.githubusercontent.com/gantsign/ansible_role_hub/master/LICENSE)
Role to download and install GitHubs's [Hub](https://hub.github.com/) the
command-line wrapper for Git that adds features for GitHub repositories.
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
# Hub version number
hub_version: '2.14.2'
# The SHA256 of the Hub redistributable package
hub_redis_sha256sum: '74d95fdfb3c78c8af4e2025b04b916ad905ab99a361778500d58269847c7922d'
# Directory to store files downloaded for Hub
hub_download_dir: "{{ x_ansible_download_dir | default(ansible_env.HOME + '/.ansible/tmp/downloads') }}"
```
Example Playbook
----------------
```yaml
- hosts: servers
roles:
- role: gantsign.hub
```
Tab Completion & Git Alias for Zsh
------------------------------------
### Using Ansible
The recommended way to enable Zsh support for Hub is to use the
[gantsign.antigen](https://galaxy.ansible.com/gantsign/antigen) role (this must
be configured for each user).
```yaml
- hosts: servers
roles:
- role: gantsign.hub
- role: gantsign.antigen
users:
- username: example
antigen_bundles:
- name: hub
url: '/usr/local/share/hub/zsh'
```
### Using Antigen
If you prefer to use [Antigen](https://github.com/zsh-users/antigen) directly
add the following to your Antigen configuration:
```bash
antigen bundle /usr/local/share/hub/zsh
```
### Manual configuration
To manually configure Zsh add the following to your `.zshrc`:
```bash
# Configure Hub alias for Git
source /usr/local/share/hub/zsh/hub.plugin.zsh
# Configure tab completion for Hub
fpath=(/usr/local/share/hub/zsh $fpath)
autoload -U compinit && compinit
```
Tab Completion & Git Alias for Other Shells
---------------------------------------------
Download tab completion support for your shell from
[here](https://github.com/github/hub/tree/master/etc); follow the
instructions for configuring tab completion
[here](https://github.com/github/hub/blob/master/etc/README.md#installation-instructions).
Follow these instructions for setting up the alias
[here](https://github.com/github/hub#aliasing).
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)