Skip to content

Commit d223025

Browse files
ADubhlaoichbjee19
andauthored
feat: Update documentation action, bump version for local testing (#2820)
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. Co-authored-by: bjee19 <[email protected]>
1 parent 9928702 commit d223025

File tree

3 files changed

+11
-5
lines changed

3 files changed

+11
-5
lines changed

.github/workflows/docs-build-push.yml

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Build and deploy docs
1+
name: Build and deploy documentation
22
on:
33
workflow_dispatch:
44
inputs:
@@ -12,6 +12,11 @@ on:
1212
- dev
1313
- staging
1414
- prod
15+
hugo_theme_override:
16+
description: "Hugo theme version (Leave blank for latest)"
17+
required: false
18+
default: ""
19+
type: string
1520
pull_request:
1621
branches:
1722
- "*"
@@ -43,7 +48,7 @@ jobs:
4348
if: ${{ github.event.repository.fork == false && needs.vars.outputs.azure_creds == 'true' }}
4449
uses: nginxinc/docs-actions/.github/workflows/docs-build-push.yml@9c59fab05a8131f4d691ba6ea2b6a119f3ef832a # v1.0.7
4550
permissions:
46-
pull-requests: write # needed to write preview url comment to PR
51+
pull-requests: write # Required to add the preview URL comment
4752
contents: read
4853
with:
4954
production_url_path: "/nginx-gateway-fabric"
@@ -52,6 +57,7 @@ jobs:
5257
docs_build_path: "./site"
5358
doc_type: "hugo"
5459
environment: ${{ inputs.environment }}
60+
force_hugo_theme_version: ${{ inputs.hugo_theme_override }}
5561
secrets:
5662
AZURE_CREDENTIALS: ${{ secrets.AZURE_CREDENTIALS_DOCS }}
5763
AZURE_KEY_VAULT: ${{ secrets.AZURE_KEY_VAULT_DOCS }}

site/go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ module github.com./nginxinc/nginx-gateway-fabric/site
22

33
go 1.21
44

5-
require github.com./nginxinc/nginx-hugo-theme v0.41.22 // indirect
5+
require github.com./nginxinc/nginx-hugo-theme v0.41.23 // indirect

site/go.sum

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
github.com./nginxinc/nginx-hugo-theme v0.41.22 h1:Gb/OLbpumNqp8vOPkZzO2GmgPDRd1yr2tWHWUBHg8BA=
2-
github.com./nginxinc/nginx-hugo-theme v0.41.22/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=
1+
github.com./nginxinc/nginx-hugo-theme v0.41.23 h1:ddIfLF7BFd78qyIn3z5aReeC4BO/m9FH81d5S+al/6s=
2+
github.com./nginxinc/nginx-hugo-theme v0.41.23/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=

0 commit comments

Comments
 (0)