Skip to content

Commit 2a5c707

Browse files
committed
ci: Add CI workflow to generate documentation
1 parent 71dd0b8 commit 2a5c707

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

.github/workflows/ci-docs.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Update Documentation
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
paths:
8+
- 'action.yml'
9+
10+
jobs:
11+
build:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v3
15+
16+
- run: npm install -g action-docs
17+
18+
- run: action-docs -u
19+
20+
- name: Update README.md file
21+
uses: test-room-7/action-update-file@v1
22+
if: github.event_name == 'pull_request'
23+
with:
24+
file-path: README.md
25+
commit-msg: Update github actions documentation
26+
github-token: ${{ github.token }}
27+
branch: ${{ github.head_ref }}

action.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,14 @@ outputs:
1313
paths_changed:
1414
description: >
1515
List of changed paths, example:
16+
1617
```
1718
["dist", "dist/data"]
1819
```
1920
file_changed:
2021
description: >
2122
List of changed files, example:
23+
2224
```
2325
["dist/main.tf", "dist/index.js"]
2426
```

0 commit comments

Comments
 (0)