349 lines
9.2 KiB
YAML
349 lines
9.2 KiB
YAML
name: Publish Docs
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
inputs:
|
|
version:
|
|
description: 'Docs version to publish (e.g. 2.1.0)'
|
|
required: true
|
|
type: string
|
|
|
|
workflow_call:
|
|
inputs:
|
|
version:
|
|
description: 'Docs version to publish (e.g. 2.1.0)'
|
|
required: true
|
|
type: string
|
|
secrets:
|
|
MAVEN_USERNAME:
|
|
required: true
|
|
MAVEN_PASSWORD:
|
|
required: true
|
|
|
|
jobs:
|
|
docs:
|
|
name: Build JavaDoc & Update gh-pages
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
contents: write
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Set up Temurin 21
|
|
uses: actions/setup-java@v4
|
|
with:
|
|
distribution: temurin
|
|
java-version: 21
|
|
cache: maven
|
|
|
|
- name: Build project (compile + resolve deps, skip tests)
|
|
run: mvn -B --settings .github/settings.xml clean verify -DskipTests
|
|
env:
|
|
MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
|
|
MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
|
|
|
|
# javadoc:aggregate runs on the reactor root.
|
|
# With flash + flash-extensions both declared as modules in root pom.xml,
|
|
# this produces a single aggregated Javadoc covering all modules.
|
|
# Default output path: target/site/apidocs/ (no custom reportOutputDirectory set).
|
|
- name: Generate aggregated JavaDoc
|
|
run: |
|
|
mvn -B \
|
|
--settings .github/settings.xml \
|
|
-DskipTests \
|
|
org.apache.maven.plugins:maven-javadoc-plugin:3.6.3:aggregate
|
|
env:
|
|
MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
|
|
MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
|
|
|
|
- name: Verify JavaDoc output exists
|
|
run: |
|
|
APIDOCS=""
|
|
|
|
if [ -f "target/site/apidocs/index.html" ]; then
|
|
APIDOCS="target/site/apidocs"
|
|
elif [ -f "target/reports/apidocs/index.html" ]; then
|
|
APIDOCS="target/reports/apidocs"
|
|
else
|
|
echo "ERROR: JavaDoc output not found."
|
|
echo
|
|
echo "Contents of target/:"
|
|
find target -maxdepth 5 2>/dev/null || echo "(empty)"
|
|
exit 1
|
|
fi
|
|
|
|
echo "APIDOCS_DIR=$APIDOCS" >> $GITHUB_ENV
|
|
|
|
COUNT=$(find "$APIDOCS" -name '*.html' | wc -l)
|
|
echo "JavaDoc OK — $COUNT HTML files at $APIDOCS"
|
|
|
|
- name: Checkout gh-pages
|
|
uses: actions/checkout@v4
|
|
with:
|
|
ref: gh-pages
|
|
path: gh-pages-out
|
|
token: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
- name: Copy JavaDoc to versioned folder and latest
|
|
run: |
|
|
VERSION=${{ inputs.version }}
|
|
|
|
mkdir -p gh-pages-out/javadoc/$VERSION
|
|
cp -r "$APIDOCS_DIR"/. gh-pages-out/javadoc/$VERSION/
|
|
|
|
rm -rf gh-pages-out/latest
|
|
mkdir -p gh-pages-out/latest
|
|
cp -r "$APIDOCS_DIR"/. gh-pages-out/latest/
|
|
|
|
- name: Regenerate index.html
|
|
run: |
|
|
cd gh-pages-out
|
|
python3 - <<'EOF'
|
|
import os, re
|
|
|
|
def version_key(v):
|
|
parts = re.findall(r'\d+', v)
|
|
return [int(p) for p in parts] if parts else [0]
|
|
|
|
versions = sorted(
|
|
[d for d in os.listdir("javadoc") if os.path.isdir(f"javadoc/{d}")],
|
|
key=version_key,
|
|
reverse=True
|
|
)
|
|
|
|
latest = versions[0] if versions else None
|
|
|
|
rows = "\n".join(
|
|
f'''
|
|
<div class="release">
|
|
<div class="release-info">
|
|
<span class="version">{v}</span>
|
|
{"<span class=\\"badge\\">latest</span>" if v == latest else ""}
|
|
</div>
|
|
|
|
<a href="javadoc/{v}/index.html">Open</a>
|
|
</div>
|
|
'''
|
|
for v in versions
|
|
)
|
|
|
|
html = """<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Flash — JavaDoc</title>
|
|
|
|
<style>
|
|
:root {
|
|
--bg: #ffffff;
|
|
--surface: #fafafa;
|
|
--border: #e5e7eb;
|
|
|
|
--text: #111827;
|
|
--muted: #6b7280;
|
|
|
|
--accent: #111827;
|
|
--accent-hover: #000000;
|
|
}
|
|
|
|
* {
|
|
box-sizing: border-box;
|
|
margin: 0;
|
|
padding: 0;
|
|
}
|
|
|
|
body {
|
|
font-family:
|
|
Inter,
|
|
ui-sans-serif,
|
|
system-ui,
|
|
-apple-system,
|
|
BlinkMacSystemFont,
|
|
"Segoe UI",
|
|
sans-serif;
|
|
|
|
background: var(--bg);
|
|
color: var(--text);
|
|
|
|
min-height: 100vh;
|
|
padding: 64px 24px;
|
|
}
|
|
|
|
.container {
|
|
width: 100%;
|
|
max-width: 760px;
|
|
margin: 0 auto;
|
|
}
|
|
|
|
.header {
|
|
margin-bottom: 40px;
|
|
}
|
|
|
|
.header h1 {
|
|
font-size: 2rem;
|
|
font-weight: 600;
|
|
letter-spacing: -0.04em;
|
|
}
|
|
|
|
.header p {
|
|
margin-top: 10px;
|
|
|
|
color: var(--muted);
|
|
font-size: 0.95rem;
|
|
line-height: 1.6;
|
|
}
|
|
|
|
.latest {
|
|
display: inline-flex;
|
|
align-items: center;
|
|
|
|
margin-top: 20px;
|
|
padding-bottom: 2px;
|
|
|
|
color: var(--accent);
|
|
text-decoration: none;
|
|
font-size: 0.95rem;
|
|
font-weight: 500;
|
|
|
|
border-bottom: 1px solid transparent;
|
|
|
|
transition:
|
|
border-color 0.15s ease,
|
|
color 0.15s ease;
|
|
}
|
|
|
|
.latest:hover {
|
|
border-color: var(--accent);
|
|
color: var(--accent-hover);
|
|
}
|
|
|
|
.list {
|
|
border-top: 1px solid var(--border);
|
|
}
|
|
|
|
.release {
|
|
display: flex;
|
|
align-items: center;
|
|
justify-content: space-between;
|
|
|
|
gap: 16px;
|
|
|
|
padding: 18px 0;
|
|
|
|
border-bottom: 1px solid var(--border);
|
|
}
|
|
|
|
.release-info {
|
|
display: flex;
|
|
align-items: center;
|
|
gap: 12px;
|
|
}
|
|
|
|
.version {
|
|
font-size: 0.96rem;
|
|
font-weight: 500;
|
|
letter-spacing: -0.01em;
|
|
}
|
|
|
|
.badge {
|
|
font-size: 0.72rem;
|
|
font-weight: 600;
|
|
|
|
color: var(--muted);
|
|
|
|
border: 1px solid var(--border);
|
|
padding: 2px 8px;
|
|
}
|
|
|
|
.release a {
|
|
color: var(--accent);
|
|
text-decoration: none;
|
|
font-size: 0.92rem;
|
|
}
|
|
|
|
.release a:hover {
|
|
text-decoration: underline;
|
|
}
|
|
|
|
.empty {
|
|
padding: 32px 0;
|
|
|
|
color: var(--muted);
|
|
font-size: 0.95rem;
|
|
}
|
|
|
|
@media (max-width: 640px) {
|
|
body {
|
|
padding: 40px 20px;
|
|
}
|
|
|
|
.header h1 {
|
|
font-size: 1.7rem;
|
|
}
|
|
|
|
.release {
|
|
flex-direction: column;
|
|
align-items: flex-start;
|
|
}
|
|
}
|
|
</style>
|
|
</head>
|
|
|
|
<body>
|
|
<div class="container">
|
|
|
|
<header class="header">
|
|
<h1>Flash JavaDoc</h1>
|
|
|
|
<p>
|
|
API documentation for all published Flash releases.
|
|
</p>
|
|
|
|
""" + (
|
|
f'''
|
|
<a class="latest" href="latest/index.html">
|
|
Latest release — {latest}
|
|
</a>
|
|
'''
|
|
if latest else ""
|
|
) + """
|
|
</header>
|
|
|
|
""" + (
|
|
f'''
|
|
<div class="list">
|
|
{rows}
|
|
</div>
|
|
'''
|
|
if rows else
|
|
'''
|
|
<div class="empty">
|
|
No versions published yet.
|
|
</div>
|
|
'''
|
|
) + """
|
|
|
|
</div>
|
|
</body>
|
|
</html>"""
|
|
|
|
with open("index.html", "w", encoding="utf-8") as f:
|
|
f.write(html)
|
|
|
|
print(f"index.html generated — {len(versions)} version(s): {versions}")
|
|
EOF
|
|
|
|
- name: Push gh-pages
|
|
run: |
|
|
cd gh-pages-out
|
|
git config user.name "github-actions[bot]"
|
|
git config user.email "github-actions[bot]@users.noreply.github.com"
|
|
git add -A
|
|
git diff --cached --quiet || git commit -m "docs(javadoc): publish ${{ inputs.version }}"
|
|
git push origin gh-pages
|