We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
2 parents 7dbb254 + a57caf5 commit dcaaf52Copy full SHA for dcaaf52
.github/workflows/ci.yaml
@@ -31,6 +31,27 @@ jobs:
31
- name: Run protolint
32
run: protolint lint proto
33
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
55
tests:
56
needs: ["protolint"]
57
strategy:
0 commit comments