89 lines
2.5 KiB
YAML
89 lines
2.5 KiB
YAML
---
|
|
name: publish_docs
|
|
|
|
on:
|
|
workflow_dispatch: {}
|
|
push:
|
|
branches:
|
|
- main
|
|
- 'v4.*.x'
|
|
paths:
|
|
- 'userdocs/**'
|
|
pull_request:
|
|
branches:
|
|
- main
|
|
- 'v4.*.x'
|
|
|
|
jobs:
|
|
publish:
|
|
if: ${{ github.repository_owner == 'warewulf' }}
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
submodules: recursive
|
|
|
|
- name: Update repositories
|
|
run: |
|
|
sudo apt update
|
|
|
|
- name: Install dependencies
|
|
run: |
|
|
sudo apt-get install -f -y texlive-latex-extra latexmk graphviz pandoc
|
|
|
|
- name: Setup Python
|
|
uses: actions/setup-python@v5
|
|
|
|
- name: Install Sphinx
|
|
run: |
|
|
pip install --user --upgrade --upgrade-strategy eager sphinx sphinx-rtd-theme restructuredtext_lint pygments sphinx_reredirects
|
|
|
|
- name: Include reference docs
|
|
run: |
|
|
make reference
|
|
|
|
- name: Include man pages
|
|
run: |
|
|
mkdir -p userdocs/reference/man5
|
|
for f in docs/man/man5/*.5
|
|
do
|
|
title="$(basename "${f%.5}")"'(5)'
|
|
output="userdocs/reference/man5/$(basename "${f%.5}.rst")"
|
|
line=$(printf '=%.0s' $(seq ${#title}))
|
|
printf "%s\n%s\n%s\n\n" "$line" "$title" "$line" > "$output"
|
|
pandoc -f man -t rst "$f" >> "$output"
|
|
done
|
|
|
|
- name: Build web documentation
|
|
run: |
|
|
make -C userdocs html
|
|
|
|
- name: Install SSH key
|
|
if: github.event_name != 'pull_request'
|
|
env:
|
|
SSH_AUTH_SOCK: /tmp/ssh_agent.sock
|
|
run: |
|
|
mkdir -p ~/.ssh
|
|
ssh-keyscan github.com >> ~/.ssh/known_hosts
|
|
echo "${{ secrets.GH_DEPLOY_KEY }}" > ~/.ssh/id_rsa
|
|
chmod 600 ~/.ssh/id_rsa
|
|
cat <<EOT >> ~/.ssh/config
|
|
Host github.com
|
|
HostName github.com
|
|
IdentityFile ~/.ssh/id_rsa
|
|
EOT
|
|
git config --global user.email "actions@github.com"
|
|
git config --global user.name "gh-actions"
|
|
|
|
- name: Update website repo
|
|
if: github.event_name != 'pull_request'
|
|
run: |
|
|
git clone git@github.com:warewulf/warewulf.org.git ~/warewulf-web
|
|
mkdir -p ~/warewulf-web/static/docs
|
|
rm -rf ~/warewulf-web/static/docs/${GITHUB_REF##*/}
|
|
cp -r userdocs/_build/html ~/warewulf-web/static/docs/${GITHUB_REF##*/}
|
|
cd ~/warewulf-web
|
|
git add static/docs/${GITHUB_REF##*/}
|
|
git commit -m "Update ${GITHUB_REF##*/} docs"
|
|
git push
|