76 Commits

Author SHA1 Message Date
kewl
7affd00193 Update galaxy.yml
version bump
2025-08-22 21:39:16 +01:00
kewl
8e6f0f49bd Update galaxy.yml
revert override
2025-08-22 21:32:00 +01:00
kewl
bb73f524ca Update galaxy.yml
improve version handling
2025-08-22 21:27:58 +01:00
kewl
62193e882c Update galaxy.yml
improve version check
2025-08-22 21:18:17 +01:00
kewl
290b852836 Update galaxy.yml
bump version
2025-08-22 21:13:35 +01:00
kewl
31828edaf9 Update galaxy.yml
add log
2025-08-22 20:53:45 +01:00
kewl
610e14b8c2 Update galaxy.yml
fix path
2025-08-22 20:51:19 +01:00
kewl
b8da3380f5 Update galaxy.yml
fixed path
2025-08-22 20:49:26 +01:00
kewl
984cb9fde1 Update galaxy.yml
finds tarball
2025-08-22 20:47:01 +01:00
kewl
0d4d6aa3e7 Update galaxy.yml
fix publish
2025-08-22 20:44:24 +01:00
kewl
d2f3fb5802 Update galaxy.yml
fixed deployment and improve version check
2025-08-22 20:41:09 +01:00
kewl
3ec32e68a3 Update galaxy.yml
updated key name
2025-08-22 20:31:43 +01:00
kewl
37d4b45acd Update galaxy.yml
v bump
2025-08-22 20:20:50 +01:00
kewl
ebb5e9aed1 Merge pull request #84 from mfinelli/fixgithubactions
Fix github actions
2025-08-22 20:17:52 +01:00
Mario Finelli
2ef95d29d6 Remove setup-python action
Ansible (and ansible-core) is already installed in the runner images
which should be enough to interact with ansible galaxy without needing
to install any additional packages.
2025-08-21 11:25:50 +02:00
Mario Finelli
c58c59c63d Fix output syntax
A while ago Github deprecated and removed the ::set-output syntax in
favor of appending to the GITHUB_OUTPUT.
2025-08-21 11:18:40 +02:00
Mario Finelli
b2ed7c1dc6 Upgrade to latest actions versions
We need to use the latest versions because older nodejs runtimes have
been deprecated and removed some time ago.

As a bonus, the latest version of the setup-python action supports
caching pip dependencies out-of-the-box (setting the appropriate cache
option) so we can eliminate a few of the manual steps to setup
dependency caching.

