Skip to content

Commit a6f6c53

Browse files
committed
Add README
1 parent 8c33e62 commit a6f6c53

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
![Continuous Integration](https://github.com/lucianposton/repoman-ebuild-qa-action/workflows/Continuous%20Integration/badge.svg)
2+
3+
# repoman-ebuild-qa-action
4+
5+
This action runs [repoman](https://wiki.gentoo.org/wiki/Repoman) in an
6+
ebuild repository to find QA issues.
7+
8+
## Usage
9+
10+
Create a workflow file in your repository e.g. `.github/workflows/repoman.yml`.
11+
An example workflow file is provided below. For more information, see
12+
[Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).
13+
14+
### Example workflow
15+
16+
```yaml
17+
name: 'Continuous Integration'
18+
on: [push, pull_request]
19+
jobs:
20+
repoman:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- uses: actions/checkout@v2
24+
- uses: lucianposton/repoman-ebuild-qa-action@v1
25+
```
26+
27+
### Optional Inputs
28+
29+
* `repoman_args` -
30+
Additional arguments to pass after `repoman full`.
31+
Defaults to `-dx`. Note: This parameter will undergo shell
32+
wordsplitting and globbing.
33+
* `path` -
34+
Path to cd to before starting repoman. The path is relative
35+
to the checked out repository. If unspecified or empty,
36+
repoman runs in the root of the repository.
37+
* `portage_version` -
38+
The portage version to download containing repoman e.g.
39+
`2.3.80`. `latest` is the default value, which uses the latest
40+
released version.
41+
* `profile` -
42+
The gentoo profile to set before running repoman. The default
43+
value is `latest`, which will result in using the first
44+
profile in `profiles.desc` listed under `SYMLINK_LIB=no`
45+
e.g. `default/linux/amd64/17.1`.
46+
* `gentoo_repo` -
47+
Location to install the gentoo ebuild repository. This could
48+
be useful if using an old portage version that expects a
49+
different location. Default value is `/var/db/repos/gentoo`.
50+
51+
These optional inputs can be specified in the workflow file using the `with`
52+
keyword [syntax](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepswith).

0 commit comments

Comments
 (0)