Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci-ios.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
uses: actions/checkout@v6

- name: Setup Swift
uses: swift-actions/setup-swift@v2
uses: swift-actions/setup-swift@v3
with:
swift-version: ${{ matrix.swift }}

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci-linux.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
uses: actions/checkout@v6

- name: Setup Swift
uses: swift-actions/setup-swift@v2
uses: swift-actions/setup-swift@v3
with:
swift-version: ${{ matrix.swift }}

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci-macos.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
uses: actions/checkout@v6

- name: Setup Swift
uses: swift-actions/setup-swift@v2
uses: swift-actions/setup-swift@v3
with:
swift-version: ${{ matrix.swift }}

Expand Down
52 changes: 50 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,14 @@ name: Documentation
on:
push:
branches: [ master, main ]
pull_request:
branches: [ master, main ]
workflow_dispatch:

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
Expand All @@ -20,12 +26,32 @@ jobs:
uses: actions/checkout@v6

- name: Setup Swift
uses: swift-actions/setup-swift@v2
uses: swift-actions/setup-swift@v3
with:
swift-version: "6.1"

- name: Build Documentation
run: make docs-generate
run: make docs-generate REPO_NAME=math DOCS_VERSION_PATH=main

- name: Add Root Redirect
run: |
cat <<EOF > .build/documentation/index.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Redirecting to Documentation</title>
<link rel="canonical" href="main/documentation/fireblademath/">
<script>
window.location.href = "main/documentation/fireblademath/" + window.location.hash;
</script>
<meta http-equiv="refresh" content="0;url=main/documentation/fireblademath/">
</head>
<body>
<p>Redirecting to <a href="main/documentation/fireblademath/">documentation</a>...</p>
</body>
</html>
EOF

- name: Check Documentation Quality
run: |
Expand All @@ -49,3 +75,25 @@ jobs:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

smoke-test:
name: Post-Deployment Smoke Test
needs: deploy
runs-on: ubuntu-latest
steps:
- name: Check Documentation URL
run: |
# Wait a few seconds for CDN propagation
sleep 10
# Verify the versioned documentation path exists
curl --fail -sL https://fireblade-engine.github.io/math/main/documentation/fireblademath/ | grep -q "FirebladeMath"
echo "Documentation is live at /math/main/"

- name: Check Root Redirect
run: |
# Verify that the root URL redirects correctly
RESPONSE=$(curl -sI https://fireblade-engine.github.io/math/ | head -n 1)
# Note: GitHub Pages might return 200 with the redirect meta tag, or a 301/302 if configured at the DNS level.
# Since we use a meta/JS redirect, we check for a 200 OK and then the content.
curl -s https://fireblade-engine.github.io/math/ | grep -q "Redirecting to"
echo "Root redirect is live at /math/"
10 changes: 8 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@ UNAME_S := $(shell uname -s)
SWIFT_FLAGS ?= --disable-sandbox
PACKAGE_SWIFT_VERSION := $(shell grep "swift-tools-version" Package.swift | head -n 1 | cut -d ":" -f 2 | xargs)

HOSTING_BASE_PATH ?= fireblade-math
# Repository name on GitHub Pages
REPO_NAME ?= math
# Subdirectory for versioned documentation (e.g., main, 1.0.0)
DOCS_VERSION_PATH ?= main

# The full base path for hosting
HOSTING_BASE_PATH ?= $(REPO_NAME)/$(DOCS_VERSION_PATH)

# Targets
.PHONY: setup lint lint-fix test test-coverage clean pre-commit docs docs-preview docs-generate docs-coverage
Expand All @@ -25,7 +31,7 @@ docs-generate:
--disable-indexing \
--transform-for-static-hosting \
--hosting-base-path $(HOSTING_BASE_PATH) \
--output-path .build/documentation
--output-path .build/documentation/$(DOCS_VERSION_PATH)

docs-coverage: docs-check-coverage

Expand Down
Loading