Finally, I also bumped the python version to 3.13 which is what
currently ships in the Arch repositories, not that it really matters.
2025-08-21 11:16:20 +02:00
Mario Finelli
a2267b88a3 Switch to ubuntu-latest runner
The ubuntu-20.04 runner is no longer available. Switch to latest so that
we don't need to keep updating this as time passes, we don't depend on
anything for a specific ubuntu version.
2025-08-21 11:15:43 +02:00
kewl
768c15ad24 Update galaxy.yml 2025-08-18 17:46:06 +01:00
kewl
0182711634 Merge pull request #82 from ammarlakis/detailed-return
Add installed and updated packages to output
2025-08-18 17:28:57 +01:00
kewl
73c68bfd79 Merge pull request #83 from ammarlakis/absent-state
Add package absent state
2025-08-18 17:23:57 +01:00
Ammar Lakis
21f86cbb6e Add installed and updated packages to output 2025-08-17 17:09:12 +02:00
Ammar Lakis
c348e578cb Add package absent state 2025-08-15 22:39:38 +02:00
kewl fft
fe050018db galaxy version updated to 0.11.1 2023-07-08 19:37:19 +01:00
kewl fft
326836ddbe galaxy version updated 2023-07-08 19:36:22 +01:00
kewl fft
583c7597a9 minor optimizations 2023-07-08 19:20:32 +01:00
kewl fft
cbf843e1db Replaced the changed_iter = changed_iter or ... statement with the changed_iter |= ... compound assignment operator for brevity 2023-07-08 18:56:02 +01:00
kewl fft
2a076dc6a0 optimize check_packages lists construction 2023-07-08 18:51:35 +01:00
kewl
8d177a7550 Merge pull request #78 from jp1995/master
fix for issue #77
2023-07-08 18:40:26 +01:00
kewl
b469b5a641 Merge pull request #73 from LorenzoBettini/LorenzoBettini-patch-1
"mode: 0644" in the README example
2023-07-08 18:30:26 +01:00
jp1995
63d3056a82 fix for issue #77 2023-07-07 18:15:52 +03:00
Lorenzo Bettini
91c6d70184 "mode: 0644" in the README example
When using ansible-lint it would complain about "risky-file-permissions: File permissions unset or incorrect".
Making the `mode` explicit avoids the problem
2022-05-24 14:29:56 +02:00
kewl
9b25b11cea Merge pull request #66 from gotmax23/master
Remove unnecessary files from collection tarball
2021-11-08 11:03:48 +00:00
kewl
2c090a49a8 Merge pull request #67 from LorenzoBettini/patch-1
Use become: yes in the example for creating aur_builder
2021-11-08 08:18:34 +00:00
Lorenzo Bettini
07e5fe301f Use become: yes in the example for creating aur_builder
It is my understanding that for creating the `aur_builder` you have to become root; maybe that's something one does in the whole playbook, but if one wants to specify that only when it's needed, the example could be improved as suggested, so that it's self-contained and can be simply copied and pasted.
2021-11-07 13:08:56 +01:00
Maxwell G
49a077790e Remove unnecessary files from collection tarball 2021-11-04 16:55:37 -05:00
kewl fft
87a15853fa proper version bump 2021-11-04 21:44:50 +00:00
kewl fft
7285f5aaaa correct version tag 2021-11-04 21:34:04 +00:00
kewl fft
cda508cfc0 correct version tag 2021-11-04 21:30:30 +00:00
kewl
c8bf68a91b Merge pull request #63 from assapir/master
Add support for refresh package
2021-11-01 17:41:27 +00:00
Assaf Sapir
2319468c2e use update_cache 2021-10-22 12:23:07 +03:00
Assaf Sapir
f12cb1b36b Fix parameter 2021-10-21 19:49:24 +03:00
Assaf Sapir
e8108fe3e4 Fix parameter 2021-10-21 19:44:02 +03:00
Assaf Sapir
472a92ff8e fix bug and update version 2021-10-19 20:59:14 +03:00
Assaf Sapir
b3e47d6395 Add support for refresh package 2021-10-19 20:48:51 +03:00
kewl fft
47fbee75b9 version bump 2021-09-04 08:55:14 +01:00
kewl
a19f5db22a Merge pull request #62 from gotmax23/patch-2
Fix spelling error in README
2021-09-04 08:42:34 +01:00
kewl
8cf53bd930 Merge pull request #61 from gotmax23/patch-1
Add direct link to AUR package
2021-09-04 08:42:03 +01:00
Maxwell G
095a450558 Fix spelling error in README
This commit fixes a spelling mistake that I made.
2021-09-03 16:27:23 -05:00
Maxwell G
de8f8ef272 Add direct link to AUR package
I just pushed `ansible-collection-kewlfft-aur` to the AUR, so I added a direct link to it in the README.
2021-09-03 16:05:45 -05:00
kewl fft
7821c33f02 update version number 2021-09-03 21:32:45 +01:00
kewl fft
a952d458b2 remove lf 2021-09-03 18:32:14 +01:00
kewl fft
7d1f3af8e5 minor punctuation changes 2021-09-03 18:30:57 +01:00
kewl fft
80da3e9725 minor wording improvements 2021-09-03 18:29:20 +01:00
kewl fft
9e763ce3f5 minor wording change 2021-09-03 18:08:21 +01:00
kewl fft
6a33062eab define fqcn at first use 2021-09-03 18:06:37 +01:00
kewl fft
319a451c6f comment # missing 2021-09-03 18:05:41 +01:00
kewl
c64679b9ff Merge pull request #58 from gotmax23/move_to_collection
Migrate `aur` module from legacy role to collection
2021-09-03 18:00:51 +01:00
Maxwell G
6c553054b9 Add information about installing aur as a local custom module
Please ignore the other reformatted table and other formatting changes.
My markdown editor automatically formats markdown.
2021-08-16 20:21:01 -05:00
Maxwell G
ad64e0acb4 Properly format aur_builder example code block 2021-08-16 19:08:20 -05:00
Maxwell G
ba04d0efc0 Change create_home:no to create_home:yes in README
For certain use cases, the `aur_builder` requires a home directory.

