Skip to content

Commit b0c607b

Browse files
authored
chore: consolidate docs update (#6908)
1 parent 08e4e26 commit b0c607b

2 files changed

Lines changed: 34 additions & 43 deletions

File tree

.github/workflows/docs-auto-update.yml

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
# This workflows, run daily, updates the Forest CLI usage docs, and submits a PR with the changes.
2-
name: Update Forest usage docs
1+
# This workflow, run daily, updates the Forest CLI usage docs and the Forest RPC reference docs,
2+
# and submits a separate PR for each.
3+
name: Update Forest docs
34
permissions:
45
contents: read
56

@@ -9,7 +10,7 @@ on:
910
- cron: "0 0 * * *"
1011

1112
jobs:
12-
update-docs:
13+
update-cli-docs:
1314
runs-on: ubuntu-24.04-arm
1415
steps:
1516
- uses: actions/checkout@v6
@@ -37,3 +38,33 @@ jobs:
3738
body: |
3839
### Changes
3940
- Updates Forest CLI docs to the latest commit in the `main` branch.
41+
42+
update-rpc-docs:
43+
runs-on: ubuntu-24.04-arm
44+
steps:
45+
- uses: actions/checkout@v6
46+
- name: Generate OpenRPC specifications
47+
run: |
48+
cd docs/scripts
49+
./generate-openrpc-specs.sh docker
50+
# This is needed in order to have the commits signed.
51+
- uses: actions/create-github-app-token@v3
52+
id: generate-token
53+
with:
54+
app-id: ${{ secrets.LESHY_APP_ID }}
55+
private-key: ${{ secrets.LESHY_APP_PRIVATE_KEY }}
56+
- name: Create Pull Request
57+
uses: peter-evans/create-pull-request@v8
58+
with:
59+
base: main
60+
branch: leshy/update-forest-rpc-docs
61+
token: ${{ steps.generate-token.outputs.token }}
62+
commit-message: Update Forest RPC reference docs
63+
sign-commits: true
64+
title: "[automated] Update Forest RPC reference docs"
65+
add-paths: |
66+
docs/openrpc-specs/
67+
body: |
68+
### Changes
69+
- Updates Forest RPC reference docs to the latest commit in the `main` branch.
70+
- Regenerates OpenRPC specifications (v0, v1, v2) from latest Forest code.

.github/workflows/docs-rpc-auto-update.yml

Lines changed: 0 additions & 40 deletions
This file was deleted.

0 commit comments

Comments
 (0)