ci: cache embedded postgres downloaded binaries #18477
Open
+158
−10
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
This PR adds support for caching downloaded Embedded Postgres binaries by introducing a --cache flag in the helper script, updating CI workflows to populate and persist that cache across runs, and providing a composite action to upload the cache on main.
- Introduce
cachePathflag and default directory logic inmain.go - Update CI steps to create cache directories and pass
-cacheto the script - Add
embedded-pg-cachecomposite action for persisting the cache
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| scripts/embedded-pg/main.go | Added --cache flag, default cache directory, and MkdirAll |
| .github/workflows/ci.yaml | Created cache dirs, passed -cache flag, and invoked upload |
| .github/actions/embedded-pg-cache/action.yml | New composite action to save the cache via actions/cache |
Comments suppressed due to low confidence (5)
scripts/embedded-pg/main.go:17
- The new
--cacheflag should be documented in the project README or script usage section to ensure users know how to leverage caching.
flag.StringVar(&cachePath, "cache", "", "Optional custom path for embedded postgres binaries")
.github/workflows/ci.yaml:500
- [nitpick] This Windows-specific path is duplicated later; consider defining a variable for the cache path to reduce duplication and ease future updates.
mkdir -p "C:/temp/embedded-pg-cache"
.github/workflows/ci.yaml:500
mkdir -pmay not be available on Windows runners by default; ensure the shell supports this or use a PowerShell-native command likeNew-Item -ItemType Directory -Force.
mkdir -p "C:/temp/embedded-pg-cache"
scripts/embedded-pg/main.go:27
- New fallback logic for
cachePathisn't covered by existing tests; consider adding an integration test to verify caching behavior is applied correctly.
if cachePath == "" {
.github/actions/embedded-pg-cache/action.yml:15
- [nitpick] Pinning to a specific commit SHA can make upgrades harder; consider using the official version tag (
actions/cache@v4) instead of a commit hash.
uses: actions/cache/save@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
Co-authored-by: Copilot <[email protected]>
johnstcn
commented
Jun 20, 2025
hugodutka
reviewed
Jun 20, 2025
johnstcn
commented
Jun 23, 2025
| shell: bash | ||
| run: | | ||
| set -e | ||
| mkdir -p "$EMBEDDED_PG_CACHE_DIR" |
There was a problem hiding this comment.
This ends up being C:\actions-runner\_temp\embedded-pg-cache
johnstcn
commented
Jun 24, 2025
Comment on lines
+56
to
+71
| // Troubleshooting: list files in cachePath | ||
| if err := filepath.Walk(cachePath, func(path string, info os.FileInfo, err error) error { | ||
| if err != nil { | ||
| return err | ||
| } | ||
| switch { | ||
| case info.IsDir(): | ||
| log.Printf("D: %s", path) | ||
| case info.Mode().IsRegular(): | ||
| log.Printf("F: %s [%s] (%d bytes) %s", path, info.Mode().String(), info.Size(), info.ModTime().Format(time.RFC3339)) | ||
| default: | ||
| log.Printf("Other: %s [%s] %s", path, info.Mode(), info.ModTime().Format(time.RFC3339)) | ||
| } | ||
| return nil | ||
| }); err != nil { | ||
| log.Printf("Failed to list files in cachePath %s: %v", cachePath, err) |
There was a problem hiding this comment.
review: I think it makes sense to leave this in; I found it useful for troubleshooting before I knew about the wush trick.
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.
Fixes coder/internal#567
Embedded Postgres downloads binaries from
${REPO}/io/zonky/test/postgres/embedded-postgres-binaries-$OS-$ARCH/$VERSION/embedded-postgres-binaries-$OS-$ARCH-$VERSION.jartoCachePath:Example link for Darwin arm64: https://repo.maven.apache.org/maven2/io/zonky/test/postgres/embedded-postgres-binaries-darwin-arm64v8/16.4.0/
Making this a variable and adding it to be cached on merge to main.
Successful runs: