You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Deploy - Publish Javadoc
v2.0.3
Automatically generate Javadoc from your maven project and deploy it with GitHub Page on javadoc branch.
- Your project need to use Maven
The workflow, usually declared in .github/workflows/javadoc-publish.yml
, looks like:
name: Deploy Javadoc
on:
push:
branches:
- master
jobs:
publish:
runs-on: ubuntu-latest
steps:
- name: Deploy JavaDoc 🚀
uses: MathieuSoysal/Javadoc-publisher.yml@v2.0.1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
javadoc-branch: javadoc
java-version: 17
Don't forget to configure your repository settings with your new GitHub Page. 😉
[![Javadoc](https://img.shields.io/badge/JavaDoc-Online-green)](https://YOUR-USERNAME.github.io/YOUR-REPO/javadoc/)
In the badge link, replace YOUR-USERNAME with your GitHub Username and replace YOUR-REPO with the name of your GitHub repository.
The Dockerfile and associated scripts and documentation in this project are released under the Apache 2.0 License.