Skip to content

Commit

Permalink
ci(javadoc): 添加Javadoc自动部署到gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
CarmJos committed May 28, 2022
1 parent b629a7d commit 4b59426
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 1 deletion.
9 changes: 9 additions & 0 deletions .documentation/javadoc/JAVADOC-README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# MineConfiguration Javadoc

基于 [Github Pages](https://pages.github.com/) 搭建,请访问 [JavaDoc](https://carmjos.github.io/MineConfiguration)

## 如何实现?

若您也想通过 [Github Actions](https://docs.github.com/en/actions/learn-github-actions)
自动部署项目的Javadoc到 [Github Pages](https://pages.github.com/)
可以参考我的文章 [《自动部署Javadoc到Github Pages》](https://pages.carm.cc/doc/javadoc-in-github.html)
64 changes: 63 additions & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,66 @@ jobs:
env:
MAVEN_USERNAME: ${{ secrets.OSSRH_USER }}
MAVEN_PASSWORD: ${{ secrets.OSSRH_PASS }}
MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}

javadoc-deploy:
name: "Deploy Javadoc (Github Pages)"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: "Set up JDK"
uses: actions/setup-java@v2
with:
java-version: '8'
distribution: 'adopt'
cache: maven

- name: "Generate Javadoc"
run: mvn -B javadoc:aggregate --file pom.xml -DskipTests

- name: "Copy Javadoc"
run: |
rm -rf docs
mkdir -vp docs
cp -vrf target/site/apidocs/* docs/
cp -vrf .documentation/javadoc/JAVADOC-README.md docs/README.md
- name: "Generate Sitemap"
id: sitemap
uses: cicirello/generate-sitemap@v1
with:
base-url-path: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}
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 }}"
ls -l docs
- name: Configure Git
env:
DEPLOY_PRI: ${{secrets.DEPLOY_PRI}}
run: |
sudo timedatectl set-timezone "Asia/Shanghai"
mkdir -p ~/.ssh/
echo "$DEPLOY_PRI" > ~/.ssh/id_rsa
chmod 600 ~/.ssh/id_rsa
ssh-keyscan github.com >> ~/.ssh/known_hosts
git config --global user.name '${{ github.repository_owner }}'
git config --global user.email '${{ github.repository_owner }}@users.noreply.github.com'
- name: Commit documentation changes
run: |
cd docs
git init
git remote add origin ${{ github.repositoryUrl }}
git checkout -b gh-pages
git add -A
git commit -m "API Document generated."
- name: Javadoc Website Push
run: |
cd docs
git push origin HEAD:gh-pages --force

0 comments on commit 4b59426

Please sign in to comment.