docs: Upgrade rdme from v8 to v10

Elements Project/Core Lightning

06118287 View source ↗

Public commit record

What the developer wrote

Authored by ShahanaFarooqui

57/100 · Thin

docs: Upgrade rdme from v8 to v10

✓ Descriptive subject✓ Names a concrete action or component✓ Uses a recognizable type or scope! No meaningful explanatory body

The short version

What changed, and why it matters

This commit updates the documentation publishing workflow from version 8 to version 10 of a ReadMe.io tool called 'rdme'. It only changes how project documentation is uploaded to an external docs site and does not touch the Core Lightning software itself, user funds, network code, or any secrets storage. The API key is still stored as a GitHub secret and is still passed to the tool in essentially the same way.

Recommended action

No security action required. Treat as routine maintenance. If desired, verify that readmeio/rdme@v10's documented behavior for the docs upload command and --key handling is acceptable and that the README_API_KEY secret remains scoped only to this workflow.

Security signals we found

No strong security signals were identified.

Technical analysis

Evidence from the diff

The diff modifies .github/workflows/rdme-docs-sync.yml to bump the readmeio/rdme GitHub Action from v8 to v10 and adapts the CLI syntax to the new version: ‘docs ’ becomes ‘docs upload ./’ and –version=1 becomes –branch=1. The README_API_KEY secret is moved from an env block into the with: block, but it is still referenced as ${{ secrets.README_API_KEY }} and is not exposed in logs by GitHub Actions by default. No application code, cryptographic operations, RPC interfaces, or network listeners are affected.

Changed components

.github/workflows/rdme-docs-sync.yml

Inspect captured patch +10 / −20

diff --git a/.github/workflows/rdme-docs-sync.yml b/.github/workflows/rdme-docs-sync.yml
index bf796122..bdf6d8f4 100644
--- a/.github/workflows/rdme-docs-sync.yml
+++ b/.github/workflows/rdme-docs-sync.yml
@@ -16,36 +16,26 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Sync doc/getting-started/ 🚀
-        uses: readmeio/rdme@v8
-        env:
-          README_API_KEY: ${{ secrets.README_API_KEY }}
+        uses: readmeio/rdme@v10
         with:
-          rdme: docs doc/getting-started --key=${{ env.README_API_KEY }} --version=1
+          rdme: docs upload ./doc/getting-started --key=${{ secrets.README_API_KEY }} --branch=1
             
       - name: Sync doc/beginners-guide/ 🚀
-        uses: readmeio/rdme@v8
-        env:
-          README_API_KEY: ${{ secrets.README_API_KEY }}
+        uses: readmeio/rdme@v10
         with:
-          rdme: docs doc/beginners-guide --key=${{ env.README_API_KEY }} --version=1
+          rdme: docs upload ./doc/beginners-guide --key=${{ secrets.README_API_KEY }} --branch=1
       
       - name: Sync doc/node-operators-guide/ 🚀
-        uses: readmeio/rdme@v8
-        env:
-          README_API_KEY: ${{ secrets.README_API_KEY }}
+        uses: readmeio/rdme@v10
         with:
-          rdme: docs doc/node-operators-guide --key=${{ env.README_API_KEY }} --version=1
+          rdme: docs upload ./doc/node-operators-guide --key=${{ secrets.README_API_KEY }} --branch=1
       
       - name: Sync doc/developers-guide/ 🚀
-        uses: readmeio/rdme@v8
-        env:
-          README_API_KEY: ${{ secrets.README_API_KEY }}
+        uses: readmeio/rdme@v10
         with:
-          rdme: docs doc/developers-guide --key=${{ env.README_API_KEY }} --version=1
+          rdme: docs upload ./doc/developers-guide --key=${{ secrets.README_API_KEY }} --branch=1
       
       - name: Sync doc/contributing-to-core-lightning/ 🚀
-        uses: readmeio/rdme@v8
-        env:
-          README_API_KEY: ${{ secrets.README_API_KEY }}
+        uses: readmeio/rdme@v10
         with:
-          rdme: docs doc/contribute-to-core-lightning --key=${{ env.README_API_KEY }} --version=1
+          rdme: docs upload ./doc/contribute-to-core-lightning --key=${{ secrets.README_API_KEY }} --branch=1

Risk score

Why this scored 15/100

Our methodology →

Potential impact 0/30

Exploitability 0/25

Stealth signal 0/15

Affected reach 0/15

Confidence 10/10

Evidence quality 5/5

Human-validated context

Community notes

Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.

No validated notes yet.

The AI analysis stands alone for now. Submit a note if you can add evidence or important context.

What the developer wrote

What changed, and why it matters

Security signals we found

Evidence from the diff

Changed components

Why this scored 15/100

Community notes

Related watches

Revert "doc: require Homebrew GNU make and gpatch on macOS"

Revert "tests: drop obsolete x-prefix in compacter-slow.sh"

doc: require Homebrew GNU make and gpatch on macOS