chore: address comments

TimefoldAI · Nov 14, 2024 · 4bb8a99 · 4bb8a99
1 parent c68506a
commit 4bb8a99
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 2 deletions.
diff --git a/.github/workflows/pull_request_secure.yml b/.github/workflows/pull_request_secure.yml
@@ -262,6 +262,10 @@ jobs:
 
   build_documentation:
     runs-on: ubuntu-latest
+    needs: approval_required
+    name: Build Documentation
+    env:
+      BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
     steps:
       - name: Checkout frontend
         id: checkout-frontend
@@ -271,6 +275,11 @@ jobs:
           token: ${{ secrets.JRELEASER_GITHUB_TOKEN }} # Safe; only used to clone the repo and not stored in the fork.
           fetch-depth: 0 # Otherwise merge will fail on account of not having history.
 
+      - name: Checkout timefold-solver
+        uses: actions/checkout@v4
+        with:
+          path: ./timefold-solver
+
       - name: Set up NodeJs
         uses: actions/setup-node@v4
         with:
@@ -281,12 +290,14 @@ jobs:
         env:
           GIT_CREDENTIALS: ${{ secrets.GIT_CREDENTIALS }}
         run: |
-          sed -i 's/tags:\s*\[v[0-9.]*,\s*v0.8.42]/tags: \[main]/' apps/docs/antora-playbook.yml
+          cp ${{ github.workspace }}/timefold-solver/docs/src/antora-playbook-template.yml apps/docs/antora-playbook.yml
+          sed -i "s/CHANGE_URL/$(git remote get-url origin)/" apps/docs/antora-playbook.yml
+          sed -i "s/REPLACEME/$BRANCH_NAME/" apps/docs/antora-playbook.yml
           npm ci
           npm run build -- --filter docs
 
       - name: Deploy Documentation (Preview Mode)
-        if: ${{ github.ref != 'refs/heads/main' }}
+        if: ${{ env.BRANCH_NAME != 'main' }}
         id: deploy
         uses: cloudflare/wrangler-action@v3
         with:

diff --git a/docs/src/antora-playbook-template.yml b/docs/src/antora-playbook-template.yml
@@ -0,0 +1,30 @@
+site:
+  title: Timefold Documentation
+  url: https://docs.timefold.ai
+  start_page: /
+  robots: allow
+  keys:
+    google_tag_manager: GTM-TBSQGHJ2
+    cache_key: {timeFoldCacheKey} #This is a placeholder for the cache key, will be filled in at build time
+
+urls:
+  html_extension_style: drop
+
+content:
+  edit_url: '{web_url}/edit/main/{path}'
+  sources:
+    - url: CHANGE_URL
+      branches: CHANGE_BRANCH
+      start_path: docs/src
+ui:
+  bundle:
+    url: build/ui-bundle.zip
+
+runtime:
+  fetch: true
+  log:
+    failure_level: error
+
+asciidoc:
+  extensions:
+    - '@asciidoctor/tabs'