Generate documentation from actions.yml

[stschulte]

Description:
Right now inputs and outputs of an action are documented in actions.yml but this is not the first place a user
looks at. To have valid documentation inside README.md a section inside the README seems to be manually
maintained and kept in sync with the actions.yml file.

Since I was facing a similar issue I assume you are facing here, I developed github-actions-docs and I am wondering wether this would be helpful for you as well.

This PR now introduces github-actions-docs to automatically generate documentation of inputs and outputs.

It can be used to update documentation when running

npm run pre-checkin

NOTE: This commit seems to introduce change to the dist/ directory after running npm run pre-checkin. I am not exactly sure why this is, I assume this is partially due to a bump in tslib but I also see CRLF->LF changes which also happen for me on a clear git checkout. Let me know if you want to dig deeper into this.

Related issue:
Add link to the related issue.

Check list:

• Mark if documentation changes are required.
• Mark if tests were added or updated to cover the changes.

[stschulte]

Version 1.1.0 of github-actions-docs drops the dependency on tslib. Using this to generate documentation instead of 1.0.0 (which is in this PR) no longer cause changes dist since we would not bump tslib. I am happy to rebase as long as noone is actively rereviewing this right now.

[gowridurgad]

Hi @stschulte, thank you for your contribution!

While we are currently maintaining the README inputs/outputs section manually and are not planning to adopt automated tooling at this time, we’ll continue to monitor this area for potential improvements.

Please don’t hesitate to reach out if you have any questions or need further assistance, and we welcome any ideas or suggestions for future enhancements.

[stschulte]

@gowridurgad fair enough, I also understand an action as widespread as this wants to be particulary careful into introducing additional dependencies (even if this is only a build time dependency). Feel free to close the PR then.