Enable Bazel GCS remote cache for CI #101
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| name: 'Configure Bazel Cache' | ||
| description: 'Set up GCS remote cache and optional disk cache for Bazel builds' | ||
|
|
||
| inputs: | ||
| gcp_project_id: | ||
| description: 'GCP project ID' | ||
| required: true | ||
| workload_identity_provider: | ||
| description: 'Full workload identity provider resource name' | ||
| required: true | ||
| service_account: | ||
| description: 'GCP service account email' | ||
| required: true | ||
| cache_bucket: | ||
| description: 'GCS bucket name for remote cache' | ||
| required: true | ||
| cache_key: | ||
| description: 'Cache key prefix for disk cache via actions/cache. Omit to skip disk cache.' | ||
| required: false | ||
| default: '' | ||
|
|
||
| runs: | ||
| using: 'composite' | ||
| steps: | ||
| - name: Authenticate to Google Cloud | ||
| id: auth | ||
| continue-on-error: true | ||
| uses: google-github-actions/auth@v2 | ||
| with: | ||
| project_id: ${{ inputs.gcp_project_id }} | ||
| workload_identity_provider: ${{ inputs.workload_identity_provider }} | ||
| service_account: ${{ inputs.service_account }} | ||
| token_format: 'access_token' | ||
|
|
||
| - name: Configure Bazel remote cache | ||
| shell: bash | ||
| env: | ||
| AUTH_OUTCOME: ${{ steps.auth.outcome }} | ||
| CACHE_BUCKET: ${{ inputs.cache_bucket }} | ||
| ACCESS_TOKEN: ${{ steps.auth.outputs.access_token }} | ||
| EVENT_NAME: ${{ github.event_name }} | ||
| run: | | ||
| # Always write config=ci for non-remote flags (circuit breaker, etc.) | ||
| echo "build --config=ci" >> .bazelrc.local | ||
|
|
||
| # Write cache config to a job-specific file. Bootstrapped projects | ||
| # (e.g. /tmp/valdi_app) import this via try-import in ~/.bazelrc, | ||
| # avoiding races when concurrent jobs share a runner. | ||
| CACHE_RC="/tmp/bazelrc-cache-${GITHUB_RUN_ID}-${GITHUB_JOB}" | ||
| > "$CACHE_RC" | ||
| echo "BAZEL_CACHE_RC=$CACHE_RC" >> "$GITHUB_ENV" | ||
|
|
||
| if [ "$AUTH_OUTCOME" != "success" ]; then | ||
| echo "Auth skipped (expected for fork PRs). Building without remote cache." | ||
| exit 0 | ||
| fi | ||
|
|
||
| # Checkout directory config | ||
| echo "build --remote_cache=https://storage.googleapis.com/$CACHE_BUCKET" >> .bazelrc.local | ||
| echo "build \"--remote_header=Authorization=Bearer $ACCESS_TOKEN\"" >> .bazelrc.local | ||
| # Only upload cache results on push (trusted) events, not pull requests | ||
| if [ "$EVENT_NAME" = "push" ] || [ "$EVENT_NAME" = "workflow_dispatch" ] || [ "$EVENT_NAME" = "release" ]; then | ||
| echo "build --remote_upload_local_results=true" >> .bazelrc.local | ||
| else | ||
| echo "build --remote_upload_local_results=false" >> .bazelrc.local | ||
| fi | ||
|
|
||
| # Point ~/.bazelrc to the job-specific file via try-import. | ||
| # Single atomic write — no truncation window for concurrent jobs. | ||
| echo "try-import $CACHE_RC" > ~/.bazelrc | ||
|
|
||
| # Cache config for bootstrapped projects (discovered via try-import above) | ||
| echo "build --remote_cache=https://storage.googleapis.com/$CACHE_BUCKET" >> "$CACHE_RC" | ||
| echo "build \"--remote_header=Authorization=Bearer $ACCESS_TOKEN\"" >> "$CACHE_RC" | ||
| echo "build --experimental_circuit_breaker_strategy=failure" >> "$CACHE_RC" | ||
| if [ "$EVENT_NAME" = "push" ] || [ "$EVENT_NAME" = "workflow_dispatch" ] || [ "$EVENT_NAME" = "release" ]; then | ||
| echo "build --remote_upload_local_results=true" >> "$CACHE_RC" | ||
| else | ||
| echo "build --remote_upload_local_results=false" >> "$CACHE_RC" | ||
| fi | ||
|
|
||
|
Comment on lines
+42
to
+81
There was a problem hiding this comment.
🎉 Fixed in commit 8f6fb87 🎉
Comment on lines
+42
to
+81
There was a problem hiding this comment.
🌟 Fixed in commit a2e080d 🌟
Comment on lines
+42
to
+81
There was a problem hiding this comment.
🚀 Fixed in commit 5049f9b 🚀 |
||
| - name: Prune and configure disk cache | ||
| if: inputs.cache_key != '' | ||
| shell: bash | ||
| run: | | ||
| # Prune old cache files to prevent unbounded growth on persistent runners | ||
| find "$HOME/.cache/bazel/disk" -type f -atime +7 -delete 2>/dev/null || true | ||
| find "$HOME/.cache/bazel/repo" -type f -atime +7 -delete 2>/dev/null || true | ||
|
|
||
| echo "build:ci --disk_cache=$HOME/.cache/bazel/disk" >> .bazelrc.local | ||
| echo "build:ci --repository_cache=$HOME/.cache/bazel/repo" >> .bazelrc.local | ||
| if [ -n "$BAZEL_CACHE_RC" ]; then | ||
| echo "build --disk_cache=$HOME/.cache/bazel/disk" >> "$BAZEL_CACHE_RC" | ||
| echo "build --repository_cache=$HOME/.cache/bazel/repo" >> "$BAZEL_CACHE_RC" | ||
| fi | ||
|
|
||
| - name: Mount Bazel cache | ||
| if: inputs.cache_key != '' && runner.environment == 'github-hosted' | ||
| uses: actions/cache@v4 | ||
| continue-on-error: true | ||
| with: | ||
| path: | | ||
| ~/.cache/bazel/disk | ||
| ~/.cache/bazel/repo | ||
| ~/.cache/bazelisk | ||
| key: bazel-${{ runner.os }}-${{ inputs.cache_key }}-${{ hashFiles('MODULE.bazel', '**/*.bzl') }}-${{ github.run_id }} | ||
| restore-keys: | | ||
| bazel-${{ runner.os }}-${{ inputs.cache_key }}-${{ hashFiles('MODULE.bazel', '**/*.bzl') }}- | ||
| bazel-${{ runner.os }}-${{ inputs.cache_key }}- | ||
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
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
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using variable interpolation${{...}}withgithubcontext data in arun:step could allow an attacker to inject their own code into the runner. This would allow them to steal secrets and code.githubcontext data can have arbitrary user input and should be treated as untrusted. Instead, use an intermediate environment variable withenv:to store the data and use the environment variable in therun:script. Be sure to use double-quotes the environment variable, like this: "$ENVVAR".🎈 Fixed in commit c81d9c7 🎈