Skip to content

feat: Update documentation action, bump version for local testing #2820

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 26, 2024
Merged

feat: Update documentation action, bump version for local testing #2820

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c655bdb
feat: Update documentation action, bump version for local testing
ADubhlaoich Nov 26, 2024
b05f668
Update .github/workflows/docs-build-push.yml
ADubhlaoich Nov 26, 2024
97eba95
feat: Re-add comment about preview URL
ADubhlaoich Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions .github/workflows/docs-build-push.yml
View file
Open in desktop
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 for 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 # Required to add the preview URL comment
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
View file
Open in desktop
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
View file
Open in desktop
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=
Loading