Manual Release Steps of Documentation

These steps are intended to be used when the documentation needs to be pushed to the pages repo manually.

1) Ensure Clean Repo

Make sure all of the project changes are pulled down.

git checkout main
git pull --ff-only
git tag --list | tail

If needed

git fetch --tags

Make sure have the latest docs built.

scripts/build_docs.sh

This should create the docs in sphinx/build/html. To check:

test -f sphinx/build/html/index.html

From the parent directory of this repo (so don’t accidentally commit the pages repo into this repo), clone the pages repo.

git clone git@codeberg.org:BuffaloHerd/pages.git

or if you already have a clone of it there then just update it

cd pages
git checkout main
git pull --ff-only
cd ..

Clear out the old documentation directory for this project in the pages repo and replace it with the new documentation.

rm -fr pages/BuffaloExampleDocs
mkdir -p pages/BuffaloExampleDocs
cp -a BuffaloExample/sphinx/build/html/. pages/BuffaloExampleDocs/

cd pages
git add BuffaloExampleDocs
git status
git commit -m "Updated Buffalo Example to v{version}"
git push -u origin HEAD

Make sure to replace {version} with the correct version.