docs: add inputs table to README.md #144
Open
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 PR documents all inputs (and outputs that might appear in the future) automatically in the
README.md
using the action-docs npm package. This is helpful for users that want to read the reference of the inputs in case it's not covered by the examples.I added an npm script to run it as
npm run docs
locally. It is possible to add it in a GitHub workflow, but I first need to figure out this repository's workflow permissions, which will make the PR longer. So, that could be done in the future.Another unrelated fix to a test. There was a bug in the test.yml workflow.
I fixed that by copying what the upstream grcov project does in https://github.com/mozilla/grcov/blob/743a0b9730702dae42e7198b5e2ff312d9773fae/.github/workflows/release.yml#L74