feat: Allow creating of usage guide #401
Merged
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.
I have been looking for ways to automate producing documentation for GitHub actions and this is an awesome tool to learn about; thanks for building it!
One of my favorite ways to document reusable actions is to create "usage" section which is a chunk of YAML similar to this: https://github.com/actions/checkout#usage
I think this style of guide is visually appealing, but more importantly I also think it helps users who are new to GitHub actions by providing unambiguous syntax for how your action should be used. I have added an optional comment block
action-docs-usage
which, when provided, will add a usage guide. I used this in my sample project here: https://github.com/ethanrucinski/test-usage-guideAs an aside, I also added the
__tests__
directory to the.eslintignore
as it is not covered by the.tsconfig.json
.I hope you will consider my pull request and give me any feedback you have on my code!