Add overwrite input to optionally allow copying over existing dependency files from non-root directories #1148
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
Implements an optional overwrite flag to control copying of cache dependency files, preventing accidental overwrites of existing workspace files.
- Introduce
overwriteboolean input in core logic to skip or force copy based on existing targets - Update
action.ymland docs to expose and explain the newoverwritesetting - Extend test suite to cover overwrite-true, overwrite-false, and warning scenarios
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/setup-python.ts | Added overwrite input handling and adjusted copy logic and logs |
| action.yml | Defined new overwrite input with default and description |
| docs/advanced-usage.md | Documented overwrite behavior in advanced usage guide |
| tests/setup-python.test.ts | Added tests for overwrite, skip, and warning behaviors |
Comments suppressed due to low confidence (2)
tests/setup-python.test.ts:44
- None of the new tests assert that
cacheDistributor.restoreCache()is called. Consider addingexpect(mockRestoreCache).toHaveBeenCalled();in each test to ensure the cache restore logic still executes.
it('copies the file if source exists and target does not', async () => {
tests/setup-python.test.ts:149
- The test for when source and target are the same path no longer checks the resolved path log. Add an assertion for
Resolved cache-dependency-pathto cover theresolvedDependencyPathlogging branch.
);
| @@ -26,7 +26,8 @@ export async function cacheDependencies(cache: string, pythonVersion: string) { | |||
| const cacheDependencyPath = | |||
| core.getInput('cache-dependency-path') || undefined; | |||
| let resolvedDependencyPath: string | undefined = undefined; | |||
|
|
|||
| const overwrite = | |||
| core.getBooleanInput('overwrite', {required: false}) ?? false; | |||
There was a problem hiding this comment.
[nitpick] The nullish coalescing (?? false) is redundant because getBooleanInput always returns a boolean when required: false. You can simplify to const overwrite = core.getBooleanInput('overwrite', {required: false});.
Suggested change
| core.getBooleanInput('overwrite', {required: false}) ?? false; | |
| core.getBooleanInput('overwrite', {required: false}); |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Adds an overwrite input to prevent unintended overwrites when a composite action defines a cache-dependency-path (e.g., subdir/requirements.txt) that matches a file in the user’s workspace. By default, the copy is skipped if the target file exists, unless overwrite: true is explicitly set. This avoids silently replacing user files with the same name and path structure.
Check list: