ansible-doctor icon indicating copy to clipboard operation
ansible-doctor copied to clipboard

questions regarding parsing of requirements and dict variables

Open psych0d0g opened this issue 1 year ago • 9 comments

i would try to create a custom template to get requirement roles documented in the readme.md aswell, ansible galaxy works using a requirements.yml in the meta folder of a role with the following syntax:

- src: [email protected]:package-roles/package.git
  version: main
- src: [email protected]:package-roles/firewall.git
  version: main
- src: [email protected]:package-roles/php.git
  version: main

any idea how one could archive that?

another question revolves around dictionary variables, and how to properly get doctor to detect them and document them. currently its just this:

# @var apache2_listen_ports:type: dictionary
# @var apache2_listen_ports:description: >
# if the https port is omitted, the default vhost will only listen on http
# otherwise a redirect is included in the vhost that redirects http requests to https
# @end
apache2_listen_ports:
  http: 80
  https: 443

and doctor itself would also only detect the initial dict var, is there a way to have it split them out, and detect and document the keys in the dict as vars aswell?

psych0d0g avatar Oct 31 '23 14:10 psych0d0g