Skip to content

Commit 23abb17

Browse files
author
Gustavo Marin
committed
update docs
1 parent 0c025b5 commit 23abb17

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,37 @@
22

33
This action can publish an AUR package.
44

5+
6+
## Requirements
7+
8+
It depends on an environment variable called `GITHUB_REF` to be present and it should also contain a semantic version
9+
in the format `v0.0.0` to work properly.
10+
11+
This tag should also comply with rules established to publish versions on AUR repository.
12+
13+
You should add to your secrets an SSH private key that match your key uploaded to your AUR account,
14+
so this action can commit and push to it.
15+
16+
517
## Inputs
618

719
### `package_name`
8-
920
**Required** The AUR package name you want to update.
1021

1122
### `commit_username`
12-
1323
**Required** The username to use when creating the new commit.
1424

1525
### `commit_email`
16-
1726
**Required** The email to use when creating the new commit.
1827

1928
### `ssh_private_key`
20-
2129
**Required** Your private key with access to AUR package.
2230

2331

24-
2532
## Example usage
26-
2733
```
2834
name: aur-publish
35+
2936
on:
3037
push:
3138
tags:

0 commit comments

Comments
 (0)