Skip to content

Commit 78289f7

Browse files
authored
Update README.md
1 parent 1464f27 commit 78289f7

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,39 @@
11
# awesome-ci-action
22
A GitHub Action to use the Awesome CI in your workflow
3+
4+
## Usage
5+
6+
### Inputs
7+
8+
- `version`: The chart-releaser version to use (default: 0.7.6)
9+
- `arch`: The chart-releaser version to use (default: amd64)
10+
11+
### Environment variables
12+
13+
- `GITHUB_TOKEN` (required): The GitHub token of this repository (`${{ secrets.GITHUB_TOKEN }}`)
14+
15+
### Example Workflow
16+
17+
Create a workflow (eg: `.github/workflows/release.yml`):
18+
19+
```yaml
20+
name: PullRequest
21+
22+
on:
23+
pull_request:
24+
25+
jobs:
26+
release:
27+
runs-on: ubuntu-latest
28+
steps:
29+
- name: Checkout
30+
uses: actions/checkout@v2
31+
- name: Setup awesome-ci
32+
uses: fullstack-devops/awesome-ci-action@main
33+
34+
- name: set build Infos
35+
run: awesome-ci pr info -number ${{ github.event.pull_request.number }}
36+
env:
37+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
38+
```
39+
For information and options see [awesome-ci](https://github.com/fullstack-devops/awesome-ci).

0 commit comments

Comments
 (0)