Compare commits
	
		
			14 Commits
		
	
	
		
			phantsure/
			...
			phantsure/
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
|   | 4a39428162 | ||
|   | a88f332eb2 | ||
|   | 94407e72c8 | ||
|   | 48a27058cf | ||
|   | 2637f06e5f | ||
|   | 1f414295fe | ||
|   | af9067e3c7 | ||
|   | 5e66b6cac9 | ||
|   | 365406cb70 | ||
|   | d6217569d5 | ||
|   | 84e54000da | ||
|   | 4723a57e26 | ||
|   | 35f35f44e8 | ||
|   | ca1c035094 | 
							
								
								
									
										2
									
								
								.licenses/npm/@actions/cache.dep.yml
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										2
									
								
								.licenses/npm/@actions/cache.dep.yml
									
									
									
										generated
									
									
									
								
							| @@ -1,6 +1,6 @@ | |||||||
| --- | --- | ||||||
| name: "@actions/cache" | name: "@actions/cache" | ||||||
| version: 3.1.0 | version: 3.1.2 | ||||||
| type: npm | type: npm | ||||||
| summary: | summary: | ||||||
| homepage: | homepage: | ||||||
|   | |||||||
| @@ -28,7 +28,6 @@ See ["Caching dependencies to speed up workflows"](https://docs.github.com/en/ac | |||||||
| * Fix zstd not working for windows on gnu tar in issues. | * Fix zstd not working for windows on gnu tar in issues. | ||||||
| * Allowing users to provide a custom timeout as input for aborting download of a cache segment using an environment variable `SEGMENT_DOWNLOAD_TIMEOUT_MINS`. Default is 60 minutes. | * Allowing users to provide a custom timeout as input for aborting download of a cache segment using an environment variable `SEGMENT_DOWNLOAD_TIMEOUT_MINS`. Default is 60 minutes. | ||||||
| * Two new actions available for granular control over caches - [restore](restore/action.yml) and [save](save/action.yml) | * Two new actions available for granular control over caches - [restore](restore/action.yml) and [save](save/action.yml) | ||||||
| * Add support for cross os caching. For example, a cache saved on windows can be restored on ubuntu and vice versa. |  | ||||||
|  |  | ||||||
| Refer [here](https://github.com/actions/cache/blob/v2/README.md) for previous versions | Refer [here](https://github.com/actions/cache/blob/v2/README.md) for previous versions | ||||||
|  |  | ||||||
| @@ -46,7 +45,7 @@ If you are using this inside a container, a POSIX-compliant `tar` needs to be in | |||||||
| * `restore-keys` - An ordered list of prefix-matched keys to use for restoring stale cache if no cache hit occurred for key. | * `restore-keys` - An ordered list of prefix-matched keys to use for restoring stale cache if no cache hit occurred for key. | ||||||
|  |  | ||||||
| #### Environment Variables | #### Environment Variables | ||||||
| * `SEGMENT_DOWNLOAD_TIMEOUT_MINS` - Segment download timeout (in minutes, default `60`) to abort download of the segment if not completed in the defined number of minutes. [Read more](https://github.com/actions/cache/blob/main/workarounds.md#cache-segment-restore-timeout) | * `SEGMENT_DOWNLOAD_TIMEOUT_MINS` - Segment download timeout (in minutes, default `60`) to abort download of the segment if not completed in the defined number of minutes. [Read more](https://github.com/actions/cache/blob/main/tips-and-workarounds.md#cache-segment-restore-timeout) | ||||||
|  |  | ||||||
| ### Outputs | ### Outputs | ||||||
|  |  | ||||||
| @@ -122,6 +121,7 @@ See [Examples](examples.md) for a list of `actions/cache` implementations for us | |||||||
| - [Swift, Objective-C - Carthage](./examples.md#swift-objective-c---carthage) | - [Swift, Objective-C - Carthage](./examples.md#swift-objective-c---carthage) | ||||||
| - [Swift, Objective-C - CocoaPods](./examples.md#swift-objective-c---cocoapods) | - [Swift, Objective-C - CocoaPods](./examples.md#swift-objective-c---cocoapods) | ||||||
| - [Swift - Swift Package Manager](./examples.md#swift---swift-package-manager) | - [Swift - Swift Package Manager](./examples.md#swift---swift-package-manager) | ||||||
|  | - [Swift - Mint](./examples.md#swift---mint) | ||||||
|  |  | ||||||
| ## Creating a cache key | ## Creating a cache key | ||||||
|  |  | ||||||
| @@ -245,6 +245,7 @@ Following are some of the known practices/workarounds which community has used t | |||||||
| - [Cache segment restore timeout](./tips-and-workarounds.md#cache-segment-restore-timeout) | - [Cache segment restore timeout](./tips-and-workarounds.md#cache-segment-restore-timeout) | ||||||
| - [Update a cache](./tips-and-workarounds.md#update-a-cache) | - [Update a cache](./tips-and-workarounds.md#update-a-cache) | ||||||
| - [Use cache across feature branches](./tips-and-workarounds.md#use-cache-across-feature-branches) | - [Use cache across feature branches](./tips-and-workarounds.md#use-cache-across-feature-branches) | ||||||
|  | - [Improving cache restore performance on Windows/Using cross-os caching](./tips-and-workarounds.md#improving-cache-restore-performance-on-windows-using-cross-os-caching) | ||||||
| - [Force deletion of caches overriding default cache eviction policy](./tips-and-workarounds.md#force-deletion-of-caches-overriding-default-cache-eviction-policy) | - [Force deletion of caches overriding default cache eviction policy](./tips-and-workarounds.md#force-deletion-of-caches-overriding-default-cache-eviction-policy) | ||||||
|  |  | ||||||
| #### Windows environment variables | #### Windows environment variables | ||||||
|   | |||||||
| @@ -59,4 +59,7 @@ | |||||||
| ### 3.2.1 | ### 3.2.1 | ||||||
| - Update `@actions/cache` on windows to use gnu tar and zstd by default and fallback to bsdtar and zstd if gnu tar is not available. ([issue](https://github.com/actions/cache/issues/984)) | - Update `@actions/cache` on windows to use gnu tar and zstd by default and fallback to bsdtar and zstd if gnu tar is not available. ([issue](https://github.com/actions/cache/issues/984)) | ||||||
| - Added support for fallback to gzip to restore old caches on windows. | - Added support for fallback to gzip to restore old caches on windows. | ||||||
| - Added logs for cache version in case of a cache miss. | - Added logs for cache version in case of a cache miss. | ||||||
|  |  | ||||||
|  | ### 3.2.2 | ||||||
|  | - Reverted the changes made in 3.2.1 to use gnu tar and zstd by default on windows. | ||||||
| @@ -174,6 +174,26 @@ test("getInputAsInt throws if required and value missing", () => { | |||||||
|     ).toThrowError(); |     ).toThrowError(); | ||||||
| }); | }); | ||||||
|  |  | ||||||
|  | test("getInputAsBool returns false if input not set", () => { | ||||||
|  |     expect(actionUtils.getInputAsBool("undefined")).toBe(false); | ||||||
|  | }); | ||||||
|  |  | ||||||
|  | test("getInputAsBool returns value if input is valid", () => { | ||||||
|  |     testUtils.setInput("foo", "true"); | ||||||
|  |     expect(actionUtils.getInputAsBool("foo")).toBe(true); | ||||||
|  | }); | ||||||
|  |  | ||||||
|  | test("getInputAsBool returns false if input is invalid or NaN", () => { | ||||||
|  |     testUtils.setInput("foo", "bar"); | ||||||
|  |     expect(actionUtils.getInputAsBool("foo")).toBe(false); | ||||||
|  | }); | ||||||
|  |  | ||||||
|  | test("getInputAsBool throws if required and value missing", () => { | ||||||
|  |     expect(() => | ||||||
|  |         actionUtils.getInputAsBool("undefined2", { required: true }) | ||||||
|  |     ).toThrowError(); | ||||||
|  | }); | ||||||
|  |  | ||||||
| test("isCacheFeatureAvailable for ac enabled", () => { | test("isCacheFeatureAvailable for ac enabled", () => { | ||||||
|     jest.spyOn(cache, "isFeatureAvailable").mockImplementation(() => true); |     jest.spyOn(cache, "isFeatureAvailable").mockImplementation(() => true); | ||||||
|  |  | ||||||
|   | |||||||
| @@ -27,9 +27,17 @@ beforeAll(() => { | |||||||
|             return actualUtils.getInputAsArray(name, options); |             return actualUtils.getInputAsArray(name, options); | ||||||
|         } |         } | ||||||
|     ); |     ); | ||||||
|  |  | ||||||
|  |     jest.spyOn(actionUtils, "getInputAsBool").mockImplementation( | ||||||
|  |         (name, options) => { | ||||||
|  |             const actualUtils = jest.requireActual("../src/utils/actionUtils"); | ||||||
|  |             return actualUtils.getInputAsBool(name, options); | ||||||
|  |         } | ||||||
|  |     ); | ||||||
| }); | }); | ||||||
|  |  | ||||||
| beforeEach(() => { | beforeEach(() => { | ||||||
|  |     jest.restoreAllMocks(); | ||||||
|     process.env[Events.Key] = Events.Push; |     process.env[Events.Key] = Events.Push; | ||||||
|     process.env[RefKey] = "refs/heads/feature-branch"; |     process.env[RefKey] = "refs/heads/feature-branch"; | ||||||
|  |  | ||||||
| @@ -50,7 +58,8 @@ test("restore with no cache found", async () => { | |||||||
|     const key = "node-test"; |     const key = "node-test"; | ||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key |         key, | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|  |  | ||||||
|     const infoMock = jest.spyOn(core, "info"); |     const infoMock = jest.spyOn(core, "info"); | ||||||
| @@ -65,7 +74,7 @@ test("restore with no cache found", async () => { | |||||||
|     await run(); |     await run(); | ||||||
|  |  | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []); |     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [], {}, false); | ||||||
|  |  | ||||||
|     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); |     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); | ||||||
|     expect(stateMock).toHaveBeenCalledTimes(1); |     expect(stateMock).toHaveBeenCalledTimes(1); | ||||||
| @@ -84,7 +93,8 @@ test("restore with restore keys and no cache found", async () => { | |||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key, |         key, | ||||||
|         restoreKeys: [restoreKey] |         restoreKeys: [restoreKey], | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|  |  | ||||||
|     const infoMock = jest.spyOn(core, "info"); |     const infoMock = jest.spyOn(core, "info"); | ||||||
| @@ -99,7 +109,13 @@ test("restore with restore keys and no cache found", async () => { | |||||||
|     await run(); |     await run(); | ||||||
|  |  | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [restoreKey]); |     expect(restoreCacheMock).toHaveBeenCalledWith( | ||||||
|  |         [path], | ||||||
|  |         key, | ||||||
|  |         [restoreKey], | ||||||
|  |         {}, | ||||||
|  |         false | ||||||
|  |     ); | ||||||
|  |  | ||||||
|     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); |     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); | ||||||
|     expect(stateMock).toHaveBeenCalledTimes(1); |     expect(stateMock).toHaveBeenCalledTimes(1); | ||||||
| @@ -116,7 +132,8 @@ test("restore with cache found for key", async () => { | |||||||
|     const key = "node-test"; |     const key = "node-test"; | ||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key |         key, | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|  |  | ||||||
|     const infoMock = jest.spyOn(core, "info"); |     const infoMock = jest.spyOn(core, "info"); | ||||||
| @@ -132,7 +149,7 @@ test("restore with cache found for key", async () => { | |||||||
|     await run(); |     await run(); | ||||||
|  |  | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []); |     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [], {}, false); | ||||||
|  |  | ||||||
|     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); |     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); | ||||||
|     expect(stateMock).toHaveBeenCalledWith("CACHE_RESULT", key); |     expect(stateMock).toHaveBeenCalledWith("CACHE_RESULT", key); | ||||||
| @@ -152,7 +169,8 @@ test("restore with cache found for restore key", async () => { | |||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key, |         key, | ||||||
|         restoreKeys: [restoreKey] |         restoreKeys: [restoreKey], | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|  |  | ||||||
|     const infoMock = jest.spyOn(core, "info"); |     const infoMock = jest.spyOn(core, "info"); | ||||||
| @@ -168,7 +186,13 @@ test("restore with cache found for restore key", async () => { | |||||||
|     await run(); |     await run(); | ||||||
|  |  | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [restoreKey]); |     expect(restoreCacheMock).toHaveBeenCalledWith( | ||||||
|  |         [path], | ||||||
|  |         key, | ||||||
|  |         [restoreKey], | ||||||
|  |         {}, | ||||||
|  |         false | ||||||
|  |     ); | ||||||
|  |  | ||||||
|     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); |     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); | ||||||
|     expect(stateMock).toHaveBeenCalledWith("CACHE_RESULT", restoreKey); |     expect(stateMock).toHaveBeenCalledWith("CACHE_RESULT", restoreKey); | ||||||
|   | |||||||
| @@ -28,9 +28,17 @@ beforeAll(() => { | |||||||
|             return actualUtils.getInputAsArray(name, options); |             return actualUtils.getInputAsArray(name, options); | ||||||
|         } |         } | ||||||
|     ); |     ); | ||||||
|  |  | ||||||
|  |     jest.spyOn(actionUtils, "getInputAsBool").mockImplementation( | ||||||
|  |         (name, options) => { | ||||||
|  |             const actualUtils = jest.requireActual("../src/utils/actionUtils"); | ||||||
|  |             return actualUtils.getInputAsBool(name, options); | ||||||
|  |         } | ||||||
|  |     ); | ||||||
| }); | }); | ||||||
|  |  | ||||||
| beforeEach(() => { | beforeEach(() => { | ||||||
|  |     jest.restoreAllMocks(); | ||||||
|     process.env[Events.Key] = Events.Push; |     process.env[Events.Key] = Events.Push; | ||||||
|     process.env[RefKey] = "refs/heads/feature-branch"; |     process.env[RefKey] = "refs/heads/feature-branch"; | ||||||
|  |  | ||||||
| @@ -97,7 +105,8 @@ test("restore on GHES with AC available ", async () => { | |||||||
|     const key = "node-test"; |     const key = "node-test"; | ||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key |         key, | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|  |  | ||||||
|     const infoMock = jest.spyOn(core, "info"); |     const infoMock = jest.spyOn(core, "info"); | ||||||
| @@ -113,7 +122,7 @@ test("restore on GHES with AC available ", async () => { | |||||||
|     await run(new StateProvider()); |     await run(new StateProvider()); | ||||||
|  |  | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []); |     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [], {}, false); | ||||||
|  |  | ||||||
|     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); |     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); | ||||||
|     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1); |     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1); | ||||||
| @@ -152,13 +161,20 @@ test("restore with too many keys should fail", async () => { | |||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key, |         key, | ||||||
|         restoreKeys |         restoreKeys, | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|     const failedMock = jest.spyOn(core, "setFailed"); |     const failedMock = jest.spyOn(core, "setFailed"); | ||||||
|     const restoreCacheMock = jest.spyOn(cache, "restoreCache"); |     const restoreCacheMock = jest.spyOn(cache, "restoreCache"); | ||||||
|     await run(new StateProvider()); |     await run(new StateProvider()); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, restoreKeys); |     expect(restoreCacheMock).toHaveBeenCalledWith( | ||||||
|  |         [path], | ||||||
|  |         key, | ||||||
|  |         restoreKeys, | ||||||
|  |         {}, | ||||||
|  |         false | ||||||
|  |     ); | ||||||
|     expect(failedMock).toHaveBeenCalledWith( |     expect(failedMock).toHaveBeenCalledWith( | ||||||
|         `Key Validation Error: Keys are limited to a maximum of 10.` |         `Key Validation Error: Keys are limited to a maximum of 10.` | ||||||
|     ); |     ); | ||||||
| @@ -169,13 +185,14 @@ test("restore with large key should fail", async () => { | |||||||
|     const key = "foo".repeat(512); // Over the 512 character limit |     const key = "foo".repeat(512); // Over the 512 character limit | ||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key |         key, | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|     const failedMock = jest.spyOn(core, "setFailed"); |     const failedMock = jest.spyOn(core, "setFailed"); | ||||||
|     const restoreCacheMock = jest.spyOn(cache, "restoreCache"); |     const restoreCacheMock = jest.spyOn(cache, "restoreCache"); | ||||||
|     await run(new StateProvider()); |     await run(new StateProvider()); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []); |     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [], {}, false); | ||||||
|     expect(failedMock).toHaveBeenCalledWith( |     expect(failedMock).toHaveBeenCalledWith( | ||||||
|         `Key Validation Error: ${key} cannot be larger than 512 characters.` |         `Key Validation Error: ${key} cannot be larger than 512 characters.` | ||||||
|     ); |     ); | ||||||
| @@ -186,13 +203,14 @@ test("restore with invalid key should fail", async () => { | |||||||
|     const key = "comma,comma"; |     const key = "comma,comma"; | ||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key |         key, | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|     const failedMock = jest.spyOn(core, "setFailed"); |     const failedMock = jest.spyOn(core, "setFailed"); | ||||||
|     const restoreCacheMock = jest.spyOn(cache, "restoreCache"); |     const restoreCacheMock = jest.spyOn(cache, "restoreCache"); | ||||||
|     await run(new StateProvider()); |     await run(new StateProvider()); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []); |     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [], {}, false); | ||||||
|     expect(failedMock).toHaveBeenCalledWith( |     expect(failedMock).toHaveBeenCalledWith( | ||||||
|         `Key Validation Error: ${key} cannot contain commas.` |         `Key Validation Error: ${key} cannot contain commas.` | ||||||
|     ); |     ); | ||||||
| @@ -203,7 +221,8 @@ test("restore with no cache found", async () => { | |||||||
|     const key = "node-test"; |     const key = "node-test"; | ||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key |         key, | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|  |  | ||||||
|     const infoMock = jest.spyOn(core, "info"); |     const infoMock = jest.spyOn(core, "info"); | ||||||
| @@ -218,7 +237,7 @@ test("restore with no cache found", async () => { | |||||||
|     await run(new StateProvider()); |     await run(new StateProvider()); | ||||||
|  |  | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []); |     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [], {}, false); | ||||||
|  |  | ||||||
|     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); |     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); | ||||||
|     expect(failedMock).toHaveBeenCalledTimes(0); |     expect(failedMock).toHaveBeenCalledTimes(0); | ||||||
| @@ -235,7 +254,8 @@ test("restore with restore keys and no cache found", async () => { | |||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key, |         key, | ||||||
|         restoreKeys: [restoreKey] |         restoreKeys: [restoreKey], | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|  |  | ||||||
|     const infoMock = jest.spyOn(core, "info"); |     const infoMock = jest.spyOn(core, "info"); | ||||||
| @@ -250,7 +270,13 @@ test("restore with restore keys and no cache found", async () => { | |||||||
|     await run(new StateProvider()); |     await run(new StateProvider()); | ||||||
|  |  | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [restoreKey]); |     expect(restoreCacheMock).toHaveBeenCalledWith( | ||||||
|  |         [path], | ||||||
|  |         key, | ||||||
|  |         [restoreKey], | ||||||
|  |         {}, | ||||||
|  |         false | ||||||
|  |     ); | ||||||
|  |  | ||||||
|     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); |     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); | ||||||
|     expect(failedMock).toHaveBeenCalledTimes(0); |     expect(failedMock).toHaveBeenCalledTimes(0); | ||||||
| @@ -265,7 +291,8 @@ test("restore with cache found for key", async () => { | |||||||
|     const key = "node-test"; |     const key = "node-test"; | ||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key |         key, | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|  |  | ||||||
|     const infoMock = jest.spyOn(core, "info"); |     const infoMock = jest.spyOn(core, "info"); | ||||||
| @@ -281,7 +308,7 @@ test("restore with cache found for key", async () => { | |||||||
|     await run(new StateProvider()); |     await run(new StateProvider()); | ||||||
|  |  | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []); |     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [], {}, false); | ||||||
|  |  | ||||||
|     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); |     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); | ||||||
|     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1); |     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1); | ||||||
| @@ -298,7 +325,8 @@ test("restore with cache found for restore key", async () => { | |||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key, |         key, | ||||||
|         restoreKeys: [restoreKey] |         restoreKeys: [restoreKey], | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|  |  | ||||||
|     const infoMock = jest.spyOn(core, "info"); |     const infoMock = jest.spyOn(core, "info"); | ||||||
| @@ -314,7 +342,13 @@ test("restore with cache found for restore key", async () => { | |||||||
|     await run(new StateProvider()); |     await run(new StateProvider()); | ||||||
|  |  | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [restoreKey]); |     expect(restoreCacheMock).toHaveBeenCalledWith( | ||||||
|  |         [path], | ||||||
|  |         key, | ||||||
|  |         [restoreKey], | ||||||
|  |         {}, | ||||||
|  |         false | ||||||
|  |     ); | ||||||
|  |  | ||||||
|     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); |     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key); | ||||||
|     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1); |     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1); | ||||||
|   | |||||||
| @@ -27,9 +27,18 @@ beforeAll(() => { | |||||||
|             return actualUtils.getInputAsArray(name, options); |             return actualUtils.getInputAsArray(name, options); | ||||||
|         } |         } | ||||||
|     ); |     ); | ||||||
|  |  | ||||||
|  |     jest.spyOn(actionUtils, "getInputAsBool").mockImplementation( | ||||||
|  |         (name, options) => { | ||||||
|  |             return jest | ||||||
|  |                 .requireActual("../src/utils/actionUtils") | ||||||
|  |                 .getInputAsBool(name, options); | ||||||
|  |         } | ||||||
|  |     ); | ||||||
| }); | }); | ||||||
|  |  | ||||||
| beforeEach(() => { | beforeEach(() => { | ||||||
|  |     jest.restoreAllMocks(); | ||||||
|     process.env[Events.Key] = Events.Push; |     process.env[Events.Key] = Events.Push; | ||||||
|     process.env[RefKey] = "refs/heads/feature-branch"; |     process.env[RefKey] = "refs/heads/feature-branch"; | ||||||
|  |  | ||||||
| @@ -50,7 +59,8 @@ test("restore with no cache found", async () => { | |||||||
|     const key = "node-test"; |     const key = "node-test"; | ||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key |         key, | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|  |  | ||||||
|     const infoMock = jest.spyOn(core, "info"); |     const infoMock = jest.spyOn(core, "info"); | ||||||
| @@ -65,7 +75,7 @@ test("restore with no cache found", async () => { | |||||||
|     await run(); |     await run(); | ||||||
|  |  | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []); |     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [], {}, false); | ||||||
|  |  | ||||||
|     expect(outputMock).toHaveBeenCalledWith("cache-primary-key", key); |     expect(outputMock).toHaveBeenCalledWith("cache-primary-key", key); | ||||||
|     expect(outputMock).toHaveBeenCalledTimes(1); |     expect(outputMock).toHaveBeenCalledTimes(1); | ||||||
| @@ -83,7 +93,8 @@ test("restore with restore keys and no cache found", async () => { | |||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key, |         key, | ||||||
|         restoreKeys: [restoreKey] |         restoreKeys: [restoreKey], | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|  |  | ||||||
|     const infoMock = jest.spyOn(core, "info"); |     const infoMock = jest.spyOn(core, "info"); | ||||||
| @@ -98,7 +109,13 @@ test("restore with restore keys and no cache found", async () => { | |||||||
|     await run(); |     await run(); | ||||||
|  |  | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [restoreKey]); |     expect(restoreCacheMock).toHaveBeenCalledWith( | ||||||
|  |         [path], | ||||||
|  |         key, | ||||||
|  |         [restoreKey], | ||||||
|  |         {}, | ||||||
|  |         false | ||||||
|  |     ); | ||||||
|  |  | ||||||
|     expect(outputMock).toHaveBeenCalledWith("cache-primary-key", key); |     expect(outputMock).toHaveBeenCalledWith("cache-primary-key", key); | ||||||
|     expect(failedMock).toHaveBeenCalledTimes(0); |     expect(failedMock).toHaveBeenCalledTimes(0); | ||||||
| @@ -113,7 +130,8 @@ test("restore with cache found for key", async () => { | |||||||
|     const key = "node-test"; |     const key = "node-test"; | ||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key |         key, | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|  |  | ||||||
|     const infoMock = jest.spyOn(core, "info"); |     const infoMock = jest.spyOn(core, "info"); | ||||||
| @@ -128,7 +146,7 @@ test("restore with cache found for key", async () => { | |||||||
|     await run(); |     await run(); | ||||||
|  |  | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []); |     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [], {}, false); | ||||||
|  |  | ||||||
|     expect(outputMock).toHaveBeenCalledWith("cache-primary-key", key); |     expect(outputMock).toHaveBeenCalledWith("cache-primary-key", key); | ||||||
|     expect(outputMock).toHaveBeenCalledWith("cache-hit", "true"); |     expect(outputMock).toHaveBeenCalledWith("cache-hit", "true"); | ||||||
| @@ -147,7 +165,8 @@ test("restore with cache found for restore key", async () => { | |||||||
|     testUtils.setInputs({ |     testUtils.setInputs({ | ||||||
|         path: path, |         path: path, | ||||||
|         key, |         key, | ||||||
|         restoreKeys: [restoreKey] |         restoreKeys: [restoreKey], | ||||||
|  |         enableCrossOsArchive: false | ||||||
|     }); |     }); | ||||||
|  |  | ||||||
|     const infoMock = jest.spyOn(core, "info"); |     const infoMock = jest.spyOn(core, "info"); | ||||||
| @@ -162,7 +181,13 @@ test("restore with cache found for restore key", async () => { | |||||||
|     await run(); |     await run(); | ||||||
|  |  | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledTimes(1); |     expect(restoreCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [restoreKey]); |     expect(restoreCacheMock).toHaveBeenCalledWith( | ||||||
|  |         [path], | ||||||
|  |         key, | ||||||
|  |         [restoreKey], | ||||||
|  |         {}, | ||||||
|  |         false | ||||||
|  |     ); | ||||||
|  |  | ||||||
|     expect(outputMock).toHaveBeenCalledWith("cache-primary-key", key); |     expect(outputMock).toHaveBeenCalledWith("cache-primary-key", key); | ||||||
|     expect(outputMock).toHaveBeenCalledWith("cache-hit", "false"); |     expect(outputMock).toHaveBeenCalledWith("cache-hit", "false"); | ||||||
|   | |||||||
| @@ -35,6 +35,14 @@ beforeAll(() => { | |||||||
|         } |         } | ||||||
|     ); |     ); | ||||||
|  |  | ||||||
|  |     jest.spyOn(actionUtils, "getInputAsBool").mockImplementation( | ||||||
|  |         (name, options) => { | ||||||
|  |             return jest | ||||||
|  |                 .requireActual("../src/utils/actionUtils") | ||||||
|  |                 .getInputAsBool(name, options); | ||||||
|  |         } | ||||||
|  |     ); | ||||||
|  |  | ||||||
|     jest.spyOn(actionUtils, "isExactKeyMatch").mockImplementation( |     jest.spyOn(actionUtils, "isExactKeyMatch").mockImplementation( | ||||||
|         (key, cacheResult) => { |         (key, cacheResult) => { | ||||||
|             return jest |             return jest | ||||||
| @@ -95,9 +103,14 @@ test("save with valid inputs uploads a cache", async () => { | |||||||
|     await run(); |     await run(); | ||||||
|  |  | ||||||
|     expect(saveCacheMock).toHaveBeenCalledTimes(1); |     expect(saveCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(saveCacheMock).toHaveBeenCalledWith([inputPath], primaryKey, { |     expect(saveCacheMock).toHaveBeenCalledWith( | ||||||
|         uploadChunkSize: 4000000 |         [inputPath], | ||||||
|     }); |         primaryKey, | ||||||
|  |         { | ||||||
|  |             uploadChunkSize: 4000000 | ||||||
|  |         }, | ||||||
|  |         false | ||||||
|  |     ); | ||||||
|  |  | ||||||
|     expect(failedMock).toHaveBeenCalledTimes(0); |     expect(failedMock).toHaveBeenCalledTimes(0); | ||||||
| }); | }); | ||||||
|   | |||||||
| @@ -32,6 +32,14 @@ beforeAll(() => { | |||||||
|         } |         } | ||||||
|     ); |     ); | ||||||
|  |  | ||||||
|  |     jest.spyOn(actionUtils, "getInputAsBool").mockImplementation( | ||||||
|  |         (name, options) => { | ||||||
|  |             return jest | ||||||
|  |                 .requireActual("../src/utils/actionUtils") | ||||||
|  |                 .getInputAsBool(name, options); | ||||||
|  |         } | ||||||
|  |     ); | ||||||
|  |  | ||||||
|     jest.spyOn(actionUtils, "isExactKeyMatch").mockImplementation( |     jest.spyOn(actionUtils, "isExactKeyMatch").mockImplementation( | ||||||
|         (key, cacheResult) => { |         (key, cacheResult) => { | ||||||
|             return jest |             return jest | ||||||
| @@ -47,6 +55,7 @@ beforeAll(() => { | |||||||
| }); | }); | ||||||
|  |  | ||||||
| beforeEach(() => { | beforeEach(() => { | ||||||
|  |     jest.restoreAllMocks(); | ||||||
|     process.env[Events.Key] = Events.Push; |     process.env[Events.Key] = Events.Push; | ||||||
|     process.env[RefKey] = "refs/heads/feature-branch"; |     process.env[RefKey] = "refs/heads/feature-branch"; | ||||||
|  |  | ||||||
| @@ -155,9 +164,14 @@ test("save on GHES with AC available", async () => { | |||||||
|     await run(new StateProvider()); |     await run(new StateProvider()); | ||||||
|  |  | ||||||
|     expect(saveCacheMock).toHaveBeenCalledTimes(1); |     expect(saveCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(saveCacheMock).toHaveBeenCalledWith([inputPath], primaryKey, { |     expect(saveCacheMock).toHaveBeenCalledWith( | ||||||
|         uploadChunkSize: 4000000 |         [inputPath], | ||||||
|     }); |         primaryKey, | ||||||
|  |         { | ||||||
|  |             uploadChunkSize: 4000000 | ||||||
|  |         }, | ||||||
|  |         false | ||||||
|  |     ); | ||||||
|  |  | ||||||
|     expect(failedMock).toHaveBeenCalledTimes(0); |     expect(failedMock).toHaveBeenCalledTimes(0); | ||||||
| }); | }); | ||||||
| @@ -251,7 +265,8 @@ test("save with large cache outputs warning", async () => { | |||||||
|     expect(saveCacheMock).toHaveBeenCalledWith( |     expect(saveCacheMock).toHaveBeenCalledWith( | ||||||
|         [inputPath], |         [inputPath], | ||||||
|         primaryKey, |         primaryKey, | ||||||
|         expect.anything() |         expect.anything(), | ||||||
|  |         false | ||||||
|     ); |     ); | ||||||
|  |  | ||||||
|     expect(logWarningMock).toHaveBeenCalledTimes(1); |     expect(logWarningMock).toHaveBeenCalledTimes(1); | ||||||
| @@ -297,7 +312,8 @@ test("save with reserve cache failure outputs warning", async () => { | |||||||
|     expect(saveCacheMock).toHaveBeenCalledWith( |     expect(saveCacheMock).toHaveBeenCalledWith( | ||||||
|         [inputPath], |         [inputPath], | ||||||
|         primaryKey, |         primaryKey, | ||||||
|         expect.anything() |         expect.anything(), | ||||||
|  |         false | ||||||
|     ); |     ); | ||||||
|  |  | ||||||
|     expect(logWarningMock).toHaveBeenCalledWith( |     expect(logWarningMock).toHaveBeenCalledWith( | ||||||
| @@ -339,7 +355,8 @@ test("save with server error outputs warning", async () => { | |||||||
|     expect(saveCacheMock).toHaveBeenCalledWith( |     expect(saveCacheMock).toHaveBeenCalledWith( | ||||||
|         [inputPath], |         [inputPath], | ||||||
|         primaryKey, |         primaryKey, | ||||||
|         expect.anything() |         expect.anything(), | ||||||
|  |         false | ||||||
|     ); |     ); | ||||||
|  |  | ||||||
|     expect(logWarningMock).toHaveBeenCalledTimes(1); |     expect(logWarningMock).toHaveBeenCalledTimes(1); | ||||||
| @@ -378,9 +395,14 @@ test("save with valid inputs uploads a cache", async () => { | |||||||
|     await run(new StateProvider()); |     await run(new StateProvider()); | ||||||
|  |  | ||||||
|     expect(saveCacheMock).toHaveBeenCalledTimes(1); |     expect(saveCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(saveCacheMock).toHaveBeenCalledWith([inputPath], primaryKey, { |     expect(saveCacheMock).toHaveBeenCalledWith( | ||||||
|         uploadChunkSize: 4000000 |         [inputPath], | ||||||
|     }); |         primaryKey, | ||||||
|  |         { | ||||||
|  |             uploadChunkSize: 4000000 | ||||||
|  |         }, | ||||||
|  |         false | ||||||
|  |     ); | ||||||
|  |  | ||||||
|     expect(failedMock).toHaveBeenCalledTimes(0); |     expect(failedMock).toHaveBeenCalledTimes(0); | ||||||
| }); | }); | ||||||
|   | |||||||
| @@ -35,6 +35,14 @@ beforeAll(() => { | |||||||
|         } |         } | ||||||
|     ); |     ); | ||||||
|  |  | ||||||
|  |     jest.spyOn(actionUtils, "getInputAsBool").mockImplementation( | ||||||
|  |         (name, options) => { | ||||||
|  |             return jest | ||||||
|  |                 .requireActual("../src/utils/actionUtils") | ||||||
|  |                 .getInputAsBool(name, options); | ||||||
|  |         } | ||||||
|  |     ); | ||||||
|  |  | ||||||
|     jest.spyOn(actionUtils, "isExactKeyMatch").mockImplementation( |     jest.spyOn(actionUtils, "isExactKeyMatch").mockImplementation( | ||||||
|         (key, cacheResult) => { |         (key, cacheResult) => { | ||||||
|             return jest |             return jest | ||||||
| @@ -85,9 +93,14 @@ test("save with valid inputs uploads a cache", async () => { | |||||||
|     await run(); |     await run(); | ||||||
|  |  | ||||||
|     expect(saveCacheMock).toHaveBeenCalledTimes(1); |     expect(saveCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(saveCacheMock).toHaveBeenCalledWith([inputPath], primaryKey, { |     expect(saveCacheMock).toHaveBeenCalledWith( | ||||||
|         uploadChunkSize: 4000000 |         [inputPath], | ||||||
|     }); |         primaryKey, | ||||||
|  |         { | ||||||
|  |             uploadChunkSize: 4000000 | ||||||
|  |         }, | ||||||
|  |         false | ||||||
|  |     ); | ||||||
|  |  | ||||||
|     expect(failedMock).toHaveBeenCalledTimes(0); |     expect(failedMock).toHaveBeenCalledTimes(0); | ||||||
| }); | }); | ||||||
| @@ -112,9 +125,14 @@ test("save failing logs the warning message", async () => { | |||||||
|     await run(); |     await run(); | ||||||
|  |  | ||||||
|     expect(saveCacheMock).toHaveBeenCalledTimes(1); |     expect(saveCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(saveCacheMock).toHaveBeenCalledWith([inputPath], primaryKey, { |     expect(saveCacheMock).toHaveBeenCalledWith( | ||||||
|         uploadChunkSize: 4000000 |         [inputPath], | ||||||
|     }); |         primaryKey, | ||||||
|  |         { | ||||||
|  |             uploadChunkSize: 4000000 | ||||||
|  |         }, | ||||||
|  |         false | ||||||
|  |     ); | ||||||
|  |  | ||||||
|     expect(warningMock).toHaveBeenCalledTimes(1); |     expect(warningMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(warningMock).toHaveBeenCalledWith("Cache save failed."); |     expect(warningMock).toHaveBeenCalledWith("Cache save failed."); | ||||||
|   | |||||||
| @@ -14,6 +14,10 @@ inputs: | |||||||
|   upload-chunk-size: |   upload-chunk-size: | ||||||
|     description: 'The chunk size used to split up large files during upload, in bytes' |     description: 'The chunk size used to split up large files during upload, in bytes' | ||||||
|     required: false |     required: false | ||||||
|  |   enableCrossOsArchive: | ||||||
|  |     description: 'An optional boolean when enabled, allows windows runners to save or restore caches that can be restored or saved respectively on other platforms' | ||||||
|  |     default: 'false' | ||||||
|  |     required: false | ||||||
| outputs: | outputs: | ||||||
|   cache-hit: |   cache-hit: | ||||||
|     description: 'A boolean value to indicate an exact match was found for the primary key' |     description: 'A boolean value to indicate an exact match was found for the primary key' | ||||||
|   | |||||||
							
								
								
									
										69
									
								
								dist/restore-only/index.js
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										69
									
								
								dist/restore-only/index.js
									
									
									
									
										vendored
									
									
								
							| @@ -3383,7 +3383,6 @@ const crypto = __importStar(__webpack_require__(417)); | |||||||
| const fs = __importStar(__webpack_require__(747)); | const fs = __importStar(__webpack_require__(747)); | ||||||
| const url_1 = __webpack_require__(414); | const url_1 = __webpack_require__(414); | ||||||
| const utils = __importStar(__webpack_require__(15)); | const utils = __importStar(__webpack_require__(15)); | ||||||
| const constants_1 = __webpack_require__(931); |  | ||||||
| const downloadUtils_1 = __webpack_require__(251); | const downloadUtils_1 = __webpack_require__(251); | ||||||
| const options_1 = __webpack_require__(538); | const options_1 = __webpack_require__(538); | ||||||
| const requestUtils_1 = __webpack_require__(899); | const requestUtils_1 = __webpack_require__(899); | ||||||
| @@ -3413,10 +3412,17 @@ function createHttpClient() { | |||||||
|     const bearerCredentialHandler = new auth_1.BearerCredentialHandler(token); |     const bearerCredentialHandler = new auth_1.BearerCredentialHandler(token); | ||||||
|     return new http_client_1.HttpClient('actions/cache', [bearerCredentialHandler], getRequestOptions()); |     return new http_client_1.HttpClient('actions/cache', [bearerCredentialHandler], getRequestOptions()); | ||||||
| } | } | ||||||
| function getCacheVersion(paths, compressionMethod) { | function getCacheVersion(paths, compressionMethod, enableCrossOsArchive = false) { | ||||||
|     const components = paths.concat(!compressionMethod || compressionMethod === constants_1.CompressionMethod.Gzip |     const components = paths; | ||||||
|         ? [] |     // Add compression method to cache version to restore
 | ||||||
|         : [compressionMethod]); |     // compressed cache as per compression method
 | ||||||
|  |     if (compressionMethod) { | ||||||
|  |         components.push(compressionMethod); | ||||||
|  |     } | ||||||
|  |     // Only check for windows platforms if enableCrossOsArchive is false
 | ||||||
|  |     if (process.platform === 'win32' && !enableCrossOsArchive) { | ||||||
|  |         components.push('windows-only'); | ||||||
|  |     } | ||||||
|     // Add salt to cache version to support breaking changes in cache entry
 |     // Add salt to cache version to support breaking changes in cache entry
 | ||||||
|     components.push(versionSalt); |     components.push(versionSalt); | ||||||
|     return crypto |     return crypto | ||||||
| @@ -3428,7 +3434,7 @@ exports.getCacheVersion = getCacheVersion; | |||||||
| function getCacheEntry(keys, paths, options) { | function getCacheEntry(keys, paths, options) { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         const httpClient = createHttpClient(); |         const httpClient = createHttpClient(); | ||||||
|         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod); |         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod, options === null || options === void 0 ? void 0 : options.enableCrossOsArchive); | ||||||
|         const resource = `cache?keys=${encodeURIComponent(keys.join(','))}&version=${version}`; |         const resource = `cache?keys=${encodeURIComponent(keys.join(','))}&version=${version}`; | ||||||
|         const response = yield requestUtils_1.retryTypedResponse('getCacheEntry', () => __awaiter(this, void 0, void 0, function* () { return httpClient.getJson(getCacheApiUrl(resource)); })); |         const response = yield requestUtils_1.retryTypedResponse('getCacheEntry', () => __awaiter(this, void 0, void 0, function* () { return httpClient.getJson(getCacheApiUrl(resource)); })); | ||||||
|         // Cache not found
 |         // Cache not found
 | ||||||
| @@ -3491,7 +3497,7 @@ exports.downloadCache = downloadCache; | |||||||
| function reserveCache(key, paths, options) { | function reserveCache(key, paths, options) { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         const httpClient = createHttpClient(); |         const httpClient = createHttpClient(); | ||||||
|         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod); |         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod, options === null || options === void 0 ? void 0 : options.enableCrossOsArchive); | ||||||
|         const reserveCacheRequest = { |         const reserveCacheRequest = { | ||||||
|             key, |             key, | ||||||
|             version, |             version, | ||||||
| @@ -4971,7 +4977,8 @@ var Inputs; | |||||||
|     Inputs["Key"] = "key"; |     Inputs["Key"] = "key"; | ||||||
|     Inputs["Path"] = "path"; |     Inputs["Path"] = "path"; | ||||||
|     Inputs["RestoreKeys"] = "restore-keys"; |     Inputs["RestoreKeys"] = "restore-keys"; | ||||||
|     Inputs["UploadChunkSize"] = "upload-chunk-size"; // Input for cache, save action
 |     Inputs["UploadChunkSize"] = "upload-chunk-size"; | ||||||
|  |     Inputs["EnableCrossOsArchive"] = "enableCrossOsArchive"; // Input for cache, restore, save action
 | ||||||
| })(Inputs = exports.Inputs || (exports.Inputs = {})); | })(Inputs = exports.Inputs || (exports.Inputs = {})); | ||||||
| var Outputs; | var Outputs; | ||||||
| (function (Outputs) { | (function (Outputs) { | ||||||
| @@ -10067,7 +10074,7 @@ var __importStar = (this && this.__importStar) || function (mod) { | |||||||
|     return result; |     return result; | ||||||
| }; | }; | ||||||
| Object.defineProperty(exports, "__esModule", { value: true }); | Object.defineProperty(exports, "__esModule", { value: true }); | ||||||
| exports.isCacheFeatureAvailable = exports.getInputAsInt = exports.getInputAsArray = exports.isValidEvent = exports.logWarning = exports.isExactKeyMatch = exports.isGhes = void 0; | exports.isCacheFeatureAvailable = exports.getInputAsBool = exports.getInputAsInt = exports.getInputAsArray = exports.isValidEvent = exports.logWarning = exports.isExactKeyMatch = exports.isGhes = void 0; | ||||||
| const cache = __importStar(__webpack_require__(692)); | const cache = __importStar(__webpack_require__(692)); | ||||||
| const core = __importStar(__webpack_require__(470)); | const core = __importStar(__webpack_require__(470)); | ||||||
| const constants_1 = __webpack_require__(196); | const constants_1 = __webpack_require__(196); | ||||||
| @@ -10110,6 +10117,11 @@ function getInputAsInt(name, options) { | |||||||
|     return value; |     return value; | ||||||
| } | } | ||||||
| exports.getInputAsInt = getInputAsInt; | exports.getInputAsInt = getInputAsInt; | ||||||
|  | function getInputAsBool(name, options) { | ||||||
|  |     const result = core.getInput(name, options); | ||||||
|  |     return result.toLowerCase() === "true"; | ||||||
|  | } | ||||||
|  | exports.getInputAsBool = getInputAsBool; | ||||||
| function isCacheFeatureAvailable() { | function isCacheFeatureAvailable() { | ||||||
|     if (cache.isFeatureAvailable()) { |     if (cache.isFeatureAvailable()) { | ||||||
|         return true; |         return true; | ||||||
| @@ -38217,12 +38229,14 @@ var __importStar = (this && this.__importStar) || function (mod) { | |||||||
| }; | }; | ||||||
| Object.defineProperty(exports, "__esModule", { value: true }); | Object.defineProperty(exports, "__esModule", { value: true }); | ||||||
| const exec_1 = __webpack_require__(986); | const exec_1 = __webpack_require__(986); | ||||||
|  | const core_1 = __webpack_require__(470); | ||||||
| const io = __importStar(__webpack_require__(1)); | const io = __importStar(__webpack_require__(1)); | ||||||
| const fs_1 = __webpack_require__(747); | const fs_1 = __webpack_require__(747); | ||||||
| const path = __importStar(__webpack_require__(622)); | const path = __importStar(__webpack_require__(622)); | ||||||
| const utils = __importStar(__webpack_require__(15)); | const utils = __importStar(__webpack_require__(15)); | ||||||
| const constants_1 = __webpack_require__(931); | const constants_1 = __webpack_require__(931); | ||||||
| const IS_WINDOWS = process.platform === 'win32'; | const IS_WINDOWS = process.platform === 'win32'; | ||||||
|  | core_1.exportVariable('MSYS', 'winsymlinks:nativestrict'); | ||||||
| // Returns tar path and type: BSD or GNU
 | // Returns tar path and type: BSD or GNU
 | ||||||
| function getTarPath() { | function getTarPath() { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
| @@ -47195,7 +47209,6 @@ const path = __importStar(__webpack_require__(622)); | |||||||
| const utils = __importStar(__webpack_require__(15)); | const utils = __importStar(__webpack_require__(15)); | ||||||
| const cacheHttpClient = __importStar(__webpack_require__(114)); | const cacheHttpClient = __importStar(__webpack_require__(114)); | ||||||
| const tar_1 = __webpack_require__(434); | const tar_1 = __webpack_require__(434); | ||||||
| const constants_1 = __webpack_require__(931); |  | ||||||
| class ValidationError extends Error { | class ValidationError extends Error { | ||||||
|     constructor(message) { |     constructor(message) { | ||||||
|         super(message); |         super(message); | ||||||
| @@ -47242,9 +47255,10 @@ exports.isFeatureAvailable = isFeatureAvailable; | |||||||
|  * @param primaryKey an explicit key for restoring the cache |  * @param primaryKey an explicit key for restoring the cache | ||||||
|  * @param restoreKeys an optional ordered list of keys to use for restoring the cache if no cache hit occurred for key |  * @param restoreKeys an optional ordered list of keys to use for restoring the cache if no cache hit occurred for key | ||||||
|  * @param downloadOptions cache download options |  * @param downloadOptions cache download options | ||||||
|  |  * @param enableCrossOsArchive an optional boolean enabled to restore on windows any cache created on any platform | ||||||
|  * @returns string returns the key for the cache hit, otherwise returns undefined |  * @returns string returns the key for the cache hit, otherwise returns undefined | ||||||
|  */ |  */ | ||||||
| function restoreCache(paths, primaryKey, restoreKeys, options) { | function restoreCache(paths, primaryKey, restoreKeys, options, enableCrossOsArchive = false) { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         checkPaths(paths); |         checkPaths(paths); | ||||||
|         restoreKeys = restoreKeys || []; |         restoreKeys = restoreKeys || []; | ||||||
| @@ -47257,31 +47271,17 @@ function restoreCache(paths, primaryKey, restoreKeys, options) { | |||||||
|         for (const key of keys) { |         for (const key of keys) { | ||||||
|             checkKey(key); |             checkKey(key); | ||||||
|         } |         } | ||||||
|         let cacheEntry; |         const compressionMethod = yield utils.getCompressionMethod(); | ||||||
|         let compressionMethod = yield utils.getCompressionMethod(); |  | ||||||
|         let archivePath = ''; |         let archivePath = ''; | ||||||
|         try { |         try { | ||||||
|             // path are needed to compute version
 |             // path are needed to compute version
 | ||||||
|             cacheEntry = yield cacheHttpClient.getCacheEntry(keys, paths, { |             const cacheEntry = yield cacheHttpClient.getCacheEntry(keys, paths, { | ||||||
|                 compressionMethod |                 compressionMethod, | ||||||
|  |                 enableCrossOsArchive | ||||||
|             }); |             }); | ||||||
|             if (!(cacheEntry === null || cacheEntry === void 0 ? void 0 : cacheEntry.archiveLocation)) { |             if (!(cacheEntry === null || cacheEntry === void 0 ? void 0 : cacheEntry.archiveLocation)) { | ||||||
|                 // This is to support the old cache entry created by gzip on windows.
 |                 // Cache not found
 | ||||||
|                 if (process.platform === 'win32' && |                 return undefined; | ||||||
|                     compressionMethod !== constants_1.CompressionMethod.Gzip) { |  | ||||||
|                     compressionMethod = constants_1.CompressionMethod.Gzip; |  | ||||||
|                     cacheEntry = yield cacheHttpClient.getCacheEntry(keys, paths, { |  | ||||||
|                         compressionMethod |  | ||||||
|                     }); |  | ||||||
|                     if (!(cacheEntry === null || cacheEntry === void 0 ? void 0 : cacheEntry.archiveLocation)) { |  | ||||||
|                         return undefined; |  | ||||||
|                     } |  | ||||||
|                     core.info("Couldn't find cache entry with zstd compression, falling back to gzip compression."); |  | ||||||
|                 } |  | ||||||
|                 else { |  | ||||||
|                     // Cache not found
 |  | ||||||
|                     return undefined; |  | ||||||
|                 } |  | ||||||
|             } |             } | ||||||
|             archivePath = path.join(yield utils.createTempDirectory(), utils.getCacheFileName(compressionMethod)); |             archivePath = path.join(yield utils.createTempDirectory(), utils.getCacheFileName(compressionMethod)); | ||||||
|             core.debug(`Archive Path: ${archivePath}`); |             core.debug(`Archive Path: ${archivePath}`); | ||||||
| @@ -47324,10 +47324,11 @@ exports.restoreCache = restoreCache; | |||||||
|  * |  * | ||||||
|  * @param paths a list of file paths to be cached |  * @param paths a list of file paths to be cached | ||||||
|  * @param key an explicit key for restoring the cache |  * @param key an explicit key for restoring the cache | ||||||
|  |  * @param enableCrossOsArchive an optional boolean enabled to save cache on windows which could be restored on any platform | ||||||
|  * @param options cache upload options |  * @param options cache upload options | ||||||
|  * @returns number returns cacheId if the cache was saved successfully and throws an error if save fails |  * @returns number returns cacheId if the cache was saved successfully and throws an error if save fails | ||||||
|  */ |  */ | ||||||
| function saveCache(paths, key, options) { | function saveCache(paths, key, options, enableCrossOsArchive = false) { | ||||||
|     var _a, _b, _c, _d, _e; |     var _a, _b, _c, _d, _e; | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         checkPaths(paths); |         checkPaths(paths); | ||||||
| @@ -47358,6 +47359,7 @@ function saveCache(paths, key, options) { | |||||||
|             core.debug('Reserving Cache'); |             core.debug('Reserving Cache'); | ||||||
|             const reserveCacheResponse = yield cacheHttpClient.reserveCache(key, paths, { |             const reserveCacheResponse = yield cacheHttpClient.reserveCache(key, paths, { | ||||||
|                 compressionMethod, |                 compressionMethod, | ||||||
|  |                 enableCrossOsArchive, | ||||||
|                 cacheSize: archiveFileSize |                 cacheSize: archiveFileSize | ||||||
|             }); |             }); | ||||||
|             if ((_a = reserveCacheResponse === null || reserveCacheResponse === void 0 ? void 0 : reserveCacheResponse.result) === null || _a === void 0 ? void 0 : _a.cacheId) { |             if ((_a = reserveCacheResponse === null || reserveCacheResponse === void 0 ? void 0 : reserveCacheResponse.result) === null || _a === void 0 ? void 0 : _a.cacheId) { | ||||||
| @@ -50492,7 +50494,8 @@ function restoreImpl(stateProvider) { | |||||||
|             const cachePaths = utils.getInputAsArray(constants_1.Inputs.Path, { |             const cachePaths = utils.getInputAsArray(constants_1.Inputs.Path, { | ||||||
|                 required: true |                 required: true | ||||||
|             }); |             }); | ||||||
|             const cacheKey = yield cache.restoreCache(cachePaths, primaryKey, restoreKeys); |             const enableCrossOsArchive = utils.getInputAsBool(constants_1.Inputs.EnableCrossOsArchive); | ||||||
|  |             const cacheKey = yield cache.restoreCache(cachePaths, primaryKey, restoreKeys, {}, enableCrossOsArchive); | ||||||
|             if (!cacheKey) { |             if (!cacheKey) { | ||||||
|                 core.info(`Cache not found for input keys: ${[ |                 core.info(`Cache not found for input keys: ${[ | ||||||
|                     primaryKey, |                     primaryKey, | ||||||
|   | |||||||
							
								
								
									
										69
									
								
								dist/restore/index.js
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										69
									
								
								dist/restore/index.js
									
									
									
									
										vendored
									
									
								
							| @@ -3383,7 +3383,6 @@ const crypto = __importStar(__webpack_require__(417)); | |||||||
| const fs = __importStar(__webpack_require__(747)); | const fs = __importStar(__webpack_require__(747)); | ||||||
| const url_1 = __webpack_require__(414); | const url_1 = __webpack_require__(414); | ||||||
| const utils = __importStar(__webpack_require__(15)); | const utils = __importStar(__webpack_require__(15)); | ||||||
| const constants_1 = __webpack_require__(931); |  | ||||||
| const downloadUtils_1 = __webpack_require__(251); | const downloadUtils_1 = __webpack_require__(251); | ||||||
| const options_1 = __webpack_require__(538); | const options_1 = __webpack_require__(538); | ||||||
| const requestUtils_1 = __webpack_require__(899); | const requestUtils_1 = __webpack_require__(899); | ||||||
| @@ -3413,10 +3412,17 @@ function createHttpClient() { | |||||||
|     const bearerCredentialHandler = new auth_1.BearerCredentialHandler(token); |     const bearerCredentialHandler = new auth_1.BearerCredentialHandler(token); | ||||||
|     return new http_client_1.HttpClient('actions/cache', [bearerCredentialHandler], getRequestOptions()); |     return new http_client_1.HttpClient('actions/cache', [bearerCredentialHandler], getRequestOptions()); | ||||||
| } | } | ||||||
| function getCacheVersion(paths, compressionMethod) { | function getCacheVersion(paths, compressionMethod, enableCrossOsArchive = false) { | ||||||
|     const components = paths.concat(!compressionMethod || compressionMethod === constants_1.CompressionMethod.Gzip |     const components = paths; | ||||||
|         ? [] |     // Add compression method to cache version to restore
 | ||||||
|         : [compressionMethod]); |     // compressed cache as per compression method
 | ||||||
|  |     if (compressionMethod) { | ||||||
|  |         components.push(compressionMethod); | ||||||
|  |     } | ||||||
|  |     // Only check for windows platforms if enableCrossOsArchive is false
 | ||||||
|  |     if (process.platform === 'win32' && !enableCrossOsArchive) { | ||||||
|  |         components.push('windows-only'); | ||||||
|  |     } | ||||||
|     // Add salt to cache version to support breaking changes in cache entry
 |     // Add salt to cache version to support breaking changes in cache entry
 | ||||||
|     components.push(versionSalt); |     components.push(versionSalt); | ||||||
|     return crypto |     return crypto | ||||||
| @@ -3428,7 +3434,7 @@ exports.getCacheVersion = getCacheVersion; | |||||||
| function getCacheEntry(keys, paths, options) { | function getCacheEntry(keys, paths, options) { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         const httpClient = createHttpClient(); |         const httpClient = createHttpClient(); | ||||||
|         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod); |         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod, options === null || options === void 0 ? void 0 : options.enableCrossOsArchive); | ||||||
|         const resource = `cache?keys=${encodeURIComponent(keys.join(','))}&version=${version}`; |         const resource = `cache?keys=${encodeURIComponent(keys.join(','))}&version=${version}`; | ||||||
|         const response = yield requestUtils_1.retryTypedResponse('getCacheEntry', () => __awaiter(this, void 0, void 0, function* () { return httpClient.getJson(getCacheApiUrl(resource)); })); |         const response = yield requestUtils_1.retryTypedResponse('getCacheEntry', () => __awaiter(this, void 0, void 0, function* () { return httpClient.getJson(getCacheApiUrl(resource)); })); | ||||||
|         // Cache not found
 |         // Cache not found
 | ||||||
| @@ -3491,7 +3497,7 @@ exports.downloadCache = downloadCache; | |||||||
| function reserveCache(key, paths, options) { | function reserveCache(key, paths, options) { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         const httpClient = createHttpClient(); |         const httpClient = createHttpClient(); | ||||||
|         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod); |         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod, options === null || options === void 0 ? void 0 : options.enableCrossOsArchive); | ||||||
|         const reserveCacheRequest = { |         const reserveCacheRequest = { | ||||||
|             key, |             key, | ||||||
|             version, |             version, | ||||||
| @@ -4971,7 +4977,8 @@ var Inputs; | |||||||
|     Inputs["Key"] = "key"; |     Inputs["Key"] = "key"; | ||||||
|     Inputs["Path"] = "path"; |     Inputs["Path"] = "path"; | ||||||
|     Inputs["RestoreKeys"] = "restore-keys"; |     Inputs["RestoreKeys"] = "restore-keys"; | ||||||
|     Inputs["UploadChunkSize"] = "upload-chunk-size"; // Input for cache, save action
 |     Inputs["UploadChunkSize"] = "upload-chunk-size"; | ||||||
|  |     Inputs["EnableCrossOsArchive"] = "enableCrossOsArchive"; // Input for cache, restore, save action
 | ||||||
| })(Inputs = exports.Inputs || (exports.Inputs = {})); | })(Inputs = exports.Inputs || (exports.Inputs = {})); | ||||||
| var Outputs; | var Outputs; | ||||||
| (function (Outputs) { | (function (Outputs) { | ||||||
| @@ -38130,12 +38137,14 @@ var __importStar = (this && this.__importStar) || function (mod) { | |||||||
| }; | }; | ||||||
| Object.defineProperty(exports, "__esModule", { value: true }); | Object.defineProperty(exports, "__esModule", { value: true }); | ||||||
| const exec_1 = __webpack_require__(986); | const exec_1 = __webpack_require__(986); | ||||||
|  | const core_1 = __webpack_require__(470); | ||||||
| const io = __importStar(__webpack_require__(1)); | const io = __importStar(__webpack_require__(1)); | ||||||
| const fs_1 = __webpack_require__(747); | const fs_1 = __webpack_require__(747); | ||||||
| const path = __importStar(__webpack_require__(622)); | const path = __importStar(__webpack_require__(622)); | ||||||
| const utils = __importStar(__webpack_require__(15)); | const utils = __importStar(__webpack_require__(15)); | ||||||
| const constants_1 = __webpack_require__(931); | const constants_1 = __webpack_require__(931); | ||||||
| const IS_WINDOWS = process.platform === 'win32'; | const IS_WINDOWS = process.platform === 'win32'; | ||||||
|  | core_1.exportVariable('MSYS', 'winsymlinks:nativestrict'); | ||||||
| // Returns tar path and type: BSD or GNU
 | // Returns tar path and type: BSD or GNU
 | ||||||
| function getTarPath() { | function getTarPath() { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
| @@ -38593,7 +38602,7 @@ var __importStar = (this && this.__importStar) || function (mod) { | |||||||
|     return result; |     return result; | ||||||
| }; | }; | ||||||
| Object.defineProperty(exports, "__esModule", { value: true }); | Object.defineProperty(exports, "__esModule", { value: true }); | ||||||
| exports.isCacheFeatureAvailable = exports.getInputAsInt = exports.getInputAsArray = exports.isValidEvent = exports.logWarning = exports.isExactKeyMatch = exports.isGhes = void 0; | exports.isCacheFeatureAvailable = exports.getInputAsBool = exports.getInputAsInt = exports.getInputAsArray = exports.isValidEvent = exports.logWarning = exports.isExactKeyMatch = exports.isGhes = void 0; | ||||||
| const cache = __importStar(__webpack_require__(692)); | const cache = __importStar(__webpack_require__(692)); | ||||||
| const core = __importStar(__webpack_require__(470)); | const core = __importStar(__webpack_require__(470)); | ||||||
| const constants_1 = __webpack_require__(196); | const constants_1 = __webpack_require__(196); | ||||||
| @@ -38636,6 +38645,11 @@ function getInputAsInt(name, options) { | |||||||
|     return value; |     return value; | ||||||
| } | } | ||||||
| exports.getInputAsInt = getInputAsInt; | exports.getInputAsInt = getInputAsInt; | ||||||
|  | function getInputAsBool(name, options) { | ||||||
|  |     const result = core.getInput(name, options); | ||||||
|  |     return result.toLowerCase() === "true"; | ||||||
|  | } | ||||||
|  | exports.getInputAsBool = getInputAsBool; | ||||||
| function isCacheFeatureAvailable() { | function isCacheFeatureAvailable() { | ||||||
|     if (cache.isFeatureAvailable()) { |     if (cache.isFeatureAvailable()) { | ||||||
|         return true; |         return true; | ||||||
| @@ -47166,7 +47180,6 @@ const path = __importStar(__webpack_require__(622)); | |||||||
| const utils = __importStar(__webpack_require__(15)); | const utils = __importStar(__webpack_require__(15)); | ||||||
| const cacheHttpClient = __importStar(__webpack_require__(114)); | const cacheHttpClient = __importStar(__webpack_require__(114)); | ||||||
| const tar_1 = __webpack_require__(434); | const tar_1 = __webpack_require__(434); | ||||||
| const constants_1 = __webpack_require__(931); |  | ||||||
| class ValidationError extends Error { | class ValidationError extends Error { | ||||||
|     constructor(message) { |     constructor(message) { | ||||||
|         super(message); |         super(message); | ||||||
| @@ -47213,9 +47226,10 @@ exports.isFeatureAvailable = isFeatureAvailable; | |||||||
|  * @param primaryKey an explicit key for restoring the cache |  * @param primaryKey an explicit key for restoring the cache | ||||||
|  * @param restoreKeys an optional ordered list of keys to use for restoring the cache if no cache hit occurred for key |  * @param restoreKeys an optional ordered list of keys to use for restoring the cache if no cache hit occurred for key | ||||||
|  * @param downloadOptions cache download options |  * @param downloadOptions cache download options | ||||||
|  |  * @param enableCrossOsArchive an optional boolean enabled to restore on windows any cache created on any platform | ||||||
|  * @returns string returns the key for the cache hit, otherwise returns undefined |  * @returns string returns the key for the cache hit, otherwise returns undefined | ||||||
|  */ |  */ | ||||||
| function restoreCache(paths, primaryKey, restoreKeys, options) { | function restoreCache(paths, primaryKey, restoreKeys, options, enableCrossOsArchive = false) { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         checkPaths(paths); |         checkPaths(paths); | ||||||
|         restoreKeys = restoreKeys || []; |         restoreKeys = restoreKeys || []; | ||||||
| @@ -47228,31 +47242,17 @@ function restoreCache(paths, primaryKey, restoreKeys, options) { | |||||||
|         for (const key of keys) { |         for (const key of keys) { | ||||||
|             checkKey(key); |             checkKey(key); | ||||||
|         } |         } | ||||||
|         let cacheEntry; |         const compressionMethod = yield utils.getCompressionMethod(); | ||||||
|         let compressionMethod = yield utils.getCompressionMethod(); |  | ||||||
|         let archivePath = ''; |         let archivePath = ''; | ||||||
|         try { |         try { | ||||||
|             // path are needed to compute version
 |             // path are needed to compute version
 | ||||||
|             cacheEntry = yield cacheHttpClient.getCacheEntry(keys, paths, { |             const cacheEntry = yield cacheHttpClient.getCacheEntry(keys, paths, { | ||||||
|                 compressionMethod |                 compressionMethod, | ||||||
|  |                 enableCrossOsArchive | ||||||
|             }); |             }); | ||||||
|             if (!(cacheEntry === null || cacheEntry === void 0 ? void 0 : cacheEntry.archiveLocation)) { |             if (!(cacheEntry === null || cacheEntry === void 0 ? void 0 : cacheEntry.archiveLocation)) { | ||||||
|                 // This is to support the old cache entry created by gzip on windows.
 |                 // Cache not found
 | ||||||
|                 if (process.platform === 'win32' && |                 return undefined; | ||||||
|                     compressionMethod !== constants_1.CompressionMethod.Gzip) { |  | ||||||
|                     compressionMethod = constants_1.CompressionMethod.Gzip; |  | ||||||
|                     cacheEntry = yield cacheHttpClient.getCacheEntry(keys, paths, { |  | ||||||
|                         compressionMethod |  | ||||||
|                     }); |  | ||||||
|                     if (!(cacheEntry === null || cacheEntry === void 0 ? void 0 : cacheEntry.archiveLocation)) { |  | ||||||
|                         return undefined; |  | ||||||
|                     } |  | ||||||
|                     core.info("Couldn't find cache entry with zstd compression, falling back to gzip compression."); |  | ||||||
|                 } |  | ||||||
|                 else { |  | ||||||
|                     // Cache not found
 |  | ||||||
|                     return undefined; |  | ||||||
|                 } |  | ||||||
|             } |             } | ||||||
|             archivePath = path.join(yield utils.createTempDirectory(), utils.getCacheFileName(compressionMethod)); |             archivePath = path.join(yield utils.createTempDirectory(), utils.getCacheFileName(compressionMethod)); | ||||||
|             core.debug(`Archive Path: ${archivePath}`); |             core.debug(`Archive Path: ${archivePath}`); | ||||||
| @@ -47295,10 +47295,11 @@ exports.restoreCache = restoreCache; | |||||||
|  * |  * | ||||||
|  * @param paths a list of file paths to be cached |  * @param paths a list of file paths to be cached | ||||||
|  * @param key an explicit key for restoring the cache |  * @param key an explicit key for restoring the cache | ||||||
|  |  * @param enableCrossOsArchive an optional boolean enabled to save cache on windows which could be restored on any platform | ||||||
|  * @param options cache upload options |  * @param options cache upload options | ||||||
|  * @returns number returns cacheId if the cache was saved successfully and throws an error if save fails |  * @returns number returns cacheId if the cache was saved successfully and throws an error if save fails | ||||||
|  */ |  */ | ||||||
| function saveCache(paths, key, options) { | function saveCache(paths, key, options, enableCrossOsArchive = false) { | ||||||
|     var _a, _b, _c, _d, _e; |     var _a, _b, _c, _d, _e; | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         checkPaths(paths); |         checkPaths(paths); | ||||||
| @@ -47329,6 +47330,7 @@ function saveCache(paths, key, options) { | |||||||
|             core.debug('Reserving Cache'); |             core.debug('Reserving Cache'); | ||||||
|             const reserveCacheResponse = yield cacheHttpClient.reserveCache(key, paths, { |             const reserveCacheResponse = yield cacheHttpClient.reserveCache(key, paths, { | ||||||
|                 compressionMethod, |                 compressionMethod, | ||||||
|  |                 enableCrossOsArchive, | ||||||
|                 cacheSize: archiveFileSize |                 cacheSize: archiveFileSize | ||||||
|             }); |             }); | ||||||
|             if ((_a = reserveCacheResponse === null || reserveCacheResponse === void 0 ? void 0 : reserveCacheResponse.result) === null || _a === void 0 ? void 0 : _a.cacheId) { |             if ((_a = reserveCacheResponse === null || reserveCacheResponse === void 0 ? void 0 : reserveCacheResponse.result) === null || _a === void 0 ? void 0 : _a.cacheId) { | ||||||
| @@ -50492,7 +50494,8 @@ function restoreImpl(stateProvider) { | |||||||
|             const cachePaths = utils.getInputAsArray(constants_1.Inputs.Path, { |             const cachePaths = utils.getInputAsArray(constants_1.Inputs.Path, { | ||||||
|                 required: true |                 required: true | ||||||
|             }); |             }); | ||||||
|             const cacheKey = yield cache.restoreCache(cachePaths, primaryKey, restoreKeys); |             const enableCrossOsArchive = utils.getInputAsBool(constants_1.Inputs.EnableCrossOsArchive); | ||||||
|  |             const cacheKey = yield cache.restoreCache(cachePaths, primaryKey, restoreKeys, {}, enableCrossOsArchive); | ||||||
|             if (!cacheKey) { |             if (!cacheKey) { | ||||||
|                 core.info(`Cache not found for input keys: ${[ |                 core.info(`Cache not found for input keys: ${[ | ||||||
|                     primaryKey, |                     primaryKey, | ||||||
|   | |||||||
							
								
								
									
										71
									
								
								dist/save-only/index.js
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										71
									
								
								dist/save-only/index.js
									
									
									
									
										vendored
									
									
								
							| @@ -3439,7 +3439,6 @@ const crypto = __importStar(__webpack_require__(417)); | |||||||
| const fs = __importStar(__webpack_require__(747)); | const fs = __importStar(__webpack_require__(747)); | ||||||
| const url_1 = __webpack_require__(835); | const url_1 = __webpack_require__(835); | ||||||
| const utils = __importStar(__webpack_require__(15)); | const utils = __importStar(__webpack_require__(15)); | ||||||
| const constants_1 = __webpack_require__(931); |  | ||||||
| const downloadUtils_1 = __webpack_require__(251); | const downloadUtils_1 = __webpack_require__(251); | ||||||
| const options_1 = __webpack_require__(538); | const options_1 = __webpack_require__(538); | ||||||
| const requestUtils_1 = __webpack_require__(899); | const requestUtils_1 = __webpack_require__(899); | ||||||
| @@ -3469,10 +3468,17 @@ function createHttpClient() { | |||||||
|     const bearerCredentialHandler = new auth_1.BearerCredentialHandler(token); |     const bearerCredentialHandler = new auth_1.BearerCredentialHandler(token); | ||||||
|     return new http_client_1.HttpClient('actions/cache', [bearerCredentialHandler], getRequestOptions()); |     return new http_client_1.HttpClient('actions/cache', [bearerCredentialHandler], getRequestOptions()); | ||||||
| } | } | ||||||
| function getCacheVersion(paths, compressionMethod) { | function getCacheVersion(paths, compressionMethod, enableCrossOsArchive = false) { | ||||||
|     const components = paths.concat(!compressionMethod || compressionMethod === constants_1.CompressionMethod.Gzip |     const components = paths; | ||||||
|         ? [] |     // Add compression method to cache version to restore
 | ||||||
|         : [compressionMethod]); |     // compressed cache as per compression method
 | ||||||
|  |     if (compressionMethod) { | ||||||
|  |         components.push(compressionMethod); | ||||||
|  |     } | ||||||
|  |     // Only check for windows platforms if enableCrossOsArchive is false
 | ||||||
|  |     if (process.platform === 'win32' && !enableCrossOsArchive) { | ||||||
|  |         components.push('windows-only'); | ||||||
|  |     } | ||||||
|     // Add salt to cache version to support breaking changes in cache entry
 |     // Add salt to cache version to support breaking changes in cache entry
 | ||||||
|     components.push(versionSalt); |     components.push(versionSalt); | ||||||
|     return crypto |     return crypto | ||||||
| @@ -3484,7 +3490,7 @@ exports.getCacheVersion = getCacheVersion; | |||||||
| function getCacheEntry(keys, paths, options) { | function getCacheEntry(keys, paths, options) { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         const httpClient = createHttpClient(); |         const httpClient = createHttpClient(); | ||||||
|         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod); |         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod, options === null || options === void 0 ? void 0 : options.enableCrossOsArchive); | ||||||
|         const resource = `cache?keys=${encodeURIComponent(keys.join(','))}&version=${version}`; |         const resource = `cache?keys=${encodeURIComponent(keys.join(','))}&version=${version}`; | ||||||
|         const response = yield requestUtils_1.retryTypedResponse('getCacheEntry', () => __awaiter(this, void 0, void 0, function* () { return httpClient.getJson(getCacheApiUrl(resource)); })); |         const response = yield requestUtils_1.retryTypedResponse('getCacheEntry', () => __awaiter(this, void 0, void 0, function* () { return httpClient.getJson(getCacheApiUrl(resource)); })); | ||||||
|         // Cache not found
 |         // Cache not found
 | ||||||
| @@ -3547,7 +3553,7 @@ exports.downloadCache = downloadCache; | |||||||
| function reserveCache(key, paths, options) { | function reserveCache(key, paths, options) { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         const httpClient = createHttpClient(); |         const httpClient = createHttpClient(); | ||||||
|         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod); |         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod, options === null || options === void 0 ? void 0 : options.enableCrossOsArchive); | ||||||
|         const reserveCacheRequest = { |         const reserveCacheRequest = { | ||||||
|             key, |             key, | ||||||
|             version, |             version, | ||||||
| @@ -5027,7 +5033,8 @@ var Inputs; | |||||||
|     Inputs["Key"] = "key"; |     Inputs["Key"] = "key"; | ||||||
|     Inputs["Path"] = "path"; |     Inputs["Path"] = "path"; | ||||||
|     Inputs["RestoreKeys"] = "restore-keys"; |     Inputs["RestoreKeys"] = "restore-keys"; | ||||||
|     Inputs["UploadChunkSize"] = "upload-chunk-size"; // Input for cache, save action
 |     Inputs["UploadChunkSize"] = "upload-chunk-size"; | ||||||
|  |     Inputs["EnableCrossOsArchive"] = "enableCrossOsArchive"; // Input for cache, restore, save action
 | ||||||
| })(Inputs = exports.Inputs || (exports.Inputs = {})); | })(Inputs = exports.Inputs || (exports.Inputs = {})); | ||||||
| var Outputs; | var Outputs; | ||||||
| (function (Outputs) { | (function (Outputs) { | ||||||
| @@ -38181,12 +38188,14 @@ var __importStar = (this && this.__importStar) || function (mod) { | |||||||
| }; | }; | ||||||
| Object.defineProperty(exports, "__esModule", { value: true }); | Object.defineProperty(exports, "__esModule", { value: true }); | ||||||
| const exec_1 = __webpack_require__(986); | const exec_1 = __webpack_require__(986); | ||||||
|  | const core_1 = __webpack_require__(470); | ||||||
| const io = __importStar(__webpack_require__(1)); | const io = __importStar(__webpack_require__(1)); | ||||||
| const fs_1 = __webpack_require__(747); | const fs_1 = __webpack_require__(747); | ||||||
| const path = __importStar(__webpack_require__(622)); | const path = __importStar(__webpack_require__(622)); | ||||||
| const utils = __importStar(__webpack_require__(15)); | const utils = __importStar(__webpack_require__(15)); | ||||||
| const constants_1 = __webpack_require__(931); | const constants_1 = __webpack_require__(931); | ||||||
| const IS_WINDOWS = process.platform === 'win32'; | const IS_WINDOWS = process.platform === 'win32'; | ||||||
|  | core_1.exportVariable('MSYS', 'winsymlinks:nativestrict'); | ||||||
| // Returns tar path and type: BSD or GNU
 | // Returns tar path and type: BSD or GNU
 | ||||||
| function getTarPath() { | function getTarPath() { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
| @@ -38644,7 +38653,7 @@ var __importStar = (this && this.__importStar) || function (mod) { | |||||||
|     return result; |     return result; | ||||||
| }; | }; | ||||||
| Object.defineProperty(exports, "__esModule", { value: true }); | Object.defineProperty(exports, "__esModule", { value: true }); | ||||||
| exports.isCacheFeatureAvailable = exports.getInputAsInt = exports.getInputAsArray = exports.isValidEvent = exports.logWarning = exports.isExactKeyMatch = exports.isGhes = void 0; | exports.isCacheFeatureAvailable = exports.getInputAsBool = exports.getInputAsInt = exports.getInputAsArray = exports.isValidEvent = exports.logWarning = exports.isExactKeyMatch = exports.isGhes = void 0; | ||||||
| const cache = __importStar(__webpack_require__(692)); | const cache = __importStar(__webpack_require__(692)); | ||||||
| const core = __importStar(__webpack_require__(470)); | const core = __importStar(__webpack_require__(470)); | ||||||
| const constants_1 = __webpack_require__(196); | const constants_1 = __webpack_require__(196); | ||||||
| @@ -38687,6 +38696,11 @@ function getInputAsInt(name, options) { | |||||||
|     return value; |     return value; | ||||||
| } | } | ||||||
| exports.getInputAsInt = getInputAsInt; | exports.getInputAsInt = getInputAsInt; | ||||||
|  | function getInputAsBool(name, options) { | ||||||
|  |     const result = core.getInput(name, options); | ||||||
|  |     return result.toLowerCase() === "true"; | ||||||
|  | } | ||||||
|  | exports.getInputAsBool = getInputAsBool; | ||||||
| function isCacheFeatureAvailable() { | function isCacheFeatureAvailable() { | ||||||
|     if (cache.isFeatureAvailable()) { |     if (cache.isFeatureAvailable()) { | ||||||
|         return true; |         return true; | ||||||
| @@ -41166,9 +41180,8 @@ function saveImpl(stateProvider) { | |||||||
|             const cachePaths = utils.getInputAsArray(constants_1.Inputs.Path, { |             const cachePaths = utils.getInputAsArray(constants_1.Inputs.Path, { | ||||||
|                 required: true |                 required: true | ||||||
|             }); |             }); | ||||||
|             cacheId = yield cache.saveCache(cachePaths, primaryKey, { |             const enableCrossOsArchive = utils.getInputAsBool(constants_1.Inputs.EnableCrossOsArchive); | ||||||
|                 uploadChunkSize: utils.getInputAsInt(constants_1.Inputs.UploadChunkSize) |             cacheId = yield cache.saveCache(cachePaths, primaryKey, { uploadChunkSize: utils.getInputAsInt(constants_1.Inputs.UploadChunkSize) }, enableCrossOsArchive); | ||||||
|             }); |  | ||||||
|             if (cacheId != -1) { |             if (cacheId != -1) { | ||||||
|                 core.info(`Cache saved with key: ${primaryKey}`); |                 core.info(`Cache saved with key: ${primaryKey}`); | ||||||
|             } |             } | ||||||
| @@ -47308,7 +47321,6 @@ const path = __importStar(__webpack_require__(622)); | |||||||
| const utils = __importStar(__webpack_require__(15)); | const utils = __importStar(__webpack_require__(15)); | ||||||
| const cacheHttpClient = __importStar(__webpack_require__(114)); | const cacheHttpClient = __importStar(__webpack_require__(114)); | ||||||
| const tar_1 = __webpack_require__(434); | const tar_1 = __webpack_require__(434); | ||||||
| const constants_1 = __webpack_require__(931); |  | ||||||
| class ValidationError extends Error { | class ValidationError extends Error { | ||||||
|     constructor(message) { |     constructor(message) { | ||||||
|         super(message); |         super(message); | ||||||
| @@ -47355,9 +47367,10 @@ exports.isFeatureAvailable = isFeatureAvailable; | |||||||
|  * @param primaryKey an explicit key for restoring the cache |  * @param primaryKey an explicit key for restoring the cache | ||||||
|  * @param restoreKeys an optional ordered list of keys to use for restoring the cache if no cache hit occurred for key |  * @param restoreKeys an optional ordered list of keys to use for restoring the cache if no cache hit occurred for key | ||||||
|  * @param downloadOptions cache download options |  * @param downloadOptions cache download options | ||||||
|  |  * @param enableCrossOsArchive an optional boolean enabled to restore on windows any cache created on any platform | ||||||
|  * @returns string returns the key for the cache hit, otherwise returns undefined |  * @returns string returns the key for the cache hit, otherwise returns undefined | ||||||
|  */ |  */ | ||||||
| function restoreCache(paths, primaryKey, restoreKeys, options) { | function restoreCache(paths, primaryKey, restoreKeys, options, enableCrossOsArchive = false) { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         checkPaths(paths); |         checkPaths(paths); | ||||||
|         restoreKeys = restoreKeys || []; |         restoreKeys = restoreKeys || []; | ||||||
| @@ -47370,31 +47383,17 @@ function restoreCache(paths, primaryKey, restoreKeys, options) { | |||||||
|         for (const key of keys) { |         for (const key of keys) { | ||||||
|             checkKey(key); |             checkKey(key); | ||||||
|         } |         } | ||||||
|         let cacheEntry; |         const compressionMethod = yield utils.getCompressionMethod(); | ||||||
|         let compressionMethod = yield utils.getCompressionMethod(); |  | ||||||
|         let archivePath = ''; |         let archivePath = ''; | ||||||
|         try { |         try { | ||||||
|             // path are needed to compute version
 |             // path are needed to compute version
 | ||||||
|             cacheEntry = yield cacheHttpClient.getCacheEntry(keys, paths, { |             const cacheEntry = yield cacheHttpClient.getCacheEntry(keys, paths, { | ||||||
|                 compressionMethod |                 compressionMethod, | ||||||
|  |                 enableCrossOsArchive | ||||||
|             }); |             }); | ||||||
|             if (!(cacheEntry === null || cacheEntry === void 0 ? void 0 : cacheEntry.archiveLocation)) { |             if (!(cacheEntry === null || cacheEntry === void 0 ? void 0 : cacheEntry.archiveLocation)) { | ||||||
|                 // This is to support the old cache entry created by gzip on windows.
 |                 // Cache not found
 | ||||||
|                 if (process.platform === 'win32' && |                 return undefined; | ||||||
|                     compressionMethod !== constants_1.CompressionMethod.Gzip) { |  | ||||||
|                     compressionMethod = constants_1.CompressionMethod.Gzip; |  | ||||||
|                     cacheEntry = yield cacheHttpClient.getCacheEntry(keys, paths, { |  | ||||||
|                         compressionMethod |  | ||||||
|                     }); |  | ||||||
|                     if (!(cacheEntry === null || cacheEntry === void 0 ? void 0 : cacheEntry.archiveLocation)) { |  | ||||||
|                         return undefined; |  | ||||||
|                     } |  | ||||||
|                     core.info("Couldn't find cache entry with zstd compression, falling back to gzip compression."); |  | ||||||
|                 } |  | ||||||
|                 else { |  | ||||||
|                     // Cache not found
 |  | ||||||
|                     return undefined; |  | ||||||
|                 } |  | ||||||
|             } |             } | ||||||
|             archivePath = path.join(yield utils.createTempDirectory(), utils.getCacheFileName(compressionMethod)); |             archivePath = path.join(yield utils.createTempDirectory(), utils.getCacheFileName(compressionMethod)); | ||||||
|             core.debug(`Archive Path: ${archivePath}`); |             core.debug(`Archive Path: ${archivePath}`); | ||||||
| @@ -47437,10 +47436,11 @@ exports.restoreCache = restoreCache; | |||||||
|  * |  * | ||||||
|  * @param paths a list of file paths to be cached |  * @param paths a list of file paths to be cached | ||||||
|  * @param key an explicit key for restoring the cache |  * @param key an explicit key for restoring the cache | ||||||
|  |  * @param enableCrossOsArchive an optional boolean enabled to save cache on windows which could be restored on any platform | ||||||
|  * @param options cache upload options |  * @param options cache upload options | ||||||
|  * @returns number returns cacheId if the cache was saved successfully and throws an error if save fails |  * @returns number returns cacheId if the cache was saved successfully and throws an error if save fails | ||||||
|  */ |  */ | ||||||
| function saveCache(paths, key, options) { | function saveCache(paths, key, options, enableCrossOsArchive = false) { | ||||||
|     var _a, _b, _c, _d, _e; |     var _a, _b, _c, _d, _e; | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         checkPaths(paths); |         checkPaths(paths); | ||||||
| @@ -47471,6 +47471,7 @@ function saveCache(paths, key, options) { | |||||||
|             core.debug('Reserving Cache'); |             core.debug('Reserving Cache'); | ||||||
|             const reserveCacheResponse = yield cacheHttpClient.reserveCache(key, paths, { |             const reserveCacheResponse = yield cacheHttpClient.reserveCache(key, paths, { | ||||||
|                 compressionMethod, |                 compressionMethod, | ||||||
|  |                 enableCrossOsArchive, | ||||||
|                 cacheSize: archiveFileSize |                 cacheSize: archiveFileSize | ||||||
|             }); |             }); | ||||||
|             if ((_a = reserveCacheResponse === null || reserveCacheResponse === void 0 ? void 0 : reserveCacheResponse.result) === null || _a === void 0 ? void 0 : _a.cacheId) { |             if ((_a = reserveCacheResponse === null || reserveCacheResponse === void 0 ? void 0 : reserveCacheResponse.result) === null || _a === void 0 ? void 0 : _a.cacheId) { | ||||||
|   | |||||||
							
								
								
									
										71
									
								
								dist/save/index.js
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										71
									
								
								dist/save/index.js
									
									
									
									
										vendored
									
									
								
							| @@ -3383,7 +3383,6 @@ const crypto = __importStar(__webpack_require__(417)); | |||||||
| const fs = __importStar(__webpack_require__(747)); | const fs = __importStar(__webpack_require__(747)); | ||||||
| const url_1 = __webpack_require__(835); | const url_1 = __webpack_require__(835); | ||||||
| const utils = __importStar(__webpack_require__(15)); | const utils = __importStar(__webpack_require__(15)); | ||||||
| const constants_1 = __webpack_require__(931); |  | ||||||
| const downloadUtils_1 = __webpack_require__(251); | const downloadUtils_1 = __webpack_require__(251); | ||||||
| const options_1 = __webpack_require__(538); | const options_1 = __webpack_require__(538); | ||||||
| const requestUtils_1 = __webpack_require__(899); | const requestUtils_1 = __webpack_require__(899); | ||||||
| @@ -3413,10 +3412,17 @@ function createHttpClient() { | |||||||
|     const bearerCredentialHandler = new auth_1.BearerCredentialHandler(token); |     const bearerCredentialHandler = new auth_1.BearerCredentialHandler(token); | ||||||
|     return new http_client_1.HttpClient('actions/cache', [bearerCredentialHandler], getRequestOptions()); |     return new http_client_1.HttpClient('actions/cache', [bearerCredentialHandler], getRequestOptions()); | ||||||
| } | } | ||||||
| function getCacheVersion(paths, compressionMethod) { | function getCacheVersion(paths, compressionMethod, enableCrossOsArchive = false) { | ||||||
|     const components = paths.concat(!compressionMethod || compressionMethod === constants_1.CompressionMethod.Gzip |     const components = paths; | ||||||
|         ? [] |     // Add compression method to cache version to restore
 | ||||||
|         : [compressionMethod]); |     // compressed cache as per compression method
 | ||||||
|  |     if (compressionMethod) { | ||||||
|  |         components.push(compressionMethod); | ||||||
|  |     } | ||||||
|  |     // Only check for windows platforms if enableCrossOsArchive is false
 | ||||||
|  |     if (process.platform === 'win32' && !enableCrossOsArchive) { | ||||||
|  |         components.push('windows-only'); | ||||||
|  |     } | ||||||
|     // Add salt to cache version to support breaking changes in cache entry
 |     // Add salt to cache version to support breaking changes in cache entry
 | ||||||
|     components.push(versionSalt); |     components.push(versionSalt); | ||||||
|     return crypto |     return crypto | ||||||
| @@ -3428,7 +3434,7 @@ exports.getCacheVersion = getCacheVersion; | |||||||
| function getCacheEntry(keys, paths, options) { | function getCacheEntry(keys, paths, options) { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         const httpClient = createHttpClient(); |         const httpClient = createHttpClient(); | ||||||
|         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod); |         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod, options === null || options === void 0 ? void 0 : options.enableCrossOsArchive); | ||||||
|         const resource = `cache?keys=${encodeURIComponent(keys.join(','))}&version=${version}`; |         const resource = `cache?keys=${encodeURIComponent(keys.join(','))}&version=${version}`; | ||||||
|         const response = yield requestUtils_1.retryTypedResponse('getCacheEntry', () => __awaiter(this, void 0, void 0, function* () { return httpClient.getJson(getCacheApiUrl(resource)); })); |         const response = yield requestUtils_1.retryTypedResponse('getCacheEntry', () => __awaiter(this, void 0, void 0, function* () { return httpClient.getJson(getCacheApiUrl(resource)); })); | ||||||
|         // Cache not found
 |         // Cache not found
 | ||||||
| @@ -3491,7 +3497,7 @@ exports.downloadCache = downloadCache; | |||||||
| function reserveCache(key, paths, options) { | function reserveCache(key, paths, options) { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         const httpClient = createHttpClient(); |         const httpClient = createHttpClient(); | ||||||
|         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod); |         const version = getCacheVersion(paths, options === null || options === void 0 ? void 0 : options.compressionMethod, options === null || options === void 0 ? void 0 : options.enableCrossOsArchive); | ||||||
|         const reserveCacheRequest = { |         const reserveCacheRequest = { | ||||||
|             key, |             key, | ||||||
|             version, |             version, | ||||||
| @@ -4971,7 +4977,8 @@ var Inputs; | |||||||
|     Inputs["Key"] = "key"; |     Inputs["Key"] = "key"; | ||||||
|     Inputs["Path"] = "path"; |     Inputs["Path"] = "path"; | ||||||
|     Inputs["RestoreKeys"] = "restore-keys"; |     Inputs["RestoreKeys"] = "restore-keys"; | ||||||
|     Inputs["UploadChunkSize"] = "upload-chunk-size"; // Input for cache, save action
 |     Inputs["UploadChunkSize"] = "upload-chunk-size"; | ||||||
|  |     Inputs["EnableCrossOsArchive"] = "enableCrossOsArchive"; // Input for cache, restore, save action
 | ||||||
| })(Inputs = exports.Inputs || (exports.Inputs = {})); | })(Inputs = exports.Inputs || (exports.Inputs = {})); | ||||||
| var Outputs; | var Outputs; | ||||||
| (function (Outputs) { | (function (Outputs) { | ||||||
| @@ -38125,12 +38132,14 @@ var __importStar = (this && this.__importStar) || function (mod) { | |||||||
| }; | }; | ||||||
| Object.defineProperty(exports, "__esModule", { value: true }); | Object.defineProperty(exports, "__esModule", { value: true }); | ||||||
| const exec_1 = __webpack_require__(986); | const exec_1 = __webpack_require__(986); | ||||||
|  | const core_1 = __webpack_require__(470); | ||||||
| const io = __importStar(__webpack_require__(1)); | const io = __importStar(__webpack_require__(1)); | ||||||
| const fs_1 = __webpack_require__(747); | const fs_1 = __webpack_require__(747); | ||||||
| const path = __importStar(__webpack_require__(622)); | const path = __importStar(__webpack_require__(622)); | ||||||
| const utils = __importStar(__webpack_require__(15)); | const utils = __importStar(__webpack_require__(15)); | ||||||
| const constants_1 = __webpack_require__(931); | const constants_1 = __webpack_require__(931); | ||||||
| const IS_WINDOWS = process.platform === 'win32'; | const IS_WINDOWS = process.platform === 'win32'; | ||||||
|  | core_1.exportVariable('MSYS', 'winsymlinks:nativestrict'); | ||||||
| // Returns tar path and type: BSD or GNU
 | // Returns tar path and type: BSD or GNU
 | ||||||
| function getTarPath() { | function getTarPath() { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
| @@ -38588,7 +38597,7 @@ var __importStar = (this && this.__importStar) || function (mod) { | |||||||
|     return result; |     return result; | ||||||
| }; | }; | ||||||
| Object.defineProperty(exports, "__esModule", { value: true }); | Object.defineProperty(exports, "__esModule", { value: true }); | ||||||
| exports.isCacheFeatureAvailable = exports.getInputAsInt = exports.getInputAsArray = exports.isValidEvent = exports.logWarning = exports.isExactKeyMatch = exports.isGhes = void 0; | exports.isCacheFeatureAvailable = exports.getInputAsBool = exports.getInputAsInt = exports.getInputAsArray = exports.isValidEvent = exports.logWarning = exports.isExactKeyMatch = exports.isGhes = void 0; | ||||||
| const cache = __importStar(__webpack_require__(692)); | const cache = __importStar(__webpack_require__(692)); | ||||||
| const core = __importStar(__webpack_require__(470)); | const core = __importStar(__webpack_require__(470)); | ||||||
| const constants_1 = __webpack_require__(196); | const constants_1 = __webpack_require__(196); | ||||||
| @@ -38631,6 +38640,11 @@ function getInputAsInt(name, options) { | |||||||
|     return value; |     return value; | ||||||
| } | } | ||||||
| exports.getInputAsInt = getInputAsInt; | exports.getInputAsInt = getInputAsInt; | ||||||
|  | function getInputAsBool(name, options) { | ||||||
|  |     const result = core.getInput(name, options); | ||||||
|  |     return result.toLowerCase() === "true"; | ||||||
|  | } | ||||||
|  | exports.getInputAsBool = getInputAsBool; | ||||||
| function isCacheFeatureAvailable() { | function isCacheFeatureAvailable() { | ||||||
|     if (cache.isFeatureAvailable()) { |     if (cache.isFeatureAvailable()) { | ||||||
|         return true; |         return true; | ||||||
| @@ -41110,9 +41124,8 @@ function saveImpl(stateProvider) { | |||||||
|             const cachePaths = utils.getInputAsArray(constants_1.Inputs.Path, { |             const cachePaths = utils.getInputAsArray(constants_1.Inputs.Path, { | ||||||
|                 required: true |                 required: true | ||||||
|             }); |             }); | ||||||
|             cacheId = yield cache.saveCache(cachePaths, primaryKey, { |             const enableCrossOsArchive = utils.getInputAsBool(constants_1.Inputs.EnableCrossOsArchive); | ||||||
|                 uploadChunkSize: utils.getInputAsInt(constants_1.Inputs.UploadChunkSize) |             cacheId = yield cache.saveCache(cachePaths, primaryKey, { uploadChunkSize: utils.getInputAsInt(constants_1.Inputs.UploadChunkSize) }, enableCrossOsArchive); | ||||||
|             }); |  | ||||||
|             if (cacheId != -1) { |             if (cacheId != -1) { | ||||||
|                 core.info(`Cache saved with key: ${primaryKey}`); |                 core.info(`Cache saved with key: ${primaryKey}`); | ||||||
|             } |             } | ||||||
| @@ -47281,7 +47294,6 @@ const path = __importStar(__webpack_require__(622)); | |||||||
| const utils = __importStar(__webpack_require__(15)); | const utils = __importStar(__webpack_require__(15)); | ||||||
| const cacheHttpClient = __importStar(__webpack_require__(114)); | const cacheHttpClient = __importStar(__webpack_require__(114)); | ||||||
| const tar_1 = __webpack_require__(434); | const tar_1 = __webpack_require__(434); | ||||||
| const constants_1 = __webpack_require__(931); |  | ||||||
| class ValidationError extends Error { | class ValidationError extends Error { | ||||||
|     constructor(message) { |     constructor(message) { | ||||||
|         super(message); |         super(message); | ||||||
| @@ -47328,9 +47340,10 @@ exports.isFeatureAvailable = isFeatureAvailable; | |||||||
|  * @param primaryKey an explicit key for restoring the cache |  * @param primaryKey an explicit key for restoring the cache | ||||||
|  * @param restoreKeys an optional ordered list of keys to use for restoring the cache if no cache hit occurred for key |  * @param restoreKeys an optional ordered list of keys to use for restoring the cache if no cache hit occurred for key | ||||||
|  * @param downloadOptions cache download options |  * @param downloadOptions cache download options | ||||||
|  |  * @param enableCrossOsArchive an optional boolean enabled to restore on windows any cache created on any platform | ||||||
|  * @returns string returns the key for the cache hit, otherwise returns undefined |  * @returns string returns the key for the cache hit, otherwise returns undefined | ||||||
|  */ |  */ | ||||||
| function restoreCache(paths, primaryKey, restoreKeys, options) { | function restoreCache(paths, primaryKey, restoreKeys, options, enableCrossOsArchive = false) { | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         checkPaths(paths); |         checkPaths(paths); | ||||||
|         restoreKeys = restoreKeys || []; |         restoreKeys = restoreKeys || []; | ||||||
| @@ -47343,31 +47356,17 @@ function restoreCache(paths, primaryKey, restoreKeys, options) { | |||||||
|         for (const key of keys) { |         for (const key of keys) { | ||||||
|             checkKey(key); |             checkKey(key); | ||||||
|         } |         } | ||||||
|         let cacheEntry; |         const compressionMethod = yield utils.getCompressionMethod(); | ||||||
|         let compressionMethod = yield utils.getCompressionMethod(); |  | ||||||
|         let archivePath = ''; |         let archivePath = ''; | ||||||
|         try { |         try { | ||||||
|             // path are needed to compute version
 |             // path are needed to compute version
 | ||||||
|             cacheEntry = yield cacheHttpClient.getCacheEntry(keys, paths, { |             const cacheEntry = yield cacheHttpClient.getCacheEntry(keys, paths, { | ||||||
|                 compressionMethod |                 compressionMethod, | ||||||
|  |                 enableCrossOsArchive | ||||||
|             }); |             }); | ||||||
|             if (!(cacheEntry === null || cacheEntry === void 0 ? void 0 : cacheEntry.archiveLocation)) { |             if (!(cacheEntry === null || cacheEntry === void 0 ? void 0 : cacheEntry.archiveLocation)) { | ||||||
|                 // This is to support the old cache entry created by gzip on windows.
 |                 // Cache not found
 | ||||||
|                 if (process.platform === 'win32' && |                 return undefined; | ||||||
|                     compressionMethod !== constants_1.CompressionMethod.Gzip) { |  | ||||||
|                     compressionMethod = constants_1.CompressionMethod.Gzip; |  | ||||||
|                     cacheEntry = yield cacheHttpClient.getCacheEntry(keys, paths, { |  | ||||||
|                         compressionMethod |  | ||||||
|                     }); |  | ||||||
|                     if (!(cacheEntry === null || cacheEntry === void 0 ? void 0 : cacheEntry.archiveLocation)) { |  | ||||||
|                         return undefined; |  | ||||||
|                     } |  | ||||||
|                     core.info("Couldn't find cache entry with zstd compression, falling back to gzip compression."); |  | ||||||
|                 } |  | ||||||
|                 else { |  | ||||||
|                     // Cache not found
 |  | ||||||
|                     return undefined; |  | ||||||
|                 } |  | ||||||
|             } |             } | ||||||
|             archivePath = path.join(yield utils.createTempDirectory(), utils.getCacheFileName(compressionMethod)); |             archivePath = path.join(yield utils.createTempDirectory(), utils.getCacheFileName(compressionMethod)); | ||||||
|             core.debug(`Archive Path: ${archivePath}`); |             core.debug(`Archive Path: ${archivePath}`); | ||||||
| @@ -47410,10 +47409,11 @@ exports.restoreCache = restoreCache; | |||||||
|  * |  * | ||||||
|  * @param paths a list of file paths to be cached |  * @param paths a list of file paths to be cached | ||||||
|  * @param key an explicit key for restoring the cache |  * @param key an explicit key for restoring the cache | ||||||
|  |  * @param enableCrossOsArchive an optional boolean enabled to save cache on windows which could be restored on any platform | ||||||
|  * @param options cache upload options |  * @param options cache upload options | ||||||
|  * @returns number returns cacheId if the cache was saved successfully and throws an error if save fails |  * @returns number returns cacheId if the cache was saved successfully and throws an error if save fails | ||||||
|  */ |  */ | ||||||
| function saveCache(paths, key, options) { | function saveCache(paths, key, options, enableCrossOsArchive = false) { | ||||||
|     var _a, _b, _c, _d, _e; |     var _a, _b, _c, _d, _e; | ||||||
|     return __awaiter(this, void 0, void 0, function* () { |     return __awaiter(this, void 0, void 0, function* () { | ||||||
|         checkPaths(paths); |         checkPaths(paths); | ||||||
| @@ -47444,6 +47444,7 @@ function saveCache(paths, key, options) { | |||||||
|             core.debug('Reserving Cache'); |             core.debug('Reserving Cache'); | ||||||
|             const reserveCacheResponse = yield cacheHttpClient.reserveCache(key, paths, { |             const reserveCacheResponse = yield cacheHttpClient.reserveCache(key, paths, { | ||||||
|                 compressionMethod, |                 compressionMethod, | ||||||
|  |                 enableCrossOsArchive, | ||||||
|                 cacheSize: archiveFileSize |                 cacheSize: archiveFileSize | ||||||
|             }); |             }); | ||||||
|             if ((_a = reserveCacheResponse === null || reserveCacheResponse === void 0 ? void 0 : reserveCacheResponse.result) === null || _a === void 0 ? void 0 : _a.cacheId) { |             if ((_a = reserveCacheResponse === null || reserveCacheResponse === void 0 ? void 0 : reserveCacheResponse.result) === null || _a === void 0 ? void 0 : _a.cacheId) { | ||||||
|   | |||||||
							
								
								
									
										16
									
								
								examples.md
									
									
									
									
									
								
							
							
						
						
									
										16
									
								
								examples.md
									
									
									
									
									
								
							| @@ -38,6 +38,7 @@ | |||||||
| - [Swift, Objective-C - Carthage](#swift-objective-c---carthage) | - [Swift, Objective-C - Carthage](#swift-objective-c---carthage) | ||||||
| - [Swift, Objective-C - CocoaPods](#swift-objective-c---cocoapods) | - [Swift, Objective-C - CocoaPods](#swift-objective-c---cocoapods) | ||||||
| - [Swift - Swift Package Manager](#swift---swift-package-manager) | - [Swift - Swift Package Manager](#swift---swift-package-manager) | ||||||
|  | - [Swift - Mint](#swift---mint) | ||||||
|  |  | ||||||
| ## C# - NuGet | ## C# - NuGet | ||||||
|  |  | ||||||
| @@ -641,3 +642,18 @@ whenever possible: | |||||||
|     restore-keys: | |     restore-keys: | | ||||||
|       ${{ runner.os }}-spm- |       ${{ runner.os }}-spm- | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
|  | ## Swift - Mint | ||||||
|  |  | ||||||
|  | ```yaml | ||||||
|  | env: | ||||||
|  |   MINT_PATH: .mint/lib | ||||||
|  |   MINT_LINK_PATH: .mint/bin | ||||||
|  | steps: | ||||||
|  |   - uses: actions/cache@v3 | ||||||
|  |     with: | ||||||
|  |       path: .mint | ||||||
|  |       key: ${{ runner.os }}-mint-${{ hashFiles('**/Mintfile') }} | ||||||
|  |       restore-keys: | | ||||||
|  |         ${{ runner.os }}-mint- | ||||||
|  | ``` | ||||||
|   | |||||||
							
								
								
									
										18
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										18
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							| @@ -1,15 +1,15 @@ | |||||||
| { | { | ||||||
|   "name": "cache", |   "name": "cache", | ||||||
|   "version": "3.2.1", |   "version": "3.2.2", | ||||||
|   "lockfileVersion": 2, |   "lockfileVersion": 2, | ||||||
|   "requires": true, |   "requires": true, | ||||||
|   "packages": { |   "packages": { | ||||||
|     "": { |     "": { | ||||||
|       "name": "cache", |       "name": "cache", | ||||||
|       "version": "3.2.1", |       "version": "3.2.2", | ||||||
|       "license": "MIT", |       "license": "MIT", | ||||||
|       "dependencies": { |       "dependencies": { | ||||||
|         "@actions/cache": "^3.1.0", |         "@actions/cache": "^3.1.2", | ||||||
|         "@actions/core": "^1.10.0", |         "@actions/core": "^1.10.0", | ||||||
|         "@actions/exec": "^1.1.1", |         "@actions/exec": "^1.1.1", | ||||||
|         "@actions/io": "^1.1.2" |         "@actions/io": "^1.1.2" | ||||||
| @@ -36,9 +36,9 @@ | |||||||
|       } |       } | ||||||
|     }, |     }, | ||||||
|     "node_modules/@actions/cache": { |     "node_modules/@actions/cache": { | ||||||
|       "version": "3.1.0", |       "version": "3.1.2", | ||||||
|       "resolved": "https://registry.npmjs.org/@actions/cache/-/cache-3.1.0.tgz", |       "resolved": "https://registry.npmjs.org/@actions/cache/-/cache-3.1.2.tgz", | ||||||
|       "integrity": "sha512-wKGJkpK3uFTgwy+KA0fxz0H3/ZPymdi0IlyhMmyoMeWd+CIv8xVPWdGlrPDDdN9bFgve2yvEPZVaKRb43Uwtyg==", |       "integrity": "sha512-3XeKcXIonfIbqvW7gPm/VLOhv1RHQ1dtTgSBCH6OUhCgSTii9bEVgu0PIms7UbLnXeMCKFzECfpbud8fJEvBbQ==", | ||||||
|       "dependencies": { |       "dependencies": { | ||||||
|         "@actions/core": "^1.10.0", |         "@actions/core": "^1.10.0", | ||||||
|         "@actions/exec": "^1.0.1", |         "@actions/exec": "^1.0.1", | ||||||
| @@ -9722,9 +9722,9 @@ | |||||||
|   }, |   }, | ||||||
|   "dependencies": { |   "dependencies": { | ||||||
|     "@actions/cache": { |     "@actions/cache": { | ||||||
|       "version": "3.1.0", |       "version": "3.1.2", | ||||||
|       "resolved": "https://registry.npmjs.org/@actions/cache/-/cache-3.1.0.tgz", |       "resolved": "https://registry.npmjs.org/@actions/cache/-/cache-3.1.2.tgz", | ||||||
|       "integrity": "sha512-wKGJkpK3uFTgwy+KA0fxz0H3/ZPymdi0IlyhMmyoMeWd+CIv8xVPWdGlrPDDdN9bFgve2yvEPZVaKRb43Uwtyg==", |       "integrity": "sha512-3XeKcXIonfIbqvW7gPm/VLOhv1RHQ1dtTgSBCH6OUhCgSTii9bEVgu0PIms7UbLnXeMCKFzECfpbud8fJEvBbQ==", | ||||||
|       "requires": { |       "requires": { | ||||||
|         "@actions/core": "^1.10.0", |         "@actions/core": "^1.10.0", | ||||||
|         "@actions/exec": "^1.0.1", |         "@actions/exec": "^1.0.1", | ||||||
|   | |||||||
| @@ -1,6 +1,6 @@ | |||||||
| { | { | ||||||
|   "name": "cache", |   "name": "cache", | ||||||
|   "version": "3.2.1", |   "version": "3.2.2", | ||||||
|   "private": true, |   "private": true, | ||||||
|   "description": "Cache dependencies and build outputs", |   "description": "Cache dependencies and build outputs", | ||||||
|   "main": "dist/restore/index.js", |   "main": "dist/restore/index.js", | ||||||
| @@ -23,7 +23,7 @@ | |||||||
|   "author": "GitHub", |   "author": "GitHub", | ||||||
|   "license": "MIT", |   "license": "MIT", | ||||||
|   "dependencies": { |   "dependencies": { | ||||||
|     "@actions/cache": "^3.1.0", |     "@actions/cache": "^3.1.2", | ||||||
|     "@actions/core": "^1.10.0", |     "@actions/core": "^1.10.0", | ||||||
|     "@actions/exec": "^1.1.1", |     "@actions/exec": "^1.1.1", | ||||||
|     "@actions/io": "^1.1.2" |     "@actions/io": "^1.1.2" | ||||||
|   | |||||||
| @@ -11,6 +11,10 @@ inputs: | |||||||
|   restore-keys: |   restore-keys: | ||||||
|     description: 'An ordered list of keys to use for restoring stale cache if no cache hit occurred for key. Note `cache-hit` returns false in this case.' |     description: 'An ordered list of keys to use for restoring stale cache if no cache hit occurred for key. Note `cache-hit` returns false in this case.' | ||||||
|     required: false |     required: false | ||||||
|  |   enableCrossOsArchive: | ||||||
|  |     description: 'An optional boolean when enabled, allows windows runners to restore caches that were saved on other platforms' | ||||||
|  |     default: 'false' | ||||||
|  |     required: false | ||||||
| outputs: | outputs: | ||||||
|   cache-hit: |   cache-hit: | ||||||
|     description: 'A boolean value to indicate an exact match was found for the primary key' |     description: 'A boolean value to indicate an exact match was found for the primary key' | ||||||
|   | |||||||
| @@ -11,6 +11,10 @@ inputs: | |||||||
|   upload-chunk-size: |   upload-chunk-size: | ||||||
|     description: 'The chunk size used to split up large files during upload, in bytes' |     description: 'The chunk size used to split up large files during upload, in bytes' | ||||||
|     required: false |     required: false | ||||||
|  |   enableCrossOsArchive: | ||||||
|  |     description: 'An optional boolean when enabled, allows windows runners to save caches that can be restored on other platforms' | ||||||
|  |     default: 'false' | ||||||
|  |     required: false | ||||||
| runs: | runs: | ||||||
|   using: 'node16' |   using: 'node16' | ||||||
|   main: '../dist/save-only/index.js' |   main: '../dist/save-only/index.js' | ||||||
|   | |||||||
| @@ -2,7 +2,8 @@ export enum Inputs { | |||||||
|     Key = "key", // Input for cache, restore, save action |     Key = "key", // Input for cache, restore, save action | ||||||
|     Path = "path", // Input for cache, restore, save action |     Path = "path", // Input for cache, restore, save action | ||||||
|     RestoreKeys = "restore-keys", // Input for cache, restore action |     RestoreKeys = "restore-keys", // Input for cache, restore action | ||||||
|     UploadChunkSize = "upload-chunk-size" // Input for cache, save action |     UploadChunkSize = "upload-chunk-size", // Input for cache, save action | ||||||
|  |     EnableCrossOsArchive = "enableCrossOsArchive" // Input for cache, restore, save action | ||||||
| } | } | ||||||
|  |  | ||||||
| export enum Outputs { | export enum Outputs { | ||||||
|   | |||||||
| @@ -31,11 +31,16 @@ async function restoreImpl( | |||||||
|         const cachePaths = utils.getInputAsArray(Inputs.Path, { |         const cachePaths = utils.getInputAsArray(Inputs.Path, { | ||||||
|             required: true |             required: true | ||||||
|         }); |         }); | ||||||
|  |         const enableCrossOsArchive = utils.getInputAsBool( | ||||||
|  |             Inputs.EnableCrossOsArchive | ||||||
|  |         ); | ||||||
|  |  | ||||||
|         const cacheKey = await cache.restoreCache( |         const cacheKey = await cache.restoreCache( | ||||||
|             cachePaths, |             cachePaths, | ||||||
|             primaryKey, |             primaryKey, | ||||||
|             restoreKeys |             restoreKeys, | ||||||
|  |             {}, | ||||||
|  |             enableCrossOsArchive | ||||||
|         ); |         ); | ||||||
|  |  | ||||||
|         if (!cacheKey) { |         if (!cacheKey) { | ||||||
|   | |||||||
| @@ -52,9 +52,16 @@ async function saveImpl(stateProvider: IStateProvider): Promise<number | void> { | |||||||
|             required: true |             required: true | ||||||
|         }); |         }); | ||||||
|  |  | ||||||
|         cacheId = await cache.saveCache(cachePaths, primaryKey, { |         const enableCrossOsArchive = utils.getInputAsBool( | ||||||
|             uploadChunkSize: utils.getInputAsInt(Inputs.UploadChunkSize) |             Inputs.EnableCrossOsArchive | ||||||
|         }); |         ); | ||||||
|  |  | ||||||
|  |         cacheId = await cache.saveCache( | ||||||
|  |             cachePaths, | ||||||
|  |             primaryKey, | ||||||
|  |             { uploadChunkSize: utils.getInputAsInt(Inputs.UploadChunkSize) }, | ||||||
|  |             enableCrossOsArchive | ||||||
|  |         ); | ||||||
|  |  | ||||||
|         if (cacheId != -1) { |         if (cacheId != -1) { | ||||||
|             core.info(`Cache saved with key: ${primaryKey}`); |             core.info(`Cache saved with key: ${primaryKey}`); | ||||||
|   | |||||||
| @@ -52,6 +52,14 @@ export function getInputAsInt( | |||||||
|     return value; |     return value; | ||||||
| } | } | ||||||
|  |  | ||||||
|  | export function getInputAsBool( | ||||||
|  |     name: string, | ||||||
|  |     options?: core.InputOptions | ||||||
|  | ): boolean { | ||||||
|  |     const result = core.getInput(name, options); | ||||||
|  |     return result.toLowerCase() === "true"; | ||||||
|  | } | ||||||
|  |  | ||||||
| export function isCacheFeatureAvailable(): boolean { | export function isCacheFeatureAvailable(): boolean { | ||||||
|     if (cache.isFeatureAvailable()) { |     if (cache.isFeatureAvailable()) { | ||||||
|         return true; |         return true; | ||||||
|   | |||||||
| @@ -13,6 +13,7 @@ interface CacheInput { | |||||||
|     path: string; |     path: string; | ||||||
|     key: string; |     key: string; | ||||||
|     restoreKeys?: string[]; |     restoreKeys?: string[]; | ||||||
|  |     enableCrossOsArchive?: boolean; | ||||||
| } | } | ||||||
|  |  | ||||||
| export function setInputs(input: CacheInput): void { | export function setInputs(input: CacheInput): void { | ||||||
| @@ -20,6 +21,11 @@ export function setInputs(input: CacheInput): void { | |||||||
|     setInput(Inputs.Key, input.key); |     setInput(Inputs.Key, input.key); | ||||||
|     input.restoreKeys && |     input.restoreKeys && | ||||||
|         setInput(Inputs.RestoreKeys, input.restoreKeys.join("\n")); |         setInput(Inputs.RestoreKeys, input.restoreKeys.join("\n")); | ||||||
|  |     input.enableCrossOsArchive !== undefined && | ||||||
|  |         setInput( | ||||||
|  |             Inputs.EnableCrossOsArchive, | ||||||
|  |             input.enableCrossOsArchive.toString() | ||||||
|  |         ); | ||||||
| } | } | ||||||
|  |  | ||||||
| export function clearInputs(): void { | export function clearInputs(): void { | ||||||
| @@ -27,4 +33,5 @@ export function clearInputs(): void { | |||||||
|     delete process.env[getInputName(Inputs.Key)]; |     delete process.env[getInputName(Inputs.Key)]; | ||||||
|     delete process.env[getInputName(Inputs.RestoreKeys)]; |     delete process.env[getInputName(Inputs.RestoreKeys)]; | ||||||
|     delete process.env[getInputName(Inputs.UploadChunkSize)]; |     delete process.env[getInputName(Inputs.UploadChunkSize)]; | ||||||
|  |     delete process.env[getInputName(Inputs.EnableCrossOsArchive)]; | ||||||
| } | } | ||||||
|   | |||||||
| @@ -19,6 +19,24 @@ A cache today is immutable and cannot be updated. But some use cases require the | |||||||
| ## Use cache across feature branches | ## Use cache across feature branches | ||||||
| Reusing cache across feature branches is not allowed today to provide cache [isolation](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache). However if both feature branches are from the default branch, a good way to achieve this is to ensure that the default branch has a cache. This cache will then be consumable by both feature branches. | Reusing cache across feature branches is not allowed today to provide cache [isolation](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache). However if both feature branches are from the default branch, a good way to achieve this is to ensure that the default branch has a cache. This cache will then be consumable by both feature branches. | ||||||
|  |  | ||||||
|  | ## Improving cache restore performance on Windows/Using cross-os caching | ||||||
|  | Currently, cache restore is slow on Windows due to tar being inherently slow and the compression algorithm `gzip` in use. `zstd` is the default algorithm in use on linux and macos. It was disabled on Windows due to issues with bsd tar(libarchive), the tar implementation in use on Windows.  | ||||||
|  |  | ||||||
|  | To improve cache restore performance, we can re-enable `zstd` as the compression algorithm using the following workaround. Add the following step to your workflow before the cache step: | ||||||
|  |  | ||||||
|  | ```yaml | ||||||
|  |     - if: ${{ runner.os == 'Windows' }} | ||||||
|  |       name: Use GNU tar | ||||||
|  |       shell: cmd | ||||||
|  |       run: | | ||||||
|  |         echo "Adding GNU tar to PATH" | ||||||
|  |         echo C:\Program Files\Git\usr\bin>>"%GITHUB_PATH%" | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | The `cache` action will use GNU tar instead of bsd tar on Windows. This should work on all Github Hosted runners as it is. For self-hosted runners, please ensure you have GNU tar and `zstd` installed. | ||||||
|  |  | ||||||
|  | The above workaround is also needed if you wish to use cross-os caching since difference of compression algorithms will result in different cache versions for the same cache key. So the above workaround will ensure `zstd` is used for caching on all platforms thus resulting in the same cache version for the same cache key. | ||||||
|  |  | ||||||
| ## Force deletion of caches overriding default cache eviction policy | ## Force deletion of caches overriding default cache eviction policy | ||||||
| Caches have [branch scope restriction](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache) in place. This means that if caches for a specific branch are using a lot of storage quota, it may result into more frequently used caches from `default` branch getting thrashed. For example, if there are many pull requests happening on a repo and are creating caches, these cannot be used in default branch scope but will still occupy a lot of space till they get cleaned up by [eviction policy](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy). But sometime we want to clean them up on a faster cadence so as to ensure default branch is not thrashing. In order to achieve this, [gh-actions-cache cli](https://github.com/actions/gh-actions-cache/) can be used to delete caches for specific branches. | Caches have [branch scope restriction](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache) in place. This means that if caches for a specific branch are using a lot of storage quota, it may result into more frequently used caches from `default` branch getting thrashed. For example, if there are many pull requests happening on a repo and are creating caches, these cannot be used in default branch scope but will still occupy a lot of space till they get cleaned up by [eviction policy](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy). But sometime we want to clean them up on a faster cadence so as to ensure default branch is not thrashing. In order to achieve this, [gh-actions-cache cli](https://github.com/actions/gh-actions-cache/) can be used to delete caches for specific branches. | ||||||
|  |  | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user