自动发布 JavaDoc：使用 GitHub Actions

Question

介绍

我目前正在 GitHub 上开发 Java Maven 项目，并且正在构建 JavaDoc 并将其发布到 GitHub 页面。

问题

我想知道是否可以使用 GitHub Actions 来自动执行此操作，如果可以的话如何实现？

Answer 1

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.0
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          javadoc-branch: javadoc
          java-version: 17
          target-folder: javadoc 

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

将上述 YAML 文件添加到/.github/workflows/your-file.yamlGitHub 存储库中。当您发布到“master”或“main”分支时，它会自动发布 JavaDoc 。您的 JavaDoc 被推送到javadoc分支，并与 GitHub Pages 一起部署。

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