Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a workflow to publish the JavaDocs to GitHub Pages. #15

Merged
merged 1 commit into from
Nov 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions .github/workflows/deploy-javadocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Deploy JavaDocs to GitHub Pages

on:
# Runs on pushes version tags
push:
tags:
- v*

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
inputs:
tag:
description: "The tag used to create the JavaDoc for"
required: true
type: string

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build the JavaDoc for the site
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Set up JDK ${{ matrix.java }}
uses: actions/setup-java@v4
with:
java-version: 11
cache: 'maven'
distribution: 'temurin'
- name: Checkout Tag if Defined
if: inputs.tag 1= ''
run: git checkout ${{ inputs.tag }}
- name: Generate JavaDoc
run: mvn -B -ntp clean -Pjboss-release javadoc:javadoc
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload the JavaDoc's
path: 'target/reports/apidocs/'

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4