我目前正在 GitHub 上开发一个 Java 项目,每次更新时我都需要手动生成 JavaDoc 并将其上传到 GitHub 页面。但这非常乏味。
我想知道是否可以通过 CI 实现自动化?
使用 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] /cdn-cgi/l/email-protection
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
javadoc-branch: javadoc
java-version: 17
target-folder: javadoc
project: maven # or gradle
Credit: https://github.com/MathieuSoysal/Javadoc-publisher.yml https://github.com/MathieuSoysal/Javadoc-publisher.yml
https://github.com/marketplace/actions/deploy-javadoc https://github.com/marketplace/actions/deploy-javadoc
当您将代码发布到时,此代码会自动发布 JavaDoc"master"分支,您的 JavaDoc 已推送javadoc分支,并与 GitHub Page 一起部署。
不要忘记在 GitHub 存储库设置中启用 GitHub 页面
在 GitHub 存储库中创建 GitHub Actions
要创建 GitHub Actions,您只需添加此 yaml 文件即可/.github/workflows/<your-file>.yaml
在您的 GitHub 存储库中。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)