Skip to content

Update README to use go.mod rather than go.sum#719

Open
alnr wants to merge 1 commit intoactions:mainfrom
alnr:main
Open

Update README to use go.mod rather than go.sum#719
alnr wants to merge 1 commit intoactions:mainfrom
alnr:main

Conversation

@alnr
Copy link

@alnr alnr commented Feb 16, 2026

Description:
The README listed go.sum in several examples. This is misleading, as go.mod rather than go.sum is the correct file to use for computing a cache key.

See related issue+PR below for details.

Related issue:
#478
#705

Check list:

  • Mark if documentation changes are required.
  • Mark if tests were added or updated to cover the changes.

Copilot AI review requested due to automatic review settings February 16, 2026 14:18
@alnr alnr requested a review from a team as a code owner February 16, 2026 14:18
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request updates the README.md documentation to correctly reference go.mod instead of go.sum in cache dependency examples. This aligns with the v6 breaking change where the default cache key now uses go.mod files, as go.sum is an append-only checksum log rather than an accurate representation of module dependencies.

Changes:

  • Updated all cache dependency examples to use go.mod instead of go.sum
  • Changed glob pattern example from **/*.sum to **/*.mod
  • Updated comments and documentation to reflect the correct file type for caching

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants