https://github.com/jbouter/aur-releaser
Allow releasing packages to the AUR
https://github.com/jbouter/aur-releaser
Last synced: over 1 year ago
JSON representation
Allow releasing packages to the AUR
- Host: GitHub
- URL: https://github.com/jbouter/aur-releaser
- Owner: jbouter
- License: gpl-3.0
- Created: 2021-02-19T08:39:23.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-01-23T17:10:34.000Z (over 4 years ago)
- Last Synced: 2025-03-17T08:49:37.336Z (over 1 year ago)
- Language: Shell
- Size: 30.3 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# aur-releaser
Allow releasing packages to the AUR
## Copyright
All original work by [KSXGitHub](https://github.com/KSXGitHub) was released under the [MIT license](https://github.com/KSXGitHub/github-actions-deploy-aur/blob/master/LICENSE.md). All of the added work is released under the GPL license
## Notes
This workflow is heavily based on [KSXGitHub/github-actions-deploy-aur](https://github.com/KSXGitHub/github-actions-deploy-aur)
## Inputs
### `pkgname`
**Required** AUR package name.
### `pkgbuild`
**Required** Path to PKGBUILD file. This file is often generated by prior steps.
### `commit_username`
**Required** The username to use when creating the new commit.
### `commit_email`
**Required** The email to use when creating the new commit.
### `ssh_private_key`
**Required** Your private key with access to AUR package.
### `commit_message`
**Optional** Commit message to use when creating the new commit.
### `allow_empty_commits`
**Optional** Allow empty commits, i.e. commits with no change. The default value is `true`.
### `force_push`
**Optional** Use `--force` when push to the AUR. The default value is `false`.
### `ssh_keyscan_types`
**Optional** Comma-separated list of types to use when adding aur.archlinux.org to known hosts.
## Example usage
```yaml
name: aur-release
on:
push:
tags:
- '*'
jobs:
aur-release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Release AUR package
uses: jbouter/aur-releaser@
with:
pkgname: my-awesome-package
pkgbuild: ./PKGBUILD
commit_username: ${{ secrets.AUR_USERNAME }}
commit_email: ${{ secrets.AUR_EMAIL }}
ssh_private_key: ${{ secrets.AUR_SSH_PRIVATE_KEY }}
commit_message: Update AUR package
ssh_keyscan_types: rsa,dsa,ecdsa,ed25519
```
**Note:** Replace `` in the above code snippet with a tag of this repo.
**Tip:** To create secrets (such as `secrets.AUR_USERNAME`, `secrets.AUR_EMAIL`, and `secrets.AUR_SSH_PRIVATE_KEY` above), go to `$YOUR_GITHUB_REPO_URL/settings/secrets`. [Read this for more information](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets).
**Tip:** This action does not generate PKGBUILD for you, you must generate it yourself (e.g. by using actions before this action).