Skip to content

Merge pull request #1141 from anderbubble/docs-override-paths #39

Merge pull request #1141 from anderbubble/docs-override-paths

Merge pull request #1141 from anderbubble/docs-override-paths #39

Workflow file for this run

---
name: publish_docs
on:
workflow_dispatch: {}
push:
branches:
- main
- 'v4.*.x'
paths:
- 'userdocs/**'
pull_request:
branches:
- main
- 'v4.*.x'
paths:
- 'userdocs/**'
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 LaTeX dependencies
run: |
sudo apt-get install -f -y texlive-latex-extra latexmk
- name: Install graphviz
run: |
sudo apt-get install -f -y graphviz
- name: Setup Python
uses: actions/setup-python@v1
- name: Install Sphinx
run: |
pip install --user --upgrade --upgrade-strategy eager sphinx sphinx-rtd-theme restructuredtext_lint pygments
- name: Build web documentation
run: |
cd userdocs
make 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