Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update action.yml #1856

Merged
merged 1 commit into from
Dec 16, 2024
Merged

Update action.yml #1856

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,11 +428,9 @@ runs:
name: cache-save
if: ${{ always() && inputs.cache-dependencies == 'true' && steps.restore_cache.outputs.cache-hit != 'true' }}
with:
path: |
${{ steps.golang-env.outputs.build-cache-path }}
${{ steps.golang-env.outputs.module-cache-path }}
key: digger-cli-cache-${{ hashFiles('.digger.go.sum') }}

path: ${{ github.workspace }}/cache
key: digger-cache-${{ hashFiles('**/cache') }}
Comment on lines +431 to +432
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix cache key generation strategy

The current implementation has several issues:

  1. Using hashFiles('**/cache') creates a circular dependency where cache contents determine their own key
  2. This can lead to unnecessary cache misses and performance issues
  3. The save key doesn't match the restore key, which breaks cache consistency
-        key: digger-cache-${{ hashFiles('**/cache') }}
+        key: digger-cache-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('**/go.mod', '**/go.sum') }}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
path: ${{ github.workspace }}/cache
key: digger-cache-${{ hashFiles('**/cache') }}
path: ${{ github.workspace }}/cache
key: digger-cache-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('**/go.mod', '**/go.sum') }}

🛠️ Refactor suggestion

Improve cache key strategy to prevent collisions

The current cache key strategy might lead to cache collisions and staleness. Consider incorporating:

  • Workflow-specific identifiers
  • OS/architecture information
  • Dependency version hashes
-        key: digger-cache
-        restore-keys: |
-          digger-cache
+        key: digger-cache-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('**/go.mod', '**/go.sum') }}
+        restore-keys: |
+          digger-cache-${{ runner.os }}-${{ runner.arch }}-
+          digger-cache-${{ runner.os }}-

Committable suggestion skipped: line range outside the PR's diff.


branding:
icon: globe
color: purple
Loading