diff --git a/.github/workflows/pull_request_secure.yml b/.github/workflows/pull_request_secure.yml index 9cd47931df..ed9b7aad52 100644 --- 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,19 +290,21 @@ 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/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: 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 }} + # command: pages deploy ./public-serve --project-name=timefold-docs --branch=${{ github.ref }} + command: echo "deploy" sonarcloud: needs: approval_required diff --git a/docs/src/antora-playbook-template.yml b/docs/src/antora-playbook-template.yml new file mode 100644 index 0000000000..56730a100e --- /dev/null +++ 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: git@github.com:timefoldai/timefold-solver.git + branches: REPLACEME + start_path: docs/src +ui: + bundle: + url: build/ui-bundle.zip + +runtime: + fetch: true + log: + failure_level: error + +asciidoc: + extensions: + - '@asciidoctor/tabs'