[experimental] generate wiki docs from action/workflow YAML #21
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
Collaborator
|
@briantist thanks again for doing this! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 addworkflow_dispatchbut for now leaving it out, because the commit info is not available in the event, would have to retrieve it separately).pull_requesttrigger 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.