Debian Codegraph @

ansible_collections/vmware/vmware_rest/.github/workflows/docs-pr.yml

raw
1 ---
2 name: Collection Docs
3 concurrency:
4 group: docs-${{ github.head_ref }}
5 cancel-in-progress: true
6 on:
7 pull_request:
8 types: [opened, synchronize, reopened, closed]
9
10 env:
11 GHP_BASE_URL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}
12
13 jobs:
14 validate-docs:
15 permissions:
16 contents: read
17 name: Validate Ansible Docs
18 uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main
19 with:
20 extra-collections: vmware.vmware
21 init-lenient: false
22 init-fail-on-error: true
23 artifact-name: ${{ github.event.repository.name }}_docs_${{ github.event.pull_request.head.sha }}_validate
24 intersphinx-links: |
25 ansible_devel:https://docs.ansible.com/ansible-core/devel/
26 provide-link-targets: |
27 ansible_collections.vmware.vmware.appliance_info_module
28 ansible_collections.vmware.vmware.cluster_info_module
29 ansible_collections.vmware.vmware.content_library_item_info_module
30 ansible_collections.vmware.vmware.esxi_host_module
31 ansible_collections.vmware.vmware.local_content_library_module
32 ansible_collections.vmware.vmware.moid_from_path_module
33 ansible_collections.vmware.vmware.subscribed_content_library_module
34 ansible_collections.vmware.vmware.vcsa_settings_module
35 ansible_collections.vmware.vmware.vm_apply_customization_module
36 ansible_collections.vmware.vmware.vm_module
37 ansible_collections.vmware.vmware.vm_portgroup_info_module
38 ansible_collections.vmware.vmware.vm_powerstate_module
39 ansible_collections.vmware.vmware.vm_resource_info_module
40
41 build-docs:
42 permissions:
43 contents: read
44 name: Build Ansible Docs
45 uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main
46 with:
47 extra-collections: vmware.vmware
48 artifact-name: ${{ github.event.repository.name }}_docs_${{ github.event.pull_request.head.sha }}_build
49 init-lenient: true
50 init-fail-on-error: false
51 intersphinx-links: |
52 ansible_devel:https://docs.ansible.com/ansible-core/devel/
53
54 # This job requires that the workflow trigger is pull_request_target. However that trigger uses
55 # whatever version of the workflow is available on main instead of the feature branch.
56 #
57 # comment:
58 # permissions:
59 # pull-requests: write
60 # runs-on: ubuntu-latest
61 # needs: [build-docs]
62 # name: PR comments
63 # steps:
64 # - name: PR comment
65 # uses: ansible-community/github-docs-build/actions/ansible-docs-build-comment@main
66 # with:
67 # body-includes: "## Docs Build"
68 # reactions: heart
69 # action: ${{ needs.build-docs.outputs.changed != 'true' && 'remove' || '' }}
70 # on-closed-action: remove
71 # on-merged-body: |
72 # ## Docs Build 📝
73
74 # Thank you for contribution!✨
75
76 # This PR has been merged and your docs changes will be incorporated when they are next published.
77 # body: |
78 # ## Docs Build 📝
79
80 # Thank you for contribution!✨
81
82 # The docsite for **this PR** is available for download as an artifact from this run:
83 # ${{ needs.build-docs.outputs.artifact-url }}
84
85 # You can compare to the docs for the `main` branch here:
86 # ${{ env.GHP_BASE_URL }}/branch/main
87
88 # File changes:
89
90 # ${{ needs.build-docs.outputs.diff-files-rendered }}
91
92 # ${{ needs.build-docs.outputs.diff-rendered }}