Skip to content

Commit

Permalink
chore: address comments
Browse files Browse the repository at this point in the history
  • Loading branch information
zepfred committed Nov 14, 2024
1 parent c68506a commit 7abc217
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 3 deletions.
17 changes: 14 additions & 3 deletions .github/workflows/pull_request_secure.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand All @@ -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
Expand Down
30 changes: 30 additions & 0 deletions docs/src/antora-playbook-template.yml
Original file line number Diff line number Diff line change
@@ -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: [email protected]: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'

0 comments on commit 7abc217

Please sign in to comment.