Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Allow creating of usage guide #401

Merged
merged 5 commits into from
Apr 7, 2023
Merged

feat: Allow creating of usage guide #401

merged 5 commits into from
Apr 7, 2023

Conversation

ethanrucinski
Copy link
Contributor

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-guide

As 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!

@npalm npalm self-requested a review April 7, 2023 15:02
@npalm
Copy link
Owner

npalm commented Apr 7, 2023

Cool idea, would be nicer if a more tailed usages example could be provided. But that could be a nice step for the future.

@ethanrucinski
Copy link
Contributor Author

Cool idea, would be nicer if a more tailed usages example could be provided. But that could be a nice step for the future.

Sure I can add more in the future if you like

@npalm npalm merged commit 92d68be into npalm:main Apr 7, 2023
This was referenced Feb 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants