--- name: Collection Docs concurrency: group: docs-${{ github.head_ref }} cancel-in-progress: true on: pull_request: types: [opened, synchronize, reopened, closed] env: GHP_BASE_URL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }} jobs: validate-docs: permissions: contents: read name: Validate Ansible Docs uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main with: extra-collections: vmware.vmware init-lenient: false init-fail-on-error: true artifact-name: ${{ github.event.repository.name }}_docs_${{ github.event.pull_request.head.sha }}_validate intersphinx-links: | ansible_devel:https://docs.ansible.com/ansible-core/devel/ provide-link-targets: | ansible_collections.vmware.vmware.appliance_info_module ansible_collections.vmware.vmware.cluster_info_module ansible_collections.vmware.vmware.content_library_item_info_module ansible_collections.vmware.vmware.esxi_host_module ansible_collections.vmware.vmware.local_content_library_module ansible_collections.vmware.vmware.moid_from_path_module ansible_collections.vmware.vmware.subscribed_content_library_module ansible_collections.vmware.vmware.vcsa_settings_module ansible_collections.vmware.vmware.vm_apply_customization_module ansible_collections.vmware.vmware.vm_module ansible_collections.vmware.vmware.vm_portgroup_info_module ansible_collections.vmware.vmware.vm_powerstate_module ansible_collections.vmware.vmware.vm_resource_info_module build-docs: permissions: contents: read name: Build Ansible Docs uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main with: extra-collections: vmware.vmware artifact-name: ${{ github.event.repository.name }}_docs_${{ github.event.pull_request.head.sha }}_build init-lenient: true init-fail-on-error: false intersphinx-links: | ansible_devel:https://docs.ansible.com/ansible-core/devel/ # This job requires that the workflow trigger is pull_request_target. However that trigger uses # whatever version of the workflow is available on main instead of the feature branch. # # comment: # permissions: # pull-requests: write # runs-on: ubuntu-latest # needs: [build-docs] # name: PR comments # steps: # - name: PR comment # uses: ansible-community/github-docs-build/actions/ansible-docs-build-comment@main # with: # body-includes: "## Docs Build" # reactions: heart # action: ${{ needs.build-docs.outputs.changed != 'true' && 'remove' || '' }} # on-closed-action: remove # on-merged-body: | # ## Docs Build 📝 # Thank you for contribution!✨ # This PR has been merged and your docs changes will be incorporated when they are next published. # body: | # ## Docs Build 📝 # Thank you for contribution!✨ # The docsite for **this PR** is available for download as an artifact from this run: # ${{ needs.build-docs.outputs.artifact-url }} # You can compare to the docs for the `main` branch here: # ${{ env.GHP_BASE_URL }}/branch/main # File changes: # ${{ needs.build-docs.outputs.diff-files-rendered }} # ${{ needs.build-docs.outputs.diff-rendered }}