GitHub Actions Deployment (Later)¶

This repo starts with manual local publishing:

mkdocs gh-deploy

That keeps the deployment path simple while getting comfortable with the workflow.

Current flow¶

Sync source¶

git add .
git commit -m "update notes"
git push

Publish site¶

mkdocs gh-deploy

Later flow¶

When ready, switch to GitHub Actions so that a push to main can build and publish automatically.

Activation steps¶

1. Rename:

.github/workflows/deploy.yml.example

to:

.github/workflows/deploy.yml

1. Commit and push the change.
2. Stop running mkdocs gh-deploy locally.
3. Use git push as both source sync and publish trigger.