Merge pull request #1122 from actions/pdotl-patch-1

lvpx · web-flow · commit ea0503788c59 · 2023-03-17T13:09:54.000+05:30
Update Cross-OS Caching tips
diff --git a/tips-and-workarounds.md b/tips-and-workarounds.md
@@ -30,10 +30,10 @@ Reusing cache across feature branches is not allowed today to provide cache [iso
 
 From `v3.2.3` cache is cross-os compatible when `enableCrossOsArchive` input is passed as true. This means that a cache created on `ubuntu-latest` or `mac-latest` can be used by `windows-latest` and vice versa, provided the workflow which runs on `windows-latest` have input `enableCrossOsArchive` as true. This is useful to cache dependencies which are independent of the runner platform. This will help reduce the consumption of the cache quota and help build for multiple platforms from the same cache. Things to keep in mind while using this feature:
 
-- Only cache those files which are compatible across OSs.
-- Caching symlinks might cause issues while restoration as they work differently on different OSs.
-- Only cache files from within your github workspace directory.
-- Avoid using directory pointers such as `${{ github.workspace }}` or `~` (home) which eventually evaluate to an absolute path and will not match across OSs.
+- Only cache files that are compatible across OSs.
+- Caching symlinks might cause issues while restoring them as they behave differently on different OSs.
+- Be mindful when caching files from outside your github workspace directory as the directory is located at different places across OS.
+- Avoid using directory pointers such as `${{ github.workspace }}` or `~` (home) which eventually evaluate to an absolute path that does not match across OSs.
 
 ## Force deletion of caches overriding default cache eviction policy
 
