Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a GitHub Actions workflow to build and update website #2603

Merged
merged 1 commit into from
Jun 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions .github/workflows/website.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Update website
on:
push:
branches:
- master
paths:
- 'docs/**'
concurrency: website
permissions:
contents: write

jobs:
website:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
cache: pipenv
- name: Install pipenv
run: pip install pipenv
- name: Install dependencies
run: pipenv sync
working-directory: docs
- name: Update website
run: scripts/update-website
- name: Commit changes
run: |
if git diff --quiet; then
git add --all
git config user.name 'github-actions[bot]'
git config user.email 'github-actions[bot]@users.noreply.github.com'
git commit -m 'Update website'
git push origin gh-pages
fi
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ m4/ltversion.m4
m4/lt~obsolete.m4
tests/*.trs

# Docs output
docs/output

itchyny marked this conversation as resolved.
Show resolved Hide resolved
cscope.in.out
cscope.out
cscope.po.out
Expand Down
3 changes: 0 additions & 3 deletions docs/.gitignore

This file was deleted.

9 changes: 5 additions & 4 deletions scripts/update-website
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
#!/bin/sh
#!/bin/bash

# This script builds the website from the docs directory of
# the current branch and copies it over to the gh-pages
# branch.

set -eu
set -o xtrace
set -eux
shopt -s dotglob

# build website
scriptdir=`dirname "$0"`
scriptdir=$(dirname "$0")
cd "$scriptdir"/../docs
rm -rf output
mkdir output
pipenv run python3 build_website.py
cd ..

Expand Down