Skip to content

feat: gate RPC network tx submission behind internal auth header (#2141) #6086

feat: gate RPC network tx submission behind internal auth header (#2141)

feat: gate RPC network tx submission behind internal auth header (#2141) #6086

Workflow file for this run

# Performs checks, builds and deploys the documentation mdbook.
#
# Flow is based on the official github and mdbook documentation:
#
# https://github.com/actions/starter-workflows/blob/main/pages/mdbook.yml
# https://github.com/rust-lang/mdBook/wiki/Automated-Deployment%3A-GitHub-Actions
name: book
# Documentation should be built and tested on every pull-request, and additionally deployed on push onto next.
on:
workflow_dispatch:
pull_request:
paths: ["docs/internal/**"]
push:
branches: [next]
paths: ["docs/internal/**"]
permissions:
contents: read
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Always build and test the mdbook documentation whenever the docs folder is changed.
#
# The documentation is uploaded as a github artifact IFF it is required for deployment i.e. on push into next.
build:
name: Build documentation
permissions:
contents: read
pages: write
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
with:
persist-credentials: false
# Installation from source takes a fair while, so we install the binaries directly instead.
- name: Install mdbook and plugins
uses: taiki-e/install-action@055f5df8c3f65ea01cd41e9dc855becd88953486 # v2.75.18
with:
tool: mdbook@0.4, mdbook-linkcheck@0.7, mdbook-alerts@0.8, mdbook-katex@0.9
- name: Build book
run: mdbook build docs/internal/
# Only Upload documentation if we want to deploy (i.e. push to next).
- name: Setup Pages
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
id: pages
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5
- name: Upload book artifact
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
with:
# We specify multiple [output] sections in our book.toml which causes mdbook to create separate folders for each. This moves the generated `html` into its own `html` subdirectory.
path: ./docs/internal/book/html
# Deployment job only runs on push to next.
deploy:
name: Deploy documentation
permissions:
contents: read
id-token: write
pages: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-24.04
needs: build
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4