首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >如何在网页上自动生成JavaDoc

如何在网页上自动生成JavaDoc
EN

Stack Overflow用户
提问于 2022-06-09 19:16:53
回答 2查看 242关注 0票数 4

我目前正在GitHub中开发一个Java项目,我需要对每个更新进行手动生成JavaDoc并将其上传到GitHub页面。但这很乏味。

我想知道是否可以用CI自动实现这一点?

EN

Stack Overflow用户

回答已采纳

发布于 2022-06-09 20:29:11

自动生成带有JavaDoc页面的网页

是的,在您的GitHub操作中使用以下代码是可能的:

代码语言:javascript
运行
复制
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 

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

当您将代码发布到“主”分支时,此代码会自动发布JavaDoc,您的JavaDoc会被推到javadoc分支上,并与GitHub页面一起部署。

不要忘记在您的GitHub回购设置中启用GitHub页面

在GitHub存储库中创建一个GitHub操作

要创建一个GitHub操作,只需将这个yaml文件添加到您的/.github/workflows/<your-file>.yaml存储库中。

票数 10
EN
查看全部 2 条回答
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/72565540

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档