如何为Gradle项目通过GitHub Actions生成并发布JavaDoc至网页

我需要从GitHub仓库生成JavaDoc并发布至GitHub Pages，之前找到一个仅适用于Maven项目的GitHub Actions方案，现在想把它适配成Gradle项目可用的版本。原Maven方案的配置如下：

原Maven项目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.0.4
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          javadoc-branch: javadoc
          java-version: 17
          target-folder: javadoc 

适配Gradle项目的GitHub Actions配置 #

直接自定义GitHub Actions步骤就能替代原Maven专用的Action，实现Gradle项目的JavaDoc生成与发布。以下是完整的配置示例：

name: Deploy Javadoc to GitHub Pages

on:
  push:
    branches:
      - master
      - main

jobs:
  publish-javadoc:
    runs-on: ubuntu-latest
    steps:
      # 拉取仓库代码
      - name: Checkout code
        uses: actions/checkout@v4

      # 设置指定版本的JDK
      - name: Set up JDK 17
        uses: actions/setup-java@v4
        with:
          java-version: '17'
          distribution: 'temurin'

      # 用Gradle生成JavaDoc文件
      - name: Generate Javadoc with Gradle
        run: ./gradlew javadoc

      # 把生成的JavaDoc部署到GitHub Pages
      - name: Deploy Javadoc to GitHub Pages
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          # Gradle默认的JavaDoc输出目录是build/docs/javadoc，按需修改
          publish_dir: ./build/docs/javadoc
          # 可选：如果不想用默认的gh-pages分支，可指定其他分支比如javadoc
          # publish_branch: javadoc

关键说明 #

• Gradle生成JavaDoc的默认命令是./gradlew javadoc，如果你的项目自定义了JavaDoc任务或者输出路径，要对应修改命令和publish_dir的路径。
• 用peaceiris/actions-gh-pages这个通用Action可以轻松把任意目录的内容发布到GitHub Pages对应的分支，默认是gh-pages，也可以指定其他分支。
• 默认的GITHUB_TOKEN已经拥有推送代码到仓库分支的权限，无需额外配置密钥。

内容的提问来源于stack exchange，提问作者Ruby