Skip to content

Commit dcaaf52

Browse files
Add gen-docs job to github workflows (#5)
2 parents 7dbb254 + a57caf5 commit dcaaf52

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

.github/workflows/ci.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,27 @@ jobs:
3131
- name: Run protolint
3232
run: protolint lint proto
3333

34+
gen-docs:
35+
runs-on: ubuntu-20.04
36+
37+
steps:
38+
- name: Fetch sources
39+
uses: actions/checkout@v3
40+
with:
41+
submodules: true
42+
43+
- name: Generate documentation
44+
run: |
45+
docker run --rm -v $PWD:$PWD pseudomuto/protoc-gen-doc \
46+
-I $PWD/proto \
47+
-I $PWD/submodules/api-common-protos \
48+
-I $PWD/submodules/frequenz-api-common/proto \
49+
--doc_opt=markdown,gen-docs.md --doc_out=$PWD \
50+
$(find $PWD/proto -name *.proto)
51+
52+
- name: Write summary
53+
run: cat gen-docs.md > $GITHUB_STEP_SUMMARY
54+
3455
tests:
3556
needs: ["protolint"]
3657
strategy:

0 commit comments

Comments
 (0)