From 2009fa8fee88901152d3339ae4da3158680637bc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Frederico=20Gon=C3=A7alves?=
 <zepfred@users.noreply.github.com>
Date: Tue, 26 Nov 2024 10:39:03 -0300
Subject: [PATCH] ci: update to compile and deploy Antora docs (#1140)

The PR updates the secure PR pipeline and adds a new job for compiling
and deploying the Antora docs.

1. The compilation step is necessary because certain errors are only
detected during the release process, which could delay the solver's
release.
2. The deployment step can help identify issues during the documentation
development phase, such as incorrect title configuration, inconsistent
menu items, etc.
3. The deployment step ensures that it is not used on the main branch
and that the production remains unchanged.
---
 .github/workflows/pull_request.yml        |  2 +-
 .github/workflows/pull_request_secure.yml | 67 +++++++++++++++++++++--
 2 files changed, 62 insertions(+), 7 deletions(-)

diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
index e102b99610..f353d73680 100644
--- a/.github/workflows/pull_request.yml
+++ b/.github/workflows/pull_request.yml
@@ -39,7 +39,7 @@ jobs:
           cache: 'maven'
 
       - name: Build and test timefold-solver
-        run: mvn -B -Dfull verify
+        run: mvn -B verify
   python:
     name: "Python Solver"
     concurrency:
diff --git a/.github/workflows/pull_request_secure.yml b/.github/workflows/pull_request_secure.yml
index 09f8756174..19373a181e 100644
--- a/.github/workflows/pull_request_secure.yml
+++ b/.github/workflows/pull_request_secure.yml
@@ -42,16 +42,16 @@ jobs:
       - id: validation
         shell: bash
         run: |
-            echo "Authorized user: ${{ steps.auth_check.outputs.authorized }}"
+          echo "Authorized user: ${{ steps.auth_check.outputs.authorized }}"
   # If the user is not a member, require a member to approve the PR.
   approval_required:
     needs: known_user
     environment:
-      ${{ 
-          github.event_name == 'pull_request_target' &&
-          github.event.pull_request.head.repo.full_name != github.repository &&
-          (needs.known_user.outputs.is_member_of_org != 'true' || github.actor == 'dependabot[bot]') &&
-          'external' || 'internal' 
+      ${{
+      github.event_name == 'pull_request_target' &&
+      github.event.pull_request.head.repo.full_name != github.repository &&
+      (needs.known_user.outputs.is_member_of_org != 'true' || github.actor == 'dependabot[bot]') &&
+      'external' || 'internal'
       }}
     runs-on: ubuntu-latest
     steps:
@@ -259,6 +259,61 @@ jobs:
         env:
           PIP_FIND_LINKS: ${{ github.workspace }}/timefold-solver/dist
         run: tox
+
+  build_documentation:
+    runs-on: ubuntu-latest
+    needs: approval_required
+    name: Build Documentation
+    env:
+      BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
+    steps:
+      - name: Install yq
+        run: |
+          sudo wget https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 -O /usr/bin/yq 
+          sudo chmod +x /usr/bin/yq
+
+      - name: Checkout frontend
+        id: checkout-frontend
+        uses: actions/checkout@v4
+        with:
+          repository: TimefoldAI/frontend
+          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:
+          node-version-file: .nvmrc
+          cache: npm
+
+      - name: Build Documentation
+        env:
+          GIT_CREDENTIALS: ${{ secrets.GIT_CREDENTIALS }}
+        run: |
+          
+          cd ${{ github.workspace }}/timefold-solver/
+          export GURL="$(git remote get-url origin)"
+          cd -
+          yq -i e 'del(.content.sources)' apps/docs/antora-playbook.yml
+          yq -i e '.content.sources += [{"url": env(GURL), "branches": env(BRANCH_NAME), "start_path": "docs/src"}]' apps/docs/antora-playbook.yml
+          npm ci
+          npm run build -- --filter docs
+
+      - name: Deploy Documentation (Preview Mode)
+        if: ${{ env.BRANCH_NAME != 'main' }}
+        id: deploy
+        uses: cloudflare/wrangler-action@v3
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          workingDirectory: ./apps/docs
+          command: pages deploy ./public-serve --project-name=timefold-docs --branch=${{ github.ref }}
+
   sonarcloud:
     needs: approval_required
     name: SonarCloud