Trigger docs checks on python plugin files changes

[michburk]

Files in plugins/modules/**/*.py and plugins/module_utils/**/*.py are used to generate docs, so trigger docs checks on changes to these files.

Also adds entries to the dictionary to resolve some new 'spelling errors' because these files went unchecked in a previous pr.

[qodo-code-review]

PR Summary by Qodo

Run documentation checks when Python plugin sources change

⚙️ Configuration changes 📝 Documentation 🕐 Less than 10 minutes

AI Description

• Trigger documentation checks when module or module utility Python files change.
• Recognize three generated-documentation terms to prevent spelling check failures.

Diagram

graph TD
  M["Module sources"] --> G{"PR path match"} --> B["Build documentation"] --> S["Check spelling"]
  U["Utility sources"] --> G
  D["Custom dictionary"] --> S

Loading

High-Level Assessment

Extending the existing path filter is the simplest way to cover plugin sources without duplicating documentation jobs or changing the established build and spelling checks.

Files changed (2) +5 / -0

Documentation (1) +3 / -0

en-custom.txtAccept three terms in generated documentation +3/-0

Accept three terms in generated documentation

• Adds clusterimagepolicy, drosenfe, and rosenfeld to the custom spelling dictionary so the documentation check accepts them.

docs/dictionary/en-custom.txt

Other (1) +2 / -0

documentation.ymlTrigger documentation workflow for Python plugin changes +2/-0

Trigger documentation workflow for Python plugin changes

• Adds recursive Python-file path filters for modules and module utilities. Pull requests changing those sources now run the existing documentation build and spelling check.

.github/workflows/documentation.yml

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Tip of the day

💡 Did you know, you can show, collapse, or hide each part of a finding: code, evidence, and all

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

[centosinfra-prod-github-app]

Build succeeded (check pipeline).
https://gateway-cloud-softwarefactory.apps.ocp.cloud.ci.centos.org/zuul/t/rdoproject.org/buildset/52f21d268410463298112d4dc24bcbe1

✔️ noop SUCCESS in 0s
✔️ cifmw-pod-ansible-test SUCCESS in 8m 08s
✔️ cifmw-pod-pre-commit SUCCESS in 8m 20s

[centosinfra-prod-github-app]

Build succeeded (check pipeline).
https://gateway-cloud-softwarefactory.apps.ocp.cloud.ci.centos.org/zuul/t/rdoproject.org/buildset/471c5d8598a44a048a7c2d2739f0ca16

✔️ openstack-k8s-operators-content-provider SUCCESS in 4h 39m 31s
✔️ podified-multinode-edpm-deployment-crc SUCCESS in 1h 21m 12s
✔️ podified-multinode-edpm-deployment-crc-centos-10 SUCCESS in 1h 22m 47s
✔️ cifmw-crc-podified-edpm-baremetal SUCCESS in 1h 36m 39s
✔️ cifmw-crc-podified-edpm-baremetal-minor-update SUCCESS in 1h 55m 38s
✔️ openstack-k8s-operators-content-provider-bootc SUCCESS in 3h 50m 32s
✔️ cifmw-crc-podified-edpm-baremetal-bootc SUCCESS in 1h 31m 56s
✔️ noop SUCCESS in 0s
✔️ cifmw-pod-ansible-test SUCCESS in 8m 43s
✔️ cifmw-pod-pre-commit SUCCESS in 8m 40s

[evallesp]

lgtm

[evallesp]

/approve

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: evallesp

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [evallesp]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[Valkyrie00]

/lgtm