Skip to content

Commit

Permalink
doc: Readme sync trigger fix
Browse files Browse the repository at this point in the history
Issue: rpc documentation on the readme server is not being updated.

Updating the path from `doc/**.md` to `doc/schemas/lightning-*.json` for triggering the action because all `doc/*.7.md` files are fully generated by the `tools/fromschema.py` now.

Added manual trigger event for readme's documentation update.

Changelog-None.
  • Loading branch information
ShahanaFarooqui committed May 22, 2024
1 parent 8a0a9a4 commit 2a74e49
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 14 deletions.
1 change: 1 addition & 0 deletions .github/workflows/rdme-docs-sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
- 'master'
paths:
- 'doc/**'
workflow_dispatch:

jobs:
rdme-docs-sync:
Expand Down
29 changes: 15 additions & 14 deletions .github/workflows/readme-rpc-sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ on:
branches:
- 'master'
paths:
- 'doc/**.md'
- 'doc/schemas/lightning-*.json'
- 'doc/*.1.md'
- 'doc/*.5.md'
- 'doc/*.8.md'
- 'doc/lightningd-*.7.md'
- 'doc/reckless.7.md'
workflow_dispatch:

jobs:
rdme-rpc-sync:
Expand All @@ -14,29 +20,24 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v2
- name: Set up Python 3.8
uses: actions/setup-python@v4
with:
python-version: '3.8'
python-version: 3.8

- name: Install requests module
run: python -m pip install requests
- name: Install python modules
run: |
python -m pip install requests mako grpcio-tools
- name: Install dependencies
run: bash -x .github/scripts/setup.sh

- name: Build
- name: Build (including rpc .md files)
run: |
./configure --enable-debugbuild
make -j $(nproc)
make -j $(nproc) check-gen-updated
- name: Make docs
run: |
make doc-all
make check-doc
- name: Set environment variable and run
env:
README_API_KEY: ${{ secrets.README_API_KEY }}
README_API_KEY: ${{ secrets.README_API_KEY }}
run: python .github/scripts/sync-rpc-cmds.py

0 comments on commit 2a74e49

Please sign in to comment.