mirror of
https://github.com/XRPLF/clio.git
synced 2026-09-28 07:58:10 +00:00
4af9e2f71f
Note: some files are taken exactly as they are in rippled, so changing something here wouldn't be great (because they will drift)
89 lines
2.2 KiB
YAML
89 lines
2.2 KiB
YAML
name: Documentation
|
|
|
|
on:
|
|
push:
|
|
branches: [develop]
|
|
workflow_dispatch:
|
|
pull_request:
|
|
branches: [release/*, develop]
|
|
paths:
|
|
- .github/workflows/docs.yml
|
|
|
|
- CMakeLists.txt
|
|
- conanfile.py
|
|
- conan.lock
|
|
- "cmake/**"
|
|
- "docs/**"
|
|
- "src/**"
|
|
- "tests/**"
|
|
|
|
concurrency:
|
|
# Only cancel in-progress jobs or runs for the current workflow - matches against branch & tags
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
defaults:
|
|
run:
|
|
shell: bash
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
container:
|
|
image: ghcr.io/xrplf/xrpld/nix-ubuntu:sha-060957e
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
with:
|
|
lfs: true
|
|
|
|
- name: Prepare runner
|
|
uses: XRPLF/actions/prepare-runner@b3e255d74d785d053e4903da8ac90983cd7d9e82
|
|
with:
|
|
enable_ccache: false
|
|
|
|
- name: Print build environment
|
|
uses: XRPLF/actions/print-build-env@59dec886e4afb05a1724443af08baccbc045b574
|
|
|
|
- name: Create build directory
|
|
run: mkdir build_docs
|
|
|
|
- name: Configure CMake
|
|
working-directory: build_docs
|
|
run: cmake ../docs
|
|
|
|
- name: Build
|
|
working-directory: build_docs
|
|
run: cmake --build . --target docs
|
|
|
|
- name: Setup Pages
|
|
if: ${{ github.repository == 'XRPLF/clio' && github.event_name == 'push' }}
|
|
uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
|
|
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
|
|
with:
|
|
path: build_docs/html
|
|
name: docs-develop
|
|
|
|
deploy:
|
|
if: ${{ github.repository == 'XRPLF/clio' && github.event_name == 'push' }}
|
|
needs: build
|
|
permissions:
|
|
pages: write
|
|
id-token: write
|
|
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1
|
|
with:
|
|
artifact_name: docs-develop
|