From 2a74e494f2a0aa9853161f1f1fc00f7719c44664 Mon Sep 17 00:00:00 2001 From: ShahanaFarooqui Date: Tue, 21 May 2024 11:44:42 -0700 Subject: [PATCH] doc: Readme sync trigger fix 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. --- .github/workflows/rdme-docs-sync.yml | 1 + .github/workflows/readme-rpc-sync.yml | 29 ++++++++++++++------------- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/.github/workflows/rdme-docs-sync.yml b/.github/workflows/rdme-docs-sync.yml index e29809b1c568..14552bb5c855 100644 --- a/.github/workflows/rdme-docs-sync.yml +++ b/.github/workflows/rdme-docs-sync.yml @@ -6,6 +6,7 @@ on: - 'master' paths: - 'doc/**' + workflow_dispatch: jobs: rdme-docs-sync: diff --git a/.github/workflows/readme-rpc-sync.yml b/.github/workflows/readme-rpc-sync.yml index af218e64a360..495b8fb222f5 100644 --- a/.github/workflows/readme-rpc-sync.yml +++ b/.github/workflows/readme-rpc-sync.yml @@ -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: @@ -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