Update readme and examples to use v2 #329
Conversation
aiqiaoy
force-pushed
the
aiyan/v2-release-doc
branch
from
351f15e to
581312b
Compare
README.md
Outdated
| ## Usage | ||
|
|
||
| ### Pre-requisites | ||
| Create a workflow `.yml` file in your repositories `.github/workflows` directory. An [example workflow](#example-workflow) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file). | ||
|
|
||
| ### Inputs | ||
|
|
||
| * `path` - A directory to store and save the cache | ||
| * `path` - Directories to store and save the cache. Supports pattern matching, multipath and single file cache |
There was a problem hiding this comment.
Are there plans to change this to paths since multiple paths are now supported or will this be kept as is?
There was a problem hiding this comment.
This will be kept as-is to make it easier to upgrade to v2.
The three options are:
- Keep
pathas-is and make it easy to upgrade - Rename to
paths, break any users who try to changev1tov2and not know about this input name change. - Support both
pathandpaths, this might get confusing to users and we'd have to figure out what to do if a user specified both.
There was a problem hiding this comment.
Left some minor comments, overall looks good.
The most important thing that's left is to update the path description in https://github.com/actions/cache/blob/master/action.yml#L5
examples.md
Outdated
| with: | ||
| path: ${{ github.workspace }}/.nuget/packages | ||
| key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-nuget- | ||
| ``` | ||
|
|
||
| With `actions/cache@v2` you can now exclude unwanted packages with [exclude pattern](https://github.com/actions/toolkit/tree/master/packages/glob#exclude-patterns) |
There was a problem hiding this comment.
"If you do not want to include them, consider to move the cache folder like below."
Should we remove the above recommendation since the wild card exclude pattern is a better approach?
There was a problem hiding this comment.
I guess it depends on how many packages the user wants to exclude. Maybe move the wild card example up to show that it's a better approach?
|
I've opened an additional PR, which isn't very rush but may also be worth including in the initial release of v2. actions/toolkit#475 |
aiqiaoy
force-pushed
the
aiyan/v2-release-doc
branch
from
6c5d976 to
e6c708b
Compare
Update readme and examples to use v2
#323