update examples.md for Bun v1.2 lockfile format #1605
+2
−2
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
Updated the action-cache examples in
examples.md
to reflect Bun v1.2’s switch from the binary lockfilebun.lockb
to the new text-basedbun.lock
.Note: If you’re on Bun < v1.2 you’ll need to continue caching the legacy bun.lockb file or bump your version to take advantage of the new format. Maybe that should be specified in the .md?
Motivation and Context
Bun v1.2 introduced a potentially breaking change in its default lockfile format. Workflows that look for the legacy lockfile bun.lockb could silently miss cache hits when running on Bun >= v1.2, leading to slower installs and unexpected rebuilds. This documentation update ensures that users following examples will cache and restore dependencies correctly on newer Bun versions.
How Has This Been Tested?
Not yet tested in CI — these changes are strictly to documentation.
Users should apply the updated examples to their workflows and verify that the cache key correctly picks up bun.lock (e.g. by inspecting the Actions “Cache hit” log).
Types of changes
Checklist: