Skip to content

Commit

Permalink
doc(hugo): Add hugo upgrade process
Browse files Browse the repository at this point in the history
  • Loading branch information
vmercierfr committed Nov 23, 2023
1 parent 3fed035 commit 431b00b
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/hugo-upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Hugo upgrade

[Hugo](https://github.com/gohugoio/hugo) engine is frequently updated by the team to add features or bug fixes.

Here is the process to upgrade Hugo:

1. Test new Hugo version locally

1. Launch Hugo with new version:

```bash
export HUGO_VERSION=<new_version>
docker compose up
```

1. Check website rendering on <http://localhost:1313>

Checklist:

- Check runbook (including SQL rendering) in runbook (e.g. `PostgreSQLInactiveLogicalReplicationSlot` runbook)
- Check tabs are correctly rendered in tutorials (e.g. `RDS exporter deployment`)
- Check search engine
- Check "last update" information in page footer

1. Upgrade Hugo version for local development environment in `docker-compose.yaml`

1. Upgrade Hugo version for CI in `.github/workflows/release.yaml`

0 comments on commit 431b00b

Please sign in to comment.