Skip to content

Commit 55b566a

Browse files
committed
Add instructions and examples
1 parent c9c409e commit 55b566a

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ GitHub Actions to publish AUR package.
1010

1111
### `pkgbuild`
1212

13-
**Required** Path to PKGBUILD file.
13+
**Required** Path to PKGBUILD file. This file is often generated by prior steps.
1414

1515
### `commit_username`
1616

@@ -63,3 +63,7 @@ jobs:
6363
**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).
6464

6565
**Tip:** This action does not generate PKGBUILD for you, you must generate it yourself (e.g. by using actions before this action).
66+
67+
## Real-world applications
68+
69+
[sane-fmt](https://github.com/KSXGitHub/sane-fmt) has a [workflow](https://github.com/KSXGitHub/sane-fmt/blob/c07ce4f09c0b8dfa902d28753ebb3800268183f5/.github/workflows/deploy.yaml) that builds and uploads executables to GitHub Release then generates PKGBUILD files for and use this very action to update [aur/sane-fmt](https://aur.archlinux.org/packages/sane-fmt) and [aur/sane-fmt-bin](https://aur.archlinux.org/packages/sane-fmt-bin).

0 commit comments

Comments
 (0)