Skip to content

Commit

Permalink
Add Workflow to check the docs in PR
Browse files Browse the repository at this point in the history
  • Loading branch information
leonard84 committed Mar 17, 2024
1 parent 66e55b2 commit 5a75a5e
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/docs-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: 'Verify Docs'

on:
push:
branches-ignore:
- master
- gh-pages
pull_request:
merge_group:

# https://stackoverflow.com/a/72408109/16358266
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true


jobs:
docs-and-javadoc:
runs-on: 'ubuntu-latest'
steps:
- uses: actions/checkout@v4
with:
# Codecov needs fetch-depth > 1
fetch-depth: 2
- name: 'Set up JDKs'
uses: ./.github/actions/setup-build-env
with:
additional-java-version: 21
- name: 'Build Docs'
run: ./gradlew --no-parallel --stacktrace asciidoctor javadoc "-Dvariant=4.0" "-DjavaVersion=21"
- name: 'Archive and upload docs'
uses: actions/upload-artifact@v3
with:
name: docs
path: |
build/docs/**
build/javadoc/**

0 comments on commit 5a75a5e

Please sign in to comment.