Skip to content

Merge pull request #41537 from geoand/rest-assured-test-common #123

Merge pull request #41537 from geoand/rest-assured-test-common

Merge pull request #41537 from geoand/rest-assured-test-common #123

Workflow file for this run

name: Quarkus Documentation CI
on:
push:
branches-ignore:
- 'dependabot/**'
- 'jakarta-rewrite'
- '3.0'
paths:
- 'docs/src/main/asciidoc/**'
- '.github/workflows/doc-build.yml'
pull_request:
types: [opened, synchronize, reopened]
paths:
- 'docs/src/main/asciidoc/**'
- '.github/workflows/doc-build.yml'
concurrency:
group: "workflow = ${{ github.workflow }}, ref = ${{ github.event.ref }}, pr = ${{ github.event.pull_request.id }}"
cancel-in-progress: ${{ github.event_name == 'pull_request' || github.repository != 'quarkusio/quarkus' }}
jobs:
ci-sanity-check:
name: "CI Sanity Check"
runs-on: ubuntu-latest
steps:
- name: Build
run: sleep 30
build-doc:
name: "Documentation Build"
timeout-minutes: 60
runs-on: ubuntu-latest
# Skip main in forks
if: "github.repository == 'quarkusio/quarkus' || !endsWith(github.ref, '/main')"
steps:
- uses: actions/checkout@v4
- name: Set up JDK 17
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: 17
- name: Get Date
id: get-date
run: |
echo "date=$(/bin/date -u "+%Y-%m")" >> $GITHUB_OUTPUT
- name: Cache Maven Repository
id: cache-maven
uses: actions/cache@v4
with:
path: ~/.m2/repository
# refresh cache every month to avoid unlimited growth
key: q2maven-doc-${{ steps.get-date.outputs.date }}
- name: Build
run: |
./mvnw -DquicklyDocs -B --settings .github/mvn-settings.xml
- name: Build Docs
run: |
if ./mvnw -e -B --settings .github/mvn-settings.xml clean package -pl docs -Dasciidoctor.fail-if=DEBUG ; then
echo "Build ok"
else
if [ -f docs/target/metadataErrors.md ]; then
echo "### Document Metadata Errors" >> $GITHUB_STEP_SUMMARY
cat docs/target/metadataErrors.md >> $GITHUB_STEP_SUMMARY
fi
exit 1
fi
- name: Store PR id
run: echo ${{ github.event.number }} > pr-id.txt
- name: Persist documentation
uses: actions/upload-artifact@v4
with:
name: documentation
path: |
pr-id.txt
docs/
target/asciidoc/generated/config/
retention-days: 1