Need help with ansible-aur?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

kewlfft
183 Stars 33 Forks GNU General Public License v3.0 186 Commits 0 Opened issues

Description

Ansible module to manage packages from the AUR

Services available

!
?

Need anything else?

Contributors list

Ansible Collection - kewlfft.aur

Description

This collection includes an Ansible module to manage packages from the AUR.

Installation

Install the
kewlfft.aur
collection from Ansible Galaxy

To install this collection from Ansible Galaxy, run the following command:

ansible-galaxy collection install kewlfft.aur

Alternatively, you can include the collection in a

requirements.yml
file and then run
ansible-galaxy collection install -r requirements.yml
. Here is an example of
requirements.yml
file:
collections:
  - name: kewlfft.aur

Install the
kewlfft.aur
collection from the AUR

The

kewlfft.aur
collection is also available in the AUR as the
ansible-collection-kewlfft-aur
package.

Install the
kewlfft.aur
collection locally for development

If you want to test changes to the source code, run the following commands from the root of this git repository to locally build and install the collection:

ansible-galaxy collection build --force
ansible-galaxy collection install --force "./kewlfft-aur-$(cat galaxy.yml | grep version: | awk '{print $2}').tar.gz"

Install the
aur
module as a local custom module

Alternatively, you may manually install the

aur
module itself as a local custom module instead of installing the module through the
kewlfft.aur
Ansible collection. However, it is recommended to use
kewlfft.aur
collection unless you have a good reason not to. Here are the commands to install the
aur
module as a local custom module:
# Create the user custom module directory
mkdir ~/.ansible/plugins/modules

Install the aur module into the user custom module directory

curl -o ~/.ansible/plugins/modules/aur.py https://raw.githubusercontent.com/kewlfft/ansible-aur/master/plugins/modules/aur.py

kewlfft.aur.aur Module

Ansible module to use some Arch User Repository (AUR) helpers as well as makepkg. The following helpers are supported and automatically selected, if present, in the order listed below:

makepkg will be used if no helper was found or if it is explicitly specified:

Options

| Parameter | Choices/Default | Comments | | -------------- | ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | | name | | Name or list of names of the package(s) to install or upgrade. | | state | present, latest | Desired state of the package, 'present' skips operations if the package is already installed. | | upgrade | yes, no | Whether or not to upgrade whole system. | | use | auto, yay, paru, pacaur, trizen, pikaur, aurman, makepkg | The tool to use, 'auto' uses the first known helper found and makepkg as a fallback. | | extraargs | null | A list of additional arguments to pass directly to the tool. Cannot be used in 'auto' mode. | | auronly | yes, no | Limit helper operation to the AUR. | | localpkgbuild | Local directory with PKGBUILD, null | Only valid with makepkg or pikaur. Don't download the package from AUR. Build the package using a local PKGBUILD and the other build files. | | skippgpcheck | yes, no | Only valid with makepkg. Skip PGP signatures verification of source file, useful when installing packages without GnuPG properly configured. | | ignorearch | yes, no | Only valid with makepkg. Ignore a missing or incomplete arch field, useful when the PKGBUILD does not have the arch=('yourarch') field. |

Note

  • Either name or upgrade is required, both cannot be used together.
  • In the use=auto mode, makepkg is used as a fallback if no known helper is found.

Usage

Notes

  • The scope of this module is installation and update from the AUR; for package removal or for updates from the repositories, it is recommended to use the official pacman module.
  • The --needed parameter of the helper is systematically used, it means if a package is up-to-date, it is not built and reinstalled.

Create the "aur_builder" user

While Ansible expects to SSH as root, makepkg or AUR helpers do not allow executing operations as root, they fail with "you cannot perform this operation as root". It is therefore recommended to create a user, which is non-root but has no need for password with pacman in sudoers, let's call it aur_builder.

This user can be created in an Ansible task with the following actions:

- name: Create the `aur_builder` user
  ansible.builtin.user:
    name: aur_builder
    create_home: yes
    group: wheel

  • name: Allow the aur_builder user to run sudo pacman without a password ansible.builtin.lineinfile: path: /etc/sudoers.d/11-install-aur_builder line: 'aur_builder ALL=(ALL) NOPASSWD: /usr/bin/pacman' create: yes validate: 'visudo -cf %s'

Fully Qualified Collection Names (FQCNs)

In order to use an Ansible module that is distributed in a collection, you must use its FQCN. This corresponds to "the full definition of a module, plugin, or role hosted within a collection, in the form

namespace.collection.content_name
" (Source). In this case, the
aur
module resides in the
aur
collection which is under the
kewlfft
namespace, so its FQCN is
kewlfft.aur.aur
.

Please note that this does not apply if you installed the

aur
module as a local custom module. Due to the nature of local custom modules, you can simply use the module's short name:
aur
.

Examples

Use it in a task, as in the following examples:

# This task uses the module's short name instead of its FQCN (Fully Qualified Collection Name).
# Use the short name if the module was installed as a local custom module.
# Otherwise, if it was installed through the `kewlfft.aur` collection, this task will fail.
- name: Install trizen using makepkg if it isn't installed already
  aur:
    name: trizen
    use: makepkg
    state: present
  become: yes
  become_user: aur_builder

This task uses the aur module's FQCN.

  • name: Install trizen using makepkg if it isn't installed already kewlfft.aur.aur: name: trizen use: makepkg state: present become: yes become_user: aur_builder

  • name: Install package_name_1 and package_name_2 using yay kewlfft.aur.aur: use: yay name:

    - package_name_1
    - package_name_2

Note: Dependency resolution will still include repository packages.

  • name: Upgrade the system using yay, only act on AUR packages. kewlfft.aur.aur: upgrade: yes use: yay aur_only: yes

Skip if it is already installed

  • name: Install gnome-shell-extension-caffeine-git using pikaur and a local PKGBUILD. kewlfft.aur.aur: name: gnome-shell-extension-caffeine-git use: pikaur local_pkgbuild: {{ role_path }}/files/gnome-shell-extension-caffeine-git state: present become: yes become_user: aur_builder

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.