mirror of
https://github.com/CarmJos/UserPrefix.git
synced 2024-09-20 04:25:46 +00:00
70 lines
2.0 KiB
YAML
70 lines
2.0 KiB
YAML
# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
|
|
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
|
|
|
|
name: Javadoc
|
|
|
|
on:
|
|
# 支持手动触发构建
|
|
workflow_dispatch:
|
|
release:
|
|
# 创建release的时候触发
|
|
types: [ published ]
|
|
|
|
jobs:
|
|
api-website:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout the repo
|
|
uses: actions/checkout@v2
|
|
|
|
- name: Set up the Java JDK
|
|
uses: actions/setup-java@v2
|
|
with:
|
|
java-version: '11'
|
|
distribution: 'adopt'
|
|
|
|
- name: Generate docs
|
|
run: mvn javadoc:javadoc
|
|
|
|
- name: Copy to Location
|
|
run: |
|
|
rm -rf docs
|
|
cp -vrf target/site/apidocs/. docs
|
|
|
|
- name: Tidy up
|
|
id: tidy
|
|
uses: cicirello/javadoc-cleanup@v1
|
|
with:
|
|
base-url-path: https://carmjos.github.io/userprefix
|
|
path-to-root: docs
|
|
|
|
- name: Log output
|
|
run: |
|
|
echo "modified-count = ${{ steps.tidy.outputs.modified-count }}"
|
|
|
|
- name: Generate the sitemap
|
|
id: sitemap
|
|
uses: cicirello/generate-sitemap@v1
|
|
with:
|
|
base-url-path: https://carmjos.github.io/userprefix
|
|
path-to-root: docs
|
|
|
|
- name: Output stats
|
|
run: |
|
|
echo "sitemap-path = ${{ steps.sitemap.outputs.sitemap-path }}"
|
|
echo "url-count = ${{ steps.sitemap.outputs.url-count }}"
|
|
echo "excluded-count = ${{ steps.sitemap.outputs.excluded-count }}"
|
|
|
|
- name: Commit documentation changes
|
|
run: |
|
|
cd docs
|
|
git config --global user.name '${{ github.repository_owner }}'
|
|
git config --global user.email '${{ github.repository_owner }}@users.noreply.github.com'
|
|
git init
|
|
git checkout -b gh-pages
|
|
git log --decorate -- oneline
|
|
git add -A
|
|
git commit -m "API Document generated."
|
|
|
|
|