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

Update readme #10

Merged
merged 1 commit into from
Nov 13, 2023
Merged

Update readme #10

merged 1 commit into from
Nov 13, 2023

Conversation

pavelloz
Copy link
Contributor

@pavelloz pavelloz commented Nov 9, 2023

This PR updates readme to recommend pinning version, just in case someone copy paste it.

Pinning to a specific version - in this case v1.0.0 - will require updating it every version release. We can also pin to v1 which is an alias to the latest v1.x.x version, if thats more in line with convention and our willingness to remember about updates.

Comment on lines +7 to +16
| name | description |
| ------------- | -------------------------------------------------------------------------------------------------------- |
| `result` | The string result to be stored in the cache. If unspecified, the action will run in "restore only" mode. |
| `cache-group` | A string that will be added to the cache key. Defaults to the name of the current workflow. |

## Outputs

|name|description|
|-|-|
|`result`| The string result of the action, either `'unknown'` or the given `result` value.|
| name | description |
| -------- | -------------------------------------------------------------------------------- |
| `result` | The string result of the action, either `'unknown'` or the given `result` value. |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prettier doing its job

@pavelloz pavelloz merged commit d0a9123 into master Nov 13, 2023
4 checks passed
@pavelloz pavelloz deleted the pavel/update-readme branch November 13, 2023 21:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants