action-build-aur-package

This action uses a purpose-built image to sanity-check, build and test an AUR package when it the upstream repository publishes a new release. It optionally pushes the update to the Arch User Repository.

---

Example usage

Build and push from a subdirectory in the repository:

  - name: build, test and push package
    uses: glitchcrab/action-build-aur-package@main
    with:
      workdir: "./packagename-bin"
      pushToAur: true
    env:
      AUR_SSH_KEY: ${{ secrets.AUR_SSH_KEY }}
      GIT_EMAIL: ${{ secrets.GIT_EMAIL }}
      GIT_USER: ${{ secrets.GIT_USER }}

Install additional packages required to build the package:

  - name: build, test and push package
    uses: glitchcrab/action-build-aur-package@main
    with:
      workdir: "./packagename-bin"
      pushToAur: true
      additionalPackages: "golangci-lint-bin go"
    env:
      AUR_SSH_KEY: ${{ secrets.AUR_SSH_KEY }}
      GIT_EMAIL: ${{ secrets.GIT_EMAIL }}
      GIT_USER: ${{ secrets.GIT_USER }}

Inputs

additionalPackages

• Description: 'Space-separated list of additional packages to install'
• Required: false
• Default: ''

pushToAur

• Description: 'Push changes to the AUR'
• Required: false
• Default: false

workdir

• Description: 'The directory to work in'
• Required: false
• Default: './'

Outputs

aurPackageName

• The AUR package name.

aurUpdated

• Boolean if the AUR package was updated.

currentVersion

• The current AUR version.

latestVersion

• The latest available version.

Secrets

Various secrets must be configured in the repo for this action to complete.

AUR_SSH_KEY

• Description: 'SSH private key with permissions to push to the AUR'
• Required: true

GITHUB_EMAIL

• Description: 'Username to configure Git with'
• Required: true

GITHUB_USER

• Description: 'Email to configure Git with'
• Required: true

Repository format

This action requires a specific repository format to function. The workdir must contain the following files:

VERSION.env

• CURRENT_VERSION: The release tag of the current AUR version

Example:

CURRENT_VERSION=v1.13.1

VARS.env

• UPSTREAM_REPO: the organisation and repo name of the upstream Github repo
• AUR_REPO: The AUR Git repo URL
• PKG_NAME: The name of the package in the AUR
• ASSET_FILE_STUB: A unique portion of the source filename

Example:

UPSTREAM_REPO="stern/stern"
AUR_REPO="ssh://aur@aur.archlinux.org/stern-bin.git"
PKG_NAME="stern-bin"
ASSET_FILE_STUB="_linux_amd64.tar.gz"