docs-pr-checks.yml

name: "Verify Docs PR"

on:
  pull_request:
    branches:
    - "dev"
    - "5.x"
    - "4.[0-9]"
    - "3.5"

jobs:

  #  Generate HTML
  docs-build-pr:
    uses: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@dev
    with:
      deploy-id: ${{ github.event.number }}
      retain-artifacts: 14
      pageList: true

  # Parse the json log output from the HTML build, and output warnings and errors as annotations
  # Optionally, fail the build if there are warnings or errors
  # By default, the job fails if there are errors, passes if there are warnings only.
  docs-verify-pr:
    needs: docs-build-pr
    uses: neo4j/docs-tools/.github/workflows/reusable-docs-verify.yml@dev
    with:
      failOnWarnings: true

  # Get lists of changes in the PR
  # - all updated asciidoc files
  # - all updated asciidoc pages
  # - all new asciidoc pages
  docs-changes-pr:
    runs-on: ubuntu-latest
    outputs:
      asciidoc-files: ${{ steps.get-file-changes.outputs.asciidoc_all_changed_files }}
      pages-modified: ${{ steps.get-file-changes.outputs.pages_modified_files }}
      pages-added: ${{ steps.get-file-changes.outputs.pages_added_files }}
    steps:
      - name: Get file changes
        id: get-file-changes
        uses: tj-actions/changed-files@v41
        with:
          separator: ','
          files_yaml: |
            pages:
            - modules/**/pages/**/*.adoc
            asciidoc:
            - modules/**/*.adoc

  # Generate a PR comment if the docs are using the pageList extension
  # The extension maps asciidoc source files to their HTML output paths
  # The comment will contain links to new and changed pages in the deployed HTML docs
  docs-updates-comment-pr:
    if: needs.docs-build-pr.outputs.pages-listed == 'success'
    needs: [docs-build-pr, docs-changes-pr]
    uses: neo4j/docs-tools/.github/workflows/reusable-docs-pr-changes.yml@dev
    with:
      pages-modified: ${{ needs.docs-changes-pr.outputs.pages-modified }}
      pages-added: ${{ needs.docs-changes-pr.outputs.pages-added }}

  # Use vale to verify the changes against the style guide
  # You can specify your own vale config file if you want to override or replace the default Neo4j rules
  # docs-lint-pr:
  #   needs: docs-changes-pr
  #   if: needs.docs-changes-pr.outputs.asciidoc-files != ''
  #   uses: neo4j/docs-tools/.github/workflows/reusable-docs-vale.yml@dev
  #   with:
  #     files: ${{ needs.docs-changes-pr.outputs.asciidoc-files }}
  #     vale-fail-on-error: true
  #     # use-default-rules: false
  #     # vale-config-file: .vale.ini
  #     separator: ','