Skip to content

Commit

Permalink
gh: add docs deployment
Browse files Browse the repository at this point in the history
Remove baseURL from Hugo config and use GH pages base URL value.
Deploy changes automatically on docs change.

Based on https://gohugo.io/hosting-and-deployment/hosting-on-github/
  • Loading branch information
mmatczuk committed Nov 27, 2023
1 parent 48628bf commit 1cb9f76
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 1 deletion.
68 changes: 68 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
name: Docs

on:
push:
branches:
- main
paths:
- 'docs/**'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Set version env variables
run: |
cat .version >> $GITHUB_ENV
- name: Install Hugo CLI
run: |
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
- name: Install Dart Sass
run: sudo snap install dart-sass

- name: Setup Pages
id: pages
uses: actions/configure-pages@v3

- name: Install Node.js dependencies
run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"

- name: Build with Hugo
env:
# For maximum backward compatibility with Hugo modules
HUGO_ENVIRONMENT: production
HUGO_ENV: production
run: hugo --gc --minify --baseURL "${{ steps.pages.outputs.base_url }}/"

- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./public

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
1 change: 0 additions & 1 deletion docs/hugo.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
baseURL = 'https://opensource.saucelabs.com/forwarder/'
languageCode = 'en-us'
title = 'Forwarder Proxy'

Expand Down

0 comments on commit 1cb9f76

Please sign in to comment.