Fix docs GH action

The following changes are made in this commit:
* addging a missing GH pages setup step
* docs: add baseurl build arg
* naming the docs pipeline
* permissions fix in the GH docs workflow
* updating the trigger on the docs workflow
* moving default to Dockerfile instead of the bake config

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>, James Hewitt <james.hewitt@uk.ibm.com>
Signed-off-by: Milos Gajdos <milosthegajdos@gmail.com>

.github/workflows/docs.yml

@@ -1,3 +1,5 @@
+name: docs
+
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
@@ -7,6 +9,8 @@ on:
     branches:
       - main
     paths:
+      - .github/workflows/docs.yml
+      - dockerfiles/docs.Dockerfile
       - docs/**
   workflow_dispatch:
 
@@ -20,6 +24,9 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v3
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
       - name: Build docs
@@ -31,6 +38,13 @@ jobs:
           set: |
             *.cache-from=type=gha,scope=docs
             *.cache-to=type=gha,scope=docs,mode=max
+        env:
+          DOCS_BASEURL: ${{ steps.pages.outputs.base_path }}
+      - name: Fix permissions
+        run: |
+          chmod -c -R +rX "./build/docs" | while read line; do
+            echo "::warning title=Invalid file permissions automatically fixed::$line"
+          done
       - name: Upload Pages artifact
         uses: actions/upload-pages-artifact@v2
         with:

docker-bake.hcl

@@ -95,8 +95,15 @@ target "image-all" {
   ]
 }
 
+variable "DOCS_BASEURL" {
+  default = null
+}
+
 target "_common_docs" {
   dockerfile = "./dockerfiles/docs.Dockerfile"
+  args = {
+    DOCS_BASEURL = DOCS_BASEURL
+  }
 }
 
 target "docs-export" {

dockerfiles/docs.Dockerfile

@@ -16,8 +16,9 @@ COPY --from=hugo $GOPATH/bin/hugo /bin/hugo
 WORKDIR /src
 
 FROM build-base AS build
+ARG DOCS_BASEURL=/
 RUN --mount=type=bind,rw,source=docs,target=. \
-    hugo --gc --minify --destination /out
+    hugo --gc --minify --destination /out -b $DOCS_BASEURL
 
 FROM build-base AS server
 COPY docs .