如何在网页上自动生成JavaDoc

Question

我目前正在 GitHub 上开发一个 Java 项目，每次更新时我都需要手动生成 JavaDoc 并将其上传到 GitHub 页面。但它\xe2\x80\x99s非常乏味。

\n

我想知道是否可以通过 CI 实现自动化？

\n

Answer 1

使用 GitHub Page 自动生成 JavaDoc 到网页

是的，可以使用 GitHub Actions 上的以下代码：

name: Deploy Javadoc

on:
  push:
    branches:
      - master
      - main

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - name: Deploy JavaDoc 
        uses: MathieuSoysal/Javadoc-publisher.yml@v2.3.2
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          javadoc-branch: javadoc
          java-version: 17
          target-folder: javadoc
          project: maven # or gradle 

信用： https: //github.com/MathieuSoysal/Javadoc-publisher.yml https://github.com/marketplace/actions/deploy-javadoc

当您将代码发布到“master”分支时，此代码会自动发布 JavaDoc，您的 JavaDoc 会推送到javadoc分支，并与 GitHub Page 一起部署。

不要忘记在 GitHub 存储库设置中启用 GitHub 页面

在 GitHub 存储库中创建 GitHub Actions

要创建 GitHub Actions，您只需将此 yaml 文件添加到/.github/workflows/<your-file>.yamlGitHub 存储库中即可。