Skip to content

Commit

Permalink
feat: Update documentation action, bump version for local testing
Browse files Browse the repository at this point in the history
This commit bumps the theme version for the documentation website, and
updates the GitHub action used for deploying the website. The update
allows you to specify what version of the theme to use for a deployment,
which reduces the drift compared to relying on the local version.
  • Loading branch information
ADubhlaoich committed Nov 26, 2024
1 parent 9928702 commit 99e9d08
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 5 deletions.
10 changes: 8 additions & 2 deletions .github/workflows/docs-build-push.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build and deploy docs
name: Build and deploy documentation
on:
workflow_dispatch:
inputs:
Expand All @@ -12,6 +12,11 @@ on:
- dev
- staging
- prod
hugo_theme_override:
description: "Hugo theme version (Leave blank to latest)"
required: false
default: ""
type: string
pull_request:
branches:
- "*"
Expand Down Expand Up @@ -43,7 +48,7 @@ jobs:
if: ${{ github.event.repository.fork == false && needs.vars.outputs.azure_creds == 'true' }}
uses: nginxinc/docs-actions/.github/workflows/docs-build-push.yml@9c59fab05a8131f4d691ba6ea2b6a119f3ef832a # v1.0.7
permissions:
pull-requests: write # needed to write preview url comment to PR
pull-requests: write
contents: read
with:
production_url_path: "/nginx-gateway-fabric"
Expand All @@ -52,6 +57,7 @@ jobs:
docs_build_path: "./site"
doc_type: "hugo"
environment: ${{ inputs.environment }}
force_hugo_theme_version: ${{inputs.hugo_theme_override}}
secrets:
AZURE_CREDENTIALS: ${{ secrets.AZURE_CREDENTIALS_DOCS }}
AZURE_KEY_VAULT: ${{ secrets.AZURE_KEY_VAULT_DOCS }}
2 changes: 1 addition & 1 deletion site/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ module github.com/nginxinc/nginx-gateway-fabric/site

go 1.21

require github.com/nginxinc/nginx-hugo-theme v0.41.22 // indirect
require github.com/nginxinc/nginx-hugo-theme v0.41.23 // indirect
4 changes: 2 additions & 2 deletions site/go.sum
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
github.com/nginxinc/nginx-hugo-theme v0.41.22 h1:Gb/OLbpumNqp8vOPkZzO2GmgPDRd1yr2tWHWUBHg8BA=
github.com/nginxinc/nginx-hugo-theme v0.41.22/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=
github.com/nginxinc/nginx-hugo-theme v0.41.23 h1:ddIfLF7BFd78qyIn3z5aReeC4BO/m9FH81d5S+al/6s=
github.com/nginxinc/nginx-hugo-theme v0.41.23/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=

0 comments on commit 99e9d08

Please sign in to comment.