From 094a24099d7f956089d612d1bb79fd6963f46b18 Mon Sep 17 00:00:00 2001 From: Lovepreet Singh Date: Tue, 10 Jan 2023 22:52:32 +0530 Subject: [PATCH] Add gnu tar and zstd as pre-requisites for windows self-hosted runners ## Context There have been customer requests to document installation of gnu tar and zstd for self-hosted runners. We had them documented in workarounds before. Adding them to pre-requisites for better visibility for folks using self-hosted windows runners. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 660caa4..fbb5d16 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,8 @@ Create a workflow `.yml` file in your repositories `.github/workflows` directory If you are using this inside a container, a POSIX-compliant `tar` needs to be included and accessible in the execution path. +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 * `path` - A list of files, directories, and wildcard patterns to cache and restore. See [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob) for supported patterns.