Skip to content
Merged
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
28 changes: 24 additions & 4 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ on:
paths:
- 'docs/**'
- 'scripts/**'
- 'app/**'
- 'mkdocs.yml'
- 'requirements-docs.txt'
- '.github/workflows/docs.yml'
pull_request:
paths:
- 'docs/**'
- 'scripts/**'
- 'app/**'
- 'mkdocs.yml'
- 'requirements-docs.txt'
- '.github/workflows/docs.yml'
Expand Down Expand Up @@ -40,19 +42,37 @@ jobs:
- name: Install toolchain
run: pip install -r requirements-docs.txt

# --strict turns broken internal links into failures. With ~200 generated
# pages that is the only realistic way to catch a bad cross-reference.
- name: Build
- name: Build docs
run: mkdocs build --strict

- uses: actions/setup-node@v6
with:
node-version: '22'
cache: npm
cache-dependency-path: app/package-lock.json

- name: Install config builder
working-directory: app
run: npm ci

- name: Test config builder
working-directory: app
run: npm test

- name: Build config builder
working-directory: app
run: npm run build

- name: Place config builder at /app
run: cp -r app/dist/. site/app/

- name: Upload Pages artifact
if: github.event_name != 'pull_request'
uses: actions/upload-pages-artifact@v5
with:
path: site

deploy:
# Pull requests build but do not publish.
if: github.event_name != 'pull_request'
needs: build
runs-on: ubuntu-latest
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,7 @@ obj/
# Documentation site
.venv/
site/

# Config builder app
app/node_modules/
app/dist/
16 changes: 16 additions & 0 deletions app/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Config builder · Ability Editor</title>
<meta
name="description"
content="Build XComAbilityEditor.ini entries for the XCOM 2 Ability Editor mod, with validation the mod itself does not provide."
/>
</head>
<body>
<div id="root"></div>
<script type="module" src="/src/main.tsx"></script>
</body>
</html>
Loading
Loading