Generate documentation from actions.yml #1239
Open
+158
−90
Conversation
This file contains 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
Right now the documentation of valid inputs (and outputs) seems to be manually maintained inside the `README.md` with a reference to the `actions.yml` file. Since this can be rather tedious to maintain this commit now uses [github-actions-docs][1] to automatically generate documentation. [1]: https://www.npmjs.com/package/github-action-docs
|
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 |
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.
Description:
Right now inputs and outputs of an action are documented in
actions.ymlbut this is not the first place a userlooks at. To have valid documentation inside
README.mda section inside the README seems to be manuallymaintained and kept in sync with the
actions.ymlfile.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
NOTE: This commit seems to introduce change to the
dist/directory after runningnpm run pre-checkin. I am not exactly sure why this is, I assume this is partially due to a bump intslibbut 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: