name: Publish Reports to GitHub Pages
on:
push:
branches:
- main
paths:
- 'src/main/**'
- 'src/test/**'
- 'src/jmh/**'
- 'build.gradle'
- 'settings.gradle'
- 'gradle/**'
- 'dependency-suppression.xml'
- 'gradlew'
- 'gradlew.bat'
- '.github/workflows/pages.yml'
workflow_dispatch:
permissions:
contents: write
concurrency:
group: pages-${{ github.ref }}
cancel-in-progress: true
jobs:
publish-pages:
name: Publish static reports
runs-on: ubuntu-latest
steps:
- name: Check out source repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Validate Gradle wrapper
uses: gradle/actions/wrapper-validation@v4
- name: Set up Temurin JDK 21
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: '21'
- name: Set up Gradle caching and instrumentation
uses: gradle/actions/setup-gradle@v4
- name: Build reports for publication
run: ./gradlew --no-daemon clean build pmdMain javadoc jacocoTestReport pitest jmh cyclonedxBom
- name: Prepare gh-pages worktree
shell: bash
run: |
set -euo pipefail
if git ls-remote --exit-code --heads origin gh-pages > /dev/null 2>&1; then
git fetch origin gh-pages:gh-pages
git worktree add .gh-pages gh-pages
else
git worktree add --detach .gh-pages
cd .gh-pages
git checkout --orphan gh-pages
git rm -rf . > /dev/null 2>&1 || true
cd ..
fi
- name: Stage published reports
shell: bash
run: |
set -euo pipefail
SITE_DIR=".gh-pages"
RUN_DIR="${SITE_DIR}/builds/${GITHUB_RUN_NUMBER}"
LATEST_DIR="${SITE_DIR}/builds/latest"
mkdir -p "${RUN_DIR}"
rm -rf "${LATEST_DIR}"
mkdir -p "${LATEST_DIR}"
cp -R build/docs/javadoc "${RUN_DIR}/javadoc"
cp -R build/docs/javadoc "${LATEST_DIR}/javadoc"
cp -R build/reports/tests/test "${RUN_DIR}/test"
cp -R build/reports/tests/test "${LATEST_DIR}/test"
cp -R build/reports/pmd "${RUN_DIR}/pmd"
cp -R build/reports/pmd "${LATEST_DIR}/pmd"
cp -R build/reports/jacoco/test/html "${RUN_DIR}/coverage"
cp -R build/reports/jacoco/test/html "${LATEST_DIR}/coverage"
cp -R build/reports/pitest "${RUN_DIR}/pitest"
cp -R build/reports/pitest "${LATEST_DIR}/pitest"
JMH_TXT_LINK=''
JMH_CSV_LINK=''
JMH_TXT_LATEST_LINK=''
JMH_CSV_LATEST_LINK=''
DEPENDENCY_CHECK_LINK=''
DEPENDENCY_CHECK_LATEST_LINK=''
SBOM_JSON_LINK=''
SBOM_XML_LINK=''
SBOM_JSON_LATEST_LINK=''
SBOM_XML_LATEST_LINK=''
if [ -d "build/reports/jmh" ]; then
cp -R build/reports/jmh "${RUN_DIR}/jmh"
cp -R build/reports/jmh "${LATEST_DIR}/jmh"
if [ -f "${RUN_DIR}/jmh/jmh-results.txt" ]; then
JMH_TXT_LINK='
Benchmark Results (TXT)'
JMH_TXT_LATEST_LINK='Benchmark Results (TXT)'
fi
if [ -f "${RUN_DIR}/jmh/jmh-results.csv" ]; then
JMH_CSV_LINK='Benchmark Results (CSV)'
JMH_CSV_LATEST_LINK='Benchmark Results (CSV)'
fi
HAS_JMH="true"
else
HAS_JMH="false"
fi
if [ -d "build/reports/dependency-check" ]; then
cp -R build/reports/dependency-check "${RUN_DIR}/dependency-check"
cp -R build/reports/dependency-check "${LATEST_DIR}/dependency-check"
if [ -f "${RUN_DIR}/dependency-check/dependency-check-report.html" ]; then
DEPENDENCY_CHECK_LINK='Dependency Vulnerability Report'
DEPENDENCY_CHECK_LATEST_LINK='Dependency Vulnerability Report'
fi
fi
if [ -d "build/reports/sbom" ]; then
cp -R build/reports/sbom "${RUN_DIR}/sbom"
cp -R build/reports/sbom "${LATEST_DIR}/sbom"
SBOM_JSON_LINK='SBOM (JSON)'
SBOM_XML_LINK='SBOM (XML)'
SBOM_JSON_LATEST_LINK='SBOM (JSON)'
SBOM_XML_LATEST_LINK='SBOM (XML)'
fi
cat > "${RUN_DIR}/index.html" <
Radixor Reports - Build ${GITHUB_RUN_NUMBER}
Radixor Reports
Build ${GITHUB_RUN_NUMBER} from commit ${GITHUB_SHA}
- Javadoc
- Test Report
- PMD Report
- Coverage Report
${DEPENDENCY_CHECK_LINK:-- Dependency Vulnerability Report: not available
}
${SBOM_JSON_LINK:-- SBOM (JSON): not available
}
${SBOM_XML_LINK:-- SBOM (XML): not available
}
- Mutation Testing Report
$(
[ "${HAS_JMH}" = "true" ] && { echo "${JMH_TXT_LINK:-- Benchmark Results (TXT): not available
}"; echo "${JMH_CSV_LINK:-- Benchmark Results (CSV): not available
}"; } \
|| echo '- Benchmark results: not available in this build
'
)
Open latest report set
Back to report home
EOF
cp "${RUN_DIR}/index.html" "${LATEST_DIR}/index.html"
cat > "${SITE_DIR}/.nojekyll" <
Radixor Reports
Radixor Published Reports
Durable CI reports published from GitHub Actions to the gh-pages branch.
Latest
- Latest build summary
- Javadoc
- Test Report
- PMD Report
- Coverage Report
${DEPENDENCY_CHECK_LATEST_LINK:-- Dependency Vulnerability Report: not currently available
}
${SBOM_JSON_LATEST_LINK:-- SBOM (JSON): not available
}
${SBOM_XML_LATEST_LINK:-- SBOM (XML): not available
}
- Mutation Testing Report
$(
[ "${HAS_JMH}" = "true" ] && { echo "${JMH_TXT_LATEST_LINK:-- Benchmark Results (TXT): not available
}"; echo "${JMH_CSV_LATEST_LINK:-- Benchmark Results (CSV): not available
}"; } \
|| echo '- Benchmark results: not currently available
'
)
EOF
cat <
Recent historical builds
EOF
for build in ${BUILD_LIST}; do
echo " - Build ${build}
"
done
cat <
EOF
} > "${SITE_DIR}/index.html"
- name: Commit and push gh-pages
shell: bash
run: |
set -euo pipefail
cd .gh-pages
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git add .
if git diff --cached --quiet; then
echo "No changes to publish."
exit 0
fi
git commit -m "Publish reports for run ${GITHUB_RUN_NUMBER}"
git push origin gh-pages