|
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 |
3 | 4 | permissions: |
4 | 5 | contents: read |
5 | 6 |
|
|
9 | 10 | - cron: "0 0 * * *" |
10 | 11 |
|
11 | 12 | jobs: |
12 | | - update-docs: |
| 13 | + update-cli-docs: |
13 | 14 | runs-on: ubuntu-24.04-arm |
14 | 15 | steps: |
15 | 16 | - uses: actions/checkout@v6 |
|
37 | 38 | body: | |
38 | 39 | ### Changes |
39 | 40 | - 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. |
0 commit comments