我目前正在 GitHub 上開發一個 Java 專案,我需要在每次更新時手動生成 JavaDoc 并將其上傳到 GitHub Page。但這非常乏味。
我想知道是否可以通過 CI 實作自動化?
uj5u.com熱心網友回復:
使用 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/[email protected]
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
當您將代碼發布到“master”分支時,此代碼會自動發布 JavaDoc,您的 JavaDoc 會被推送到javadoc分支,并與 GitHub Page 一起部署。
不要忘記在您的 GitHub 存盤庫設定中啟用 GitHub 頁面
在 GitHub 存盤庫中創建 GitHub Actions
要創建 GitHub 操作,您只需在/.github/workflows/<your-file>.yamlGitHub 存盤庫中添加此 yaml 檔案即可。
uj5u.com熱心網友回復:
對不起,我可能錯過了問題的重點……
但據我了解,CI 流程鏈通常通過存盤庫從提供給它的源檔案中自動生成人工制品。
行程鏈觸發各種程式來生成這些人工制品,如編譯器、聯結器和其他東西。
javadoc那么作為 CI 鏈的一部分呼叫該工具的問題在哪里呢?
Gradle 和 Maven 都有 JavaDoc 的插件,甚至 ant 也有啟動 JavaDoc 的命令。
即使對于替代的 Doxygen 工具,也確實存在將其集成到 Gradle 和 Maven 中的方法……
javadoc在最壞的情況下,從批處理檔案啟動該工具有多大的困難?
轉載請註明出處,本文鏈接:https://www.uj5u.com/qiye/490909.html
標籤:爪哇 github github-动作 github页面 文档
