gantsign.hub

Ansible Role: Hub

Tests Ansible Galaxy License

Role to download and install GitHubs's Hub 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:

# 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

- 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 role (this must be configured for each user).

- 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 directly add the following to your Antigen configuration:

antigen bundle /usr/local/share/hub/zsh

Manual configuration

To manually configure Zsh add the following to your .zshrc:

# 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; follow the instructions for configuring tab completion here.

Follow these instructions for setting up the alias here.

More Roles From GantSign

You can find more roles from GantSign on Ansible Galaxy.

Development & Testing

This project uses Molecule to aid in the development and testing; the role is unit tested using Testinfra and pytest.

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

Because the above can be tricky to install, this project includes 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:

./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)

About

Ansible role for installing the Hub command line tool for GitHub.

Install
ansible-galaxy install gantsign.hub
GitHub repository
License
mit
Downloads
2.9k