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

Replace input table #39

Merged
merged 3 commits into from
Oct 31, 2024
Merged

Replace input table #39

merged 3 commits into from
Oct 31, 2024

Conversation

BD103
Copy link
Collaborator

@BD103 BD103 commented Oct 30, 2024

This closes #34.

This PR:

  • Replaces the inputs and outputs tables in the README.md to be a code block and a bulleted list, respectively.
    • I wasn't sure how to document outputs in code, so I used a bulleted list instead.
    • Note that cache-hit can be "true", "false", or "", depending on the scenario, so I modified our description to say it is a string instead of a boolean. Check out the docs for why this is.
  • Improved the descriptions of all inputs and outputs to be consistent, and synchronized them across action.yml and README.md.
    • I removed explicit writing that said "Defaults to value", as the default is always documented nearby. Tell me what you think!
  • Fixed a bug where the cache-hit output would never be true.
    • It set its value to ${{ steps.cache.outputs.random-number }}, not ${{ steps.cache.outputs.cache-hit }}.

BD103 added 2 commits October 30, 2024 17:47
This also updates the descriptions in `action.yml` to be consistent.
@BD103 BD103 requested a review from TimJentzsch October 30, 2024 21:57
@BD103 BD103 added bug Something isn't working documentation Improvements or additions to documentation labels Oct 30, 2024
@BD103 BD103 marked this pull request as draft October 30, 2024 23:29
@BD103 BD103 marked this pull request as ready for review October 31, 2024 12:07
@BD103 BD103 merged commit a0709d8 into main Oct 31, 2024
3 checks passed
@BD103 BD103 deleted the replace-input-table branch October 31, 2024 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document configuration options in example yaml instead of table
2 participants