Skip to content

fix(CI): disable doc publication #5

fix(CI): disable doc publication

fix(CI): disable doc publication #5

Workflow file for this run

name: Compile and publish documentation
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
jobs:
compile-doc:
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@v4
- name: Set up JDK 21
uses: actions/setup-java@v4
with:
java-version: '21'
distribution: 'temurin'
architecture: 'x64'
# Configure Gradle for optimal use in GitHub Actions, including caching of downloaded dependencies.
# See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md
- name: Setup Gradle
uses: gradle/actions/setup-gradle@v4
- name: Compile documentation
run: ./gradlew asciidoc -Pmaven_settings_location='undefined'
- name: Upload documentation
uses: actions/upload-artifact@v4
with:
name: project-documentation
path: build/docs/asciidoc
publish-doc:
needs: compile-doc
# Only publish documentation from main branch
# if: github.ref == 'refs/heads/main'
# TODO: find out why it fails, or remove it completely
if: false
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
with:
artifact_name: 'project-documentation'