Skip to content

Docs Fixes

Docs Fixes #23

Workflow file for this run

name: Trigger documentation build
on:
push:
branches:
- 'main'
paths:
- 'docs/**'
pull_request:
branches:
- 'main'
paths:
- 'docs/**'
env:
VALE_VERSION: ${{ vars.LIBRARY_VALE_VERSION || '3.3.0' }}
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
- name: Install vale
run: |
wget "https://github.com/errata-ai/vale/releases/download/v${VALE_VERSION}/vale_${VALE_VERSION}_Linux_64-bit.tar.gz"
sudo tar -xvzf vale_${VALE_VERSION}_Linux_64-bit.tar.gz -C /usr/local/bin vale
- name: Generate Site
run: |
cd docs/_playbook/
npm install
export GIT_CREDENTIALS='https://axoniq-devops:${{ secrets.LIBRARY_DEVBOT_TOKEN }}@github.com'
echo 'Using' `vale -v`
npx antora playbook.yaml
- name: Notify AxonIQ Library (if a push to a tracked branch)
if: ${{ github.event_name == 'push'}}
uses: actions/github-script@v7
with:
github-token: ${{ secrets.LIBRARY_DEVBOT_TOKEN }}
script: |
await github.rest.actions.createWorkflowDispatch({
owner: 'AxonIQ',
repo: 'axoniq-library-site',
workflow_id: 'publish.yml',
ref: 'main'
})