Fixes #59
2021-08-04 14:11:13 -05:00
Maxwell G
6a32a018ee Update README with information about collection 2021-08-04 14:11:13 -05:00
Maxwell G
97851cd308 Create workflow to push collection to Galaxy
This is a Github Actions workflow that pushes the collection to Ansible
Galaxy when a Github release is created.
2021-08-04 14:10:58 -05:00
Maxwell G
91fd5a6513 Create collection metadata and directory structure 2021-08-02 21:20:39 -05:00
kewl
60c02a6652 Merge pull request #56 from grcancelliere/bugfix/def-lang-upgrade
Fix upgrade changed logic and language definition when using pikaur
2021-04-16 08:21:57 +01:00
kewl fft
6f5df32b4b lower case before test 2021-04-16 08:20:52 +01:00
kewl fft
93230880db capital N with pikaur 2021-04-16 08:15:27 +01:00
grcancelliere
813cbadc18 Fix upgrade changed logic and language definition when using pikaur 2021-04-16 07:55:46 +02:00
kewl
dc101ae394 Merge pull request #55 from Terseus/bugfix/ansible-doc-2.10-fix
Fix `ansible-doc aur` error about dictionary element length
2021-04-03 11:31:48 +01:00
Terseus
706b236058 Fix ansible-doc aur error about dictionary element length
Fixes the following error when running `ansible-doc aur`:

```
ERROR! Unable to retrieve documentation from 'aur' due to: dictionary
update sequence element #0 has length 1; 2 is required
```

It was because the `helper` value in the `RETURN` section was missing
the `description` key.
2021-04-03 12:17:10 +02:00
kewl
e8655fcf1c Merge pull request #53 from brettinternet/patch-1
Improve aur_builder example
2021-01-30 08:01:42 -05:00
Brett
d05e0bc979 add field for aur_builder user example without home dir 2021-01-29 22:43:26 -07:00
kewl
bff54cb367 Merge pull request #52 from hummeltech/Paru
Added `paru` as a helper option
2021-01-26 14:31:25 -05:00
David Hummel
652b11fd76 Alignment adjustment of Options table in README.md 2021-01-26 12:28:14 -07:00
David Hummel
5d5cc1e20d Added paru as a helper option 2021-01-26 10:41:55 -07:00
kewl fft
95aa8f3047 exit with error if empty name list 2021-01-20 16:57:45 -05:00
7 changed files with 409 additions and 135 deletions

59
.github/workflows/galaxy.yml vendored Normal file
View File

@@ -0,0 +1,59 @@
name: Build and Publish Collection to Ansible Galaxy
on:
release:
types: [published]
workflow_dispatch:
defaults:
run:
working-directory: collections/ansible_collections/kewlfft/aur
jobs:
release:
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v5
with:
path: collections/ansible_collections/kewlfft/aur
- name: Debug workflow version
run: echo "=== RUNNING UPDATED WORKFLOW ==="
- name: Verify version in galaxy.yml matches release tag
run: |
tag_version="${GITHUB_REF##*/}" # e.g., v0.12.2
tag_version="${tag_version#v}" # strip leading 'v' if present
file_version=$(awk '/^version:/ {print $2}' galaxy.yml)
if [ "${GITHUB_EVENT_NAME}" != "workflow_dispatch" ] && [ "$file_version" != "$tag_version" ]; then
echo "❌ galaxy.yml version ($file_version) does not match tag ($tag_version)"
exit 1
fi
echo "✅ Version check passed: $file_version"
- name: Build collection
run: |
path=$(ansible-galaxy collection build | awk '/Created collection/ {print $NF}')
echo "TARBALL=$path" >> $GITHUB_ENV
echo "📦 Built collection at $path"
- name: Upload built collection artifact
uses: actions/upload-artifact@v4
with:
name: ansible-collection-tarball
path: ${{ env.TARBALL }}
- name: Debug tarball before publish
run: |
echo "🔎 Checking tarball path..."
echo "TARBALL=$TARBALL"
ls -l "$(dirname "$TARBALL")"
- name: Publish collection
if: github.event_name != 'workflow_dispatch' # skip publish for manual testing
run: |
echo "📤 Publishing $TARBALL ..."
ansible-galaxy collection publish "$TARBALL" \
--api-key "${{ secrets.ANSIBLE_GALAXY_API_KEY }}"

2
.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
kewlfft-aur-*.tar.gz
*.swp

186
README.md
View File

