search

ansible-community / github-docs-build

GitHub actions and workflows for building Ansible collection documentation.
GNU General Public License v3.0
10 stars 6 forks source link

[experimental] generate wiki docs from action/workflow YAML #21

Closed briantist closed 2 years ago

briantist commented 2 years ago

This is some messing around I did to try to generate markdown from the action and shared workflow YAML files.

I did in Ansible, as an "internal" collection with a role and playbook.

I figured, as a bonus, we could use this internal collection for some of the tests in terms of actually generating documentation (the role has an argspec 😎).

This also has a workflow that would run the Ansible, and synchronize the changes to those files to the repo's wiki.

The worklow is set to run on push (was going to add workflow_dispatch but for now leaving it out, because the commit info is not available in the event, would have to retrieve it separately).

~pull_request trigger is added just for this PR, so I can test it a little; that must be removed before merging.~

Testing stuff has been removed, this is ready to review/merge.

Generated pages can be seen in the wiki now, for example.

felixfontein commented 2 years ago

@briantist thanks again for doing this!