Skip to content

chore(rpc/docs): add rust caching #65

chore(rpc/docs): add rust caching

chore(rpc/docs): add rust caching #65

Workflow file for this run

name: OpenRPC (Build & Deploy GitHub pages)
on:
push:
branches:
- main
paths:
- core/rpc/src/api/**
- .github/workflows/openrpc-docs.yml
workflow_dispatch:
jobs:
deploy:
name: Create RPC Docs
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./docs/rpc
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 16
- uses: actions-rust-lang/setup-rust-toolchain@v1
with:
toolchain: stable
- name: Rust cache
uses: swatinem/rust-cache@v2
- name: Build RPC Docs
run: cargo run --bin generate-openrpc-spec -- --write-to .
- name: Install open-rpc
run: npm install -g @open-rpc/generator
- name: Update Openrpc (JSON)
run: open-rpc-generator generate -c openrpc.json
- name: Generate OpenRPC Site (Gatsby)
run: open-rpc-generator generate -t docs -d openrpc.json -l gatsby
- name: Setup config
working-directory: ./docs/rpc/docs/gatsby
run: |
echo "module.exports = {
pathPrefix: 'lightning',
siteMetadata: {
title: 'Fleek Network JSON-RPC',
description: 'This API enables JSON-RPC interaction with Fleek Network Node',
logoUrl: 'https://raw.githubusercontent.com/open-rpc/design/master/icons/open-rpc-logo-noText/open-rpc-logo-noText%20(PNG)/256x256.png',
primaryColor: '#3f51b5', //material-ui primary color
secondaryColor: '#f50057', //material-ui secondary color
author: '',
menuLinks: [
{
name: 'home',
link: '/',
ignoreNextPrev: true
},
{
name: 'API Documentation',
link: '/api-documentation'
}
],
footerLinks: [
{
name: 'OpenRPC',
link: 'https://open-rpc.org'
}
]
},
plugins: [
'@xops.net/gatsby-openrpc-theme',
{
resolve: 'gatsby-plugin-manifest',
options: {
name: 'pristine-site',
short_name: 'pristine-site',
start_url: '/',
background_color: 'transparent',
theme_color: '#3f51b5',
display: 'minimal-ui',
icon: 'src/images/gatsby-icon.png', // This path is relative to the root of the site.
},
}
],
}" > gatsby-config.js
- name: Install dependencies
working-directory: ./docs/rpc/docs/gatsby
run: |
npm i [email protected] [email protected] -S
npm i [email protected] -S
npm install --force
- name: Fix paths
working-directory: ./docs/rpc/docs/gatsby
# fix: 🐛 support gatsby path prefix https://github.com/open-rpc/generator/pull/708
run: sed -i 's|href="/api-documentation"|href="/lightning/api-documentation"|g' src/pages/index.tsx
- name: Build docs
working-directory: ./docs/rpc/docs/gatsby
run: |
export NODE_OPTIONS="--max_old_space_size=4096"
npx gatsby build --prefix-paths
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/rpc/docs/gatsby/public
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
- name: Commit files
working-directory: ./
run: |
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git add docs/
git commit -a -m "Generate OpenRPC docs"
- name: Push changes
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: ${{ github.ref }}