@@ -1,124 +1,180 @@
# Ansible AUR helper # Ansible Collection - kewlfft.aur
Ansible module to use some Arch User Repository (AUR) helpers as well as makepkg.
## 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:
```shell
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:
```yaml
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`](https://aur.archlinux.org/packages/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:
```shell
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](https://docs.ansible.com/ansible/latest/dev_guide/developing_locally.html) 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:
```shell
# 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: The following helpers are supported and automatically selected, if present, in the order listed below:
- [yay](https://github.com/Jguer/yay) - [yay](https://github.com/Jguer/yay)
- [paru](https://github.com/Morganamilo/paru)
- [pacaur](https://github.com/E5ten/pacaur) - [pacaur](https://github.com/E5ten/pacaur)
- [trizen](https://github.com/trizen/trizen) - [trizen](https://github.com/trizen/trizen)
- [pikaur](https://github.com/actionless/pikaur) - [pikaur](https://github.com/actionless/pikaur)
- [aurman](https://github.com/polygamma/aurman) (discontinued) - [aurman](https://github.com/polygamma/aurman) (discontinued)
*makepkg* will be used if no helper was found or if it is explicitly specified: *makepkg* will be used if no helper was found or if it is explicitly specified:
- [makepkg](https://wiki.archlinux.org/index.php/makepkg) - [makepkg](https://wiki.archlinux.org/index.php/makepkg)
## Options ### Options
| Parameter | Choices/**Default** | Comments | | Parameter | Choices/**Default** | Comments |
|--- |--- |---| | -------------- | ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| name | | Name or list of names of the package(s) to install or upgrade. | | 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.| | state | **present**, latest, absent | Desired state of the package, 'present' skips operations if the package is already installed. |
| upgrade | yes, **no** | Whether or not to upgrade whole system. | | upgrade | yes, **no** | Whether or not to upgrade whole system. |
|use |**auto**, yay, pacaur, trizen, pikaur, aurman, makepkg |The tool to use, 'auto' uses the first known helper found and makepkg as a fallback.| | update_cache | yes, **no** | Whether or not to refresh the packages cache |
| 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. |
| extra_args | **null** | A list of additional arguments to pass directly to the tool. Cannot be used in 'auto' mode. | | extra_args | **null** | A list of additional arguments to pass directly to the tool. Cannot be used in 'auto' mode. |
| aur_only | yes, **no** | Limit helper operation to the AUR. | | aur_only | yes, **no** | Limit helper operation to the AUR. |
| local_pkgbuild | 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. | | local_pkgbuild | 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. |
| skip_pgp_check | yes, **no** | Only valid with makepkg. Skip PGP signatures verification of source file, useful when installing packages without GnuPG properly configured. | | skip_pgp_check | yes, **no** | Only valid with makepkg. Skip PGP signatures verification of source file, useful when installing packages without GnuPG properly configured. |
| ignore_arch | yes, **no** | Only valid with makepkg. Ignore a missing or incomplete arch field, useful when the PKGBUILD does not have the arch=('yourarch') field. | | ignore_arch | 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 #### Note
* Either *name* or *upgrade* is required, both cannot be used together. * 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. * In the *use*=*auto* mode, makepkg is used as a fallback if no known helper is found.
## Installing ### Usage
### AUR package
The [ansible-aur-git](https://aur.archlinux.org/packages/ansible-aur-git) package is available in the AUR.
Note: The module is installed in `/usr/share/ansible/plugins/modules` which is one of the default module library paths. #### Notes
### Manual installation
Just clone the *ansible-aur* repository into your user custom-module directory:
```
git clone https://github.com/kewlfft/ansible-aur.git ~/.ansible/plugins/modules/aur
```
### Ansible Galaxy
*ansible-aur* is available in Galaxy which is a hub for sharing Ansible content. To download it, use:
```
ansible-galaxy install kewlfft.aur
```
Note: If this module is installed from Ansible Galaxy, you will need to list it explicitly in your playbook:
```
# playbook.yml
- hosts: localhost
roles:
- kewlfft.aur
tasks:
- aur: name=package_name
```
or in your role:
```
# meta/main.yml
dependencies:
- kewlfft.aur
```
```
# tasks/main.yml
- aur: name=package_name
```
## 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 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. * 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 #### 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*. 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: This user can be created in an Ansible task with the following actions:
```
- user: ```yaml
- name: Create the `aur_builder` user
become: yes
ansible.builtin.user:
name: aur_builder name: aur_builder
create_home: yes
group: wheel group: wheel
- lineinfile:
- name: Allow the `aur_builder` user to run `sudo pacman` without a password
become: yes
ansible.builtin.lineinfile:
path: /etc/sudoers.d/11-install-aur_builder path: /etc/sudoers.d/11-install-aur_builder
line: 'aur_builder ALL=(ALL) NOPASSWD: /usr/bin/pacman' line: 'aur_builder ALL=(ALL) NOPASSWD: /usr/bin/pacman'
create: yes create: yes
mode: 0644
validate: 'visudo -cf %s' validate: 'visudo -cf %s'
``` ```
### Examples #### 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](https://github.com/ansible-collections/overview#terminology)). 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: Use it in a task, as in the following examples:
```
# Install trizen using makepkg, skip if it is already installed ```yaml
- aur: name=trizen use=makepkg state=present # 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: yes
become_user: aur_builder become_user: aur_builder
# Install package_name using the first known helper found # This task uses the `aur` module's FQCN.
- aur: name=package_name - name: Install trizen using makepkg if it isn't installed already
kewlfft.aur.aur:
name: trizen
use: makepkg
state: present
become: yes become: yes
become_user: aur_builder become_user: aur_builder
# Install package_name_1 and package_name_2 using yay - name: Install package_name_1 and package_name_2 using yay
- aur: kewlfft.aur.aur:
use: yay use: yay
name: name:
- package_name_1 - package_name_1
- package_name_2 - package_name_2
# Upgrade the system using yay, only act on AUR packages. # Note: Dependency resolution will still include repository packages.
# Note: Dependency resolving will still include repository packages. - name: Upgrade the system using yay, only act on AUR packages.
- aur: upgrade=yes use=yay aur_only=yes kewlfft.aur.aur:
upgrade: yes
use: yay
aur_only: yes
# Install gnome-shell-extension-caffeine-git using pikaur and a local PKGBUILD.
# Skip if it is already installed # Skip if it is already installed
- aur: - name: Install gnome-shell-extension-caffeine-git using pikaur and a local PKGBUILD.
kewlfft.aur.aur:
name: gnome-shell-extension-caffeine-git name: gnome-shell-extension-caffeine-git
use: pikaur use: pikaur
local_pkgbuild: {{ role_path }}/files/gnome-shell-extension-caffeine-git local_pkgbuild: {{ role_path }}/files/gnome-shell-extension-caffeine-git
state: present state: present
become: yes become: yes
become_user: aur_builder become_user: aur_builder
```
# Remove AUR packages (state=absent)
- name: Remove package_name_1 and package_name_2 using yay
kewlfft.aur.aur:
use: yay
state: absent
name:
- package_name_1
- package_name_2
become: yes
become_user: aur_builder

70
galaxy.yml Normal file
View File

@@ -0,0 +1,70 @@
### REQUIRED
# The namespace of the collection. This can be a company/brand/organization or product namespace under which all
# content lives. May only contain alphanumeric lowercase characters and underscores. Namespaces cannot start with
# underscores or numbers and cannot contain consecutive underscores
namespace: kewlfft
# The name of the collection. Has the same character restrictions as 'namespace'
name: aur
# The version of the collection. Must be compatible with semantic versioning
version: 0.13.0
# The path to the Markdown (.md) readme file. This path is relative to the root of the collection
readme: README.md
# A list of the collection's content authors. Can be just the name or in the format 'Full Name <email> (url)
# @nicks:irc/im.site#channel'
authors:
- kewl fft <kewl@alto.eu.org>
### OPTIONAL but strongly recommended
# A short summary description of the collection
description: This collection includes an Ansible module to manage packages from the AUR.
# Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only
# accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file'
license:
- GPL-3.0-or-later
# The path to the license file for the collection. This path is relative to the root of the collection. This key is
# mutually exclusive with 'license'
license_file: ''
# A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character
# requirements as 'namespace' and 'name'
tags:
- aur
- arch_user_repository
- arch
- archlinux
- arch_linux
- packaging
- software
# Collections that this collection requires to be installed for it to be usable. The key of the dict is the
# collection label 'namespace.name'. The value is a version range
# L(specifiers,https://python-semanticversion.readthedocs.io/en/latest/#requirement-specification). Multiple version
# range specifiers can be set and are separated by ','
dependencies: {}
# The URL of the originating SCM repository
repository: https://github.com/kewlfft/ansible-aur
# The URL to any online docs
documentation: https://github.com/kewlfft/ansible-aur/blob/master/README.md
# The URL to the homepage of the collection/project
homepage: https://github.com/kewlfft/ansible-aur
# The URL to the collection issue tracker
issues: https://github.com/kewlfft/ansible-aur/issues
# A list of file glob-like patterns used to filter any files or directories that should not be included in the build
# artifact. A pattern is matched from the relative path of the file or directory of the collection directory. This
# uses 'fnmatch' to match the files or directories. Some directories and files like 'galaxy.yml', '*.pyc', '*.retry',
# and '.git' are always filtered
build_ignore:
- .github
- .gitignore

View File

@@ -1,17 +0,0 @@
galaxy_info:
author: kewlfft
role_name: aur
description: Ansible module to use some Arch User Repository (AUR) helpers as well as makepkg.
license: GPL-3.0-or-later
min_ansible_version: 2.0
# https://galaxy.ansible.com/api/v1/platforms/
platforms:
- name: ArchLinux
versions:
- any
galaxy_tags:
- aur
dependencies: []

2
meta/runtime.yml Normal file
View File

@@ -0,0 +1,2 @@
---
requires_ansible: '>=2.9.10'

View File

@@ -31,7 +31,7 @@ options:
description: description:
- Desired state of the package. - Desired state of the package.
default: present default: present
choices: [ present, latest ] choices: [ present, latest, absent ]
upgrade: upgrade:
description: description:
@@ -39,11 +39,17 @@ options:
default: no default: no
type: bool type: bool
update_cache:
description:
- Whether or not to update_cache the package cache.
default: no
type: bool
use: use:
description: description:
- The tool to use, 'auto' uses the first known helper found and makepkg as a fallback. - The tool to use, 'auto' uses the first known helper found and makepkg as a fallback.
default: auto default: auto
choices: [ auto, yay, pacaur, trizen, pikaur, aurman, makepkg ] choices: [ auto, yay, paru, pacaur, trizen, pikaur, aurman, makepkg ]
extra_args: extra_args:
description: description:
@@ -90,7 +96,15 @@ RETURN = '''
msg: msg:
description: action that has been taken description: action that has been taken
helper: helper:
the helper that was actually used description: the helper that was actually used
installed:
description: list of packages that were newly installed
returned: always
type: list
updated:
description: list of packages that were upgraded
returned: always
type: list
''' '''
EXAMPLES = ''' EXAMPLES = '''
@@ -100,10 +114,11 @@ EXAMPLES = '''
become_user: aur_builder become_user: aur_builder
''' '''
def_lang = ['env', 'LC_ALL=C'] def_lang = ['env', 'LC_ALL=C', 'LANGUAGE=C']
use_cmd = { use_cmd = {
'yay': ['yay', '-S', '--noconfirm', '--needed', '--cleanafter'], 'yay': ['yay', '-S', '--noconfirm', '--needed', '--cleanafter'],
'paru': ['paru', '-S', '--noconfirm', '--needed', '--cleanafter'],
'pacaur': ['pacaur', '-S', '--noconfirm', '--noedit', '--needed'], 'pacaur': ['pacaur', '-S', '--noconfirm', '--noedit', '--needed'],
'trizen': ['trizen', '-S', '--noconfirm', '--noedit', '--needed'], 'trizen': ['trizen', '-S', '--noconfirm', '--noedit', '--needed'],
'pikaur': ['pikaur', '-S', '--noconfirm', '--noedit', '--needed'], 'pikaur': ['pikaur', '-S', '--noconfirm', '--noedit', '--needed'],
@@ -116,7 +131,16 @@ use_cmd_local_pkgbuild = {
'makepkg': ['makepkg', '--syncdeps', '--install', '--noconfirm', '--needed'] 'makepkg': ['makepkg', '--syncdeps', '--install', '--noconfirm', '--needed']
} }
has_aur_option = ['yay', 'pacaur', 'trizen', 'pikaur', 'aurman'] use_remove_cmd = {
'yay': ['yay', '-R', '--noconfirm'],
'paru': ['paru', '-R', '--noconfirm'],
'pacaur': ['pacaur', '-R', '--noconfirm'],
'trizen': ['trizen', '-R', '--noconfirm'],
'pikaur': ['pikaur', '-R', '--noconfirm'],
'aurman': ['aurman', '-R', '--noconfirm'],
}
has_aur_option = ['yay', 'paru', 'pacaur', 'trizen', 'pikaur', 'aurman']
def package_installed(module, package): def package_installed(module, package):
@@ -131,18 +155,8 @@ def check_packages(module, packages):
""" """
Inform the user what would change if the module were run Inform the user what would change if the module were run
""" """
would_be_changed = [] would_be_changed = [package for package in packages if not package_installed(module, package)]
diff = { diff = {'before': '', 'after': '\n'.join(package for package in would_be_changed if module._diff)}
'before': '',
'after': '',
}
for package in packages:
installed = package_installed(module, package)
if not installed:
would_be_changed.append(package)
if module._diff:
diff['after'] += package + "\n"
if would_be_changed: if would_be_changed:
status = True status = True
@@ -159,7 +173,29 @@ def check_packages(module, packages):
module.exit_json(changed=status, msg=message, diff=diff) module.exit_json(changed=status, msg=message, diff=diff)
def build_command_prefix(use, extra_args, skip_pgp_check=False, ignore_arch=False, aur_only=False, local_pkgbuild=None): def check_packages_absent(module, packages):
"""
Inform the user what would change if the module were run with state=absent
"""
would_be_changed = [package for package in packages if package_installed(module, package)]
diff = {'before': '\n'.join(pkg for pkg in would_be_changed if module._diff), 'after': ''}
if would_be_changed:
status = True
if len(packages) > 1:
message = '{} package(s) would be removed'.format(len(would_be_changed))
else:
message = 'package would be removed'
else:
status = False
if len(packages) > 1:
message = 'all packages are already absent'
else:
message = 'package is already absent'
module.exit_json(changed=status, msg=message, diff=diff)
def build_command_prefix(use, extra_args, skip_pgp_check=False, ignore_arch=False, aur_only=False, local_pkgbuild=None, update_cache=False):
""" """
Create the prefix of a command that can be used by the install and upgrade functions. Create the prefix of a command that can be used by the install and upgrade functions.
""" """
@@ -175,6 +211,8 @@ def build_command_prefix(use, extra_args, skip_pgp_check=False, ignore_arch=Fals
command.append('--aur') command.append('--aur')
if local_pkgbuild and use != 'makepkg': if local_pkgbuild and use != 'makepkg':
command.append(local_pkgbuild) command.append(local_pkgbuild)
if update_cache:
command.append('-y')
if extra_args: if extra_args:
command += shlex.split(extra_args) command += shlex.split(extra_args)
return command return command
@@ -222,34 +260,33 @@ def check_upgrade(module, use):
Inform user how many packages would be upgraded Inform user how many packages would be upgraded
""" """
rc, stdout, stderr = module.run_command([use, '-Qu'], check_rc=True) rc, stdout, stderr = module.run_command([use, '-Qu'], check_rc=True)
data = stdout.split('\n') num_packages = sum(1 for line in stdout.splitlines() if line.strip())
data.remove('')
module.exit_json( module.exit_json(
changed=len(data) > 0, changed=num_packages > 0,
msg="{} package(s) would be upgraded".format(len(data)), msg=f"{num_packages} package(s) would be upgraded",
helper=use, helper=use,
) )
def upgrade(module, use, extra_args, aur_only): def upgrade(module, use, extra_args, aur_only, update_cache):
""" """
Upgrade the whole system Upgrade the whole system
""" """
assert use in use_cmd assert use in use_cmd
command = build_command_prefix(use, extra_args, aur_only=aur_only) command = build_command_prefix(use, extra_args, aur_only=aur_only, update_cache=update_cache)
command.append('-u') command.append('-u')
rc, out, err = module.run_command(command, check_rc=True) rc, out, err = module.run_command(command, check_rc=True)
module.exit_json( module.exit_json(
changed=not (out == '' or 'nothing to do' in out or 'No AUR updates found' in out), changed=not (out == '' or 'nothing to do' in out.lower() or 'No AUR updates found' in out),
msg='upgraded system', msg='upgraded system',
helper=use, helper=use,
) )
def install_packages(module, packages, use, extra_args, state, skip_pgp_check, ignore_arch, aur_only, local_pkgbuild): def install_packages(module, packages, use, extra_args, state, skip_pgp_check, ignore_arch, aur_only, local_pkgbuild, update_cache):
""" """
Install the specified packages Install the specified packages
""" """
@@ -258,11 +295,12 @@ def install_packages(module, packages, use, extra_args, state, skip_pgp_check, i
else: else:
assert use in use_cmd assert use in use_cmd
changed_iter = False installed_pkgs = []
updated_pkgs = []
for package in packages: for package in packages:
if state == 'present': was_installed = package_installed(module, package)
if package_installed(module, package): if state == 'present' and was_installed:
rc = 0 rc = 0
continue continue
if use == 'makepkg': if use == 'makepkg':
@@ -270,11 +308,18 @@ def install_packages(module, packages, use, extra_args, state, skip_pgp_check, i
elif local_pkgbuild: elif local_pkgbuild:
rc, out, err = install_local_package(module, package, use, extra_args, local_pkgbuild) rc, out, err = install_local_package(module, package, use, extra_args, local_pkgbuild)
else: else:
command = build_command_prefix(use, extra_args, aur_only=aur_only) command = build_command_prefix(use, extra_args, aur_only=aur_only, update_cache=update_cache)
command.append(package) command.append(package)
rc, out, err = module.run_command(command, check_rc=True) rc, out, err = module.run_command(command, check_rc=True)
changed_iter = changed_iter or not (out == '' or '-- skipping' in out or 'nothing to do' in out) changed_pkg = not (out == '' or 'up-to-date -- skipping' in out or 'nothing to do' in out.lower())
if changed_pkg:
if was_installed:
updated_pkgs.append(package)
else:
installed_pkgs.append(package)
changed_iter = bool(installed_pkgs or updated_pkgs)
message = 'installed package(s)' if changed_iter else 'package(s) already installed' message = 'installed package(s)' if changed_iter else 'package(s) already installed'
@@ -283,6 +328,46 @@ def install_packages(module, packages, use, extra_args, state, skip_pgp_check, i
msg=message if not rc else err, msg=message if not rc else err,
helper=use, helper=use,
rc=rc, rc=rc,
installed=installed_pkgs,
updated=updated_pkgs,
)
def remove_packages(module, packages, use, extra_args):
"""
Remove the specified packages
"""
# Determine the base command. If a helper other than makepkg is selected, use it.
# If use is 'makepkg' (which has no remove capability), fallback to pacman directly.
def base_remove_cmd(selected_use):
if selected_use == 'makepkg':
return def_lang + ['pacman', '-R', '--noconfirm'], 'pacman'
else:
assert selected_use in use_remove_cmd
return def_lang + use_remove_cmd[selected_use], selected_use
changed_iter = False
rc = 0
used_helper = use
for package in packages:
if not package_installed(module, package):
continue
command, helper = base_remove_cmd(use)
used_helper = helper
if extra_args:
command += shlex.split(extra_args)
command.append(package)
rc, out, err = module.run_command(command, check_rc=True)
changed_iter |= (rc == 0)
message = 'removed package(s)' if changed_iter else 'package(s) already absent'
module.exit_json(
changed=changed_iter,
msg=message if not rc else err,
helper=used_helper,
rc=rc,
) )
@@ -294,11 +379,15 @@ def make_module():
}, },
'state': { 'state': {
'default': 'present', 'default': 'present',
'choices': ['present', 'latest'], 'choices': ['present', 'latest', 'absent'],
}, },
'upgrade': { 'upgrade': {
'type': 'bool', 'type': 'bool',
}, },
'update_cache': {
'default': False,
'type': 'bool',
},
'use': { 'use': {
'default': 'auto', 'default': 'auto',
'choices': ['auto'] + list(use_cmd.keys()), 'choices': ['auto'] + list(use_cmd.keys()),
@@ -333,6 +422,9 @@ def make_module():
use = params['use'] use = params['use']
if params['name'] == []:
module.fail_json(msg="'name' cannot be empty.")
if use == 'auto': if use == 'auto':
if params['extra_args'] is not None: if params['extra_args'] is not None:
module.fail_json(msg="'extra_args' cannot be used with 'auto', a tool must be specified.") module.fail_json(msg="'extra_args' cannot be used with 'auto', a tool must be specified.")
@@ -368,10 +460,19 @@ def apply_module(module, use):
if module.check_mode: if module.check_mode:
check_upgrade(module, use) check_upgrade(module, use)
else: else:
upgrade(module, use, params['extra_args'], params['aur_only']) upgrade(module, use, params['extra_args'], params['aur_only'], params['update_cache'])
else: else:
if module.check_mode: if module.check_mode:
if params['state'] == 'absent':
check_packages_absent(module, params['name'])
else:
check_packages(module, params['name']) check_packages(module, params['name'])
else:
if params['state'] == 'absent':
remove_packages(module,
params['name'],
use,
params['extra_args'])
else: else:
install_packages(module, install_packages(module,
params['name'], params['name'],
@@ -381,7 +482,8 @@ def apply_module(module, use):
params['skip_pgp_check'], params['skip_pgp_check'],
params['ignore_arch'], params['ignore_arch'],
params['aur_only'], params['aur_only'],
params['local_pkgbuild']) params['local_pkgbuild'],
params['update_cache'])
def main(): def main():