-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Rewrite readmes #1085
Rewrite readmes #1085
Conversation
Excellent effort on fixing these @jsoref 💯 |
README.md
Outdated
|
||
If you are using a `self-hosted` Windows runner, `GNU tar` and `zstd` are required for [Cross-OS caching](https://github.com/actions/cache/blob/main/tips-and-workarounds.md#cross-os-cache) to work. They are also recommended to be installed in general so the performance is on par with `hosted` Windows runners. | ||
|
||
### Inputs | ||
|
||
* `key` - An explicit key identifying a cache. See [creating a cache key](#creating-a-cache-key). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Technically a key does not identify a cache uniquely which I feel this sentence seems to be indicating. Hence better to go back to older text.
* `key` - An explicit key identifying a cache. See [creating a cache key](#creating-a-cache-key). | |
* `key` - An explicit key for restoring and saving the cache. See [creating a cache key](#creating-a-cache-key). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would you accept naming
instead of identifying
?
I'm trying to:
- avoid the awkwardness of
restoring and saving
instead ofsaving and restoring
-- yes, I get that the sequence is restore and then save (although I believe that in practice it will really only restore or save, because if the cache exists to restore, it will not save since caches are write-once by id) - harmonize the text across all three files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've applied this change:
-* `key` - An explicit key identifying a cache. See [creating a cache key](../README.md#creating-a-cache-key).
+* `key` - An explicit key for a cache entry. See [creating a cache key](../README.md#creating-a-cache-key).
Which seems like a more correct entry. It's consistent with the wording in nearby lines, avoids the problem of the restore/save, and avoids using the awkward identifying
.
examples.md
Outdated
- [Swift, Objective-C - CocoaPods](#swift-objective-c---cocoapods) | ||
- [Swift - Swift Package Manager](#swift---swift-package-manager) | ||
- [Swift - Mint](#swift---mint) | ||
- [Examples](#examples) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file itself is for examples. Do we really this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file section an attractive nuisance. I'm pretty sure that VSCode did this on its own.
So true :) Thanks @jsoref for opening this PR and making really good suggestions. I have left a couple comments. |
@bishal-pdMSFT: if you're ok w/ the one swap to |
Co-authored-by: Sankalp Kotewar <98868223+kotewar@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, thanks for the PR! 👍🏽
[](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/cache](https://togithub.com/actions/cache) | action | minor | `v3.2.4` -> `v3.3.0` | | [github/codeql-action](https://togithub.com/github/codeql-action) | action | patch | `v2.2.3` -> `v2.2.5` | | [trunk-io/trunk-action](https://togithub.com/trunk-io/trunk-action) | action | patch | `v1.0.6` -> `v1.0.7` | --- ### Release Notes <details> <summary>actions/cache</summary> ### [`v3.3.0`](https://togithub.com/actions/cache/releases/tag/v3.3.0) [Compare Source](https://togithub.com/actions/cache/compare/v3.2.6...v3.3.0) #### What's Changed - Bug: Permission is missing in cache delete example by [@​kotokaze](https://togithub.com/kotokaze) in [https://github.com/actions/cache/pull/1123](https://togithub.com/actions/cache/pull/1123) - Add `lookup-only` option by [@​cdce8p](https://togithub.com/cdce8p) in [https://github.com/actions/cache/pull/1041](https://togithub.com/actions/cache/pull/1041) #### New Contributors - [@​kotokaze](https://togithub.com/kotokaze) made their first contribution in [https://github.com/actions/cache/pull/1123](https://togithub.com/actions/cache/pull/1123) **Full Changelog**: actions/cache@v3...v3.3.0 ### [`v3.2.6`](https://togithub.com/actions/cache/releases/tag/v3.2.6) [Compare Source](https://togithub.com/actions/cache/compare/v3.2.5...v3.2.6) ##### What's Changed - Updated branch in Force deletion of caches by [@​t-dedah](https://togithub.com/t-dedah) in [https://github.com/actions/cache/pull/1108](https://togithub.com/actions/cache/pull/1108) - Fix zstd not being used after zstd version upgrade to 1.5.4 on hosted runners by [@​pdotl](https://togithub.com/pdotl) in [https://github.com/actions/cache/pull/1118](https://togithub.com/actions/cache/pull/1118) **Full Changelog**: actions/cache@v3...v3.2.6 ### [`v3.2.5`](https://togithub.com/actions/cache/releases/tag/v3.2.5) [Compare Source](https://togithub.com/actions/cache/compare/v3.2.4...v3.2.5) ##### What's Changed - Rewrite readmes by [@​jsoref](https://togithub.com/jsoref) in [https://github.com/actions/cache/pull/1085](https://togithub.com/actions/cache/pull/1085) - Fixed typos and formatting in docs by [@​kotewar](https://togithub.com/kotewar) in [https://github.com/actions/cache/pull/1076](https://togithub.com/actions/cache/pull/1076) - Fixing paths for OSes by [@​kotewar](https://togithub.com/kotewar) in [https://github.com/actions/cache/pull/1101](https://togithub.com/actions/cache/pull/1101) - Release patch version update by [@​Phantsure](https://togithub.com/Phantsure) in [https://github.com/actions/cache/pull/1105](https://togithub.com/actions/cache/pull/1105) ##### New Contributors - [@​jsoref](https://togithub.com/jsoref) made their first contribution in [https://github.com/actions/cache/pull/1085](https://togithub.com/actions/cache/pull/1085) **Full Changelog**: actions/cache@v3...v3.2.5 </details> <details> <summary>github/codeql-action</summary> ### [`v2.2.5`](https://togithub.com/github/codeql-action/compare/v2.2.4...v2.2.5) [Compare Source](https://togithub.com/github/codeql-action/compare/v2.2.4...v2.2.5) ### [`v2.2.4`](https://togithub.com/github/codeql-action/compare/v2.2.3...v2.2.4) [Compare Source](https://togithub.com/github/codeql-action/compare/v2.2.3...v2.2.4) </details> <details> <summary>trunk-io/trunk-action</summary> ### [`v1.0.7`](https://togithub.com/trunk-io/trunk-action/releases/tag/v1.0.7) [Compare Source](https://togithub.com/trunk-io/trunk-action/compare/v1.0.6...v1.0.7) Introduce a caching-only mode, controlled via `check-mode: populate_cache_only`. </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/trunk-io/plugins). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xNTkuMiIsInVwZGF0ZWRJblZlciI6IjM0LjE1OS4yIn0=--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
* Improve readmes * Add markdown for default value Co-authored-by: Sankalp Kotewar <98868223+kotewar@users.noreply.github.com> --------- Co-authored-by: Sankalp Kotewar <98868223+kotewar@users.noreply.github.com>
Description
Fix various grammatical elements in the readmes
Motivation and Context
The content needed an editor to review it.
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: