1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/.github/workflows/docs-pr.yml
Felix Fontein e718bd8445
Lookups: use Ansible's config manager whenever possible (#5440)
* Start using Ansible's config manager to handle options.

* Docs improvements.

* Fix documentation, make options actual lookup options.

* The cyberarkpassword lookup does too strange things.

* The onepassword lookups are converted in #4728, let's not interfere.

* Improve docs.

* Skip shelvefile as well.

* Convert lmdb_kv.

* Convert and fix credstash.

* Convert manifold.

* Drop chef_databag.

* Convert dig.

* Update examples.

* Forgot the most important part.

* Fix lmdb_kv docs.

* Python 2.6 compatibility.

* Convert AnsibleUnicode to str.

* Load lookup with lookup loader.

* Fix environment handling and error message checking.

* Improve docs formatting.
2022-11-01 21:58:46 +01:00

93 lines
3.9 KiB
YAML

---
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
name: Collection Docs
concurrency:
group: docs-${{ github.head_ref }}
cancel-in-progress: true
on:
pull_request_target:
types: [opened, synchronize, reopened, closed]
paths-ignore:
- '.azure-pipelines/**'
- 'changelogs/**'
- 'meta/**'
- 'tests/**'
jobs:
build-docs:
permissions:
contents: read
name: Build Ansible Docs
uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main
with:
init-fail-on-error: true
provide-link-targets: |
ansible_collections.ansible.builtin.dict2items_filter
ansible_collections.ansible.builtin.items_lookup
ansible_collections.ansible.builtin.path_join_filter
ansible_collections.community.kubevirt.kubevirt_cdi_upload_module
ansible_collections.community.kubevirt.kubevirt_inventory
ansible_collections.community.kubevirt.kubevirt_preset_module
ansible_collections.community.kubevirt.kubevirt_pvc_module
ansible_collections.community.kubevirt.kubevirt_rs_module
ansible_collections.community.kubevirt.kubevirt_template_module
ansible_collections.community.kubevirt.kubevirt_vm_module
ansible_collections.infoblox.nios_modules.nios_a_record_module
ansible_collections.infoblox.nios_modules.nios_aaaa_record_module
ansible_collections.infoblox.nios_modules.nios_cname_record_module
ansible_collections.infoblox.nios_modules.nios_dns_view_module
ansible_collections.infoblox.nios_modules.nios_fixed_address_module
ansible_collections.infoblox.nios_modules.nios_host_record_module
ansible_collections.infoblox.nios_modules.nios_lookup_lookup
ansible_collections.infoblox.nios_modules.nios_member_module
ansible_collections.infoblox.nios_modules.nios_mx_record_module
ansible_collections.infoblox.nios_modules.nios_naptr_record_module
ansible_collections.infoblox.nios_modules.nios_network_module
ansible_collections.infoblox.nios_modules.nios_network_view_module
ansible_collections.infoblox.nios_modules.nios_next_ip_lookup
ansible_collections.infoblox.nios_modules.nios_next_network_lookup
ansible_collections.infoblox.nios_modules.nios_nsgroup_module
ansible_collections.infoblox.nios_modules.nios_ptr_record_module
ansible_collections.infoblox.nios_modules.nios_srv_record_module
ansible_collections.infoblox.nios_modules.nios_txt_record_module
ansible_collections.infoblox.nios_modules.nios_zone_module
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-body: |
## Docs Build 📝
This PR is closed and any previously published docsite has been unpublished.
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 }}
File changes:
${{ needs.build-docs.outputs.diff-files-rendered }}
${{ needs.build-docs.outputs.diff-rendered }}