gitadmin/freeCodeCamp
1
0
Fork 0
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git synced 2026-05-28 18:26:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(turbo): try remote caching (#65692)

Browse Source
This commit is contained in:
Mrugesh Mohapatra
2026-02-04 13:17:02 +05:30
committed by GitHub
parent 72b22ae2bc
commit 632289c7f0
6 changed files with 131 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/actions/setup-turbo-cache/action.yml
+79
View File
@@ -0,0 +1,79 @@
# Caching Behaviour:
# ┌─────────────────────────┬─────────────────┬──────────────────┐
# │ Context │ Can Read Cache? │ Can Write Cache? │
# ├─────────────────────────┼─────────────────┼──────────────────┤
# │ main (push) │ YES │ YES │
# ├─────────────────────────┼─────────────────┼──────────────────┤
# │ renovate/* │ YES │ YES │
# ├─────────────────────────┼─────────────────┼──────────────────┤
# │ PRs / temp-* / hotfix-* │ YES │ NO │
# ├─────────────────────────┼─────────────────┼──────────────────┤
# │ prod-* │ NO │ NO │
# ├─────────────────────────┼─────────────────┼──────────────────┤
# │ Fork PRs │ NO │ NO │
# └─────────────────────────┴─────────────────┴──────────────────┘
name: 'Setup Turbo Remote Cache'
description: 'Conditionally configure Turbo remote cache based on branch and event context'
inputs:
turbo-token:
description: 'Turbo remote cache authentication token'
required: true
turbo-signature-key:
description: 'Turbo remote cache signature key for artifact signing/verification'
required: true
runs:
using: 'composite'
steps:
- name: Configure Turbo Remote Cache
shell: bash
env:
TURBO_TOKEN: ${{ inputs.turbo-token }}
TURBO_SIGNATURE_KEY: ${{ inputs.turbo-signature-key }}
GITHUB_REF_NAME: ${{ github.ref_name }}
GITHUB_EVENT_NAME: ${{ github.event_name }}
GITHUB_BASE_REF: ${{ github.base_ref }}
run: |
echo "::group::Turbo Cache Configuration"
echo "Branch: $GITHUB_REF_NAME"
echo "Event: $GITHUB_EVENT_NAME"
echo "Base ref: $GITHUB_BASE_REF"
# Skip for deployment branches (pure builds)
if [[ "$GITHUB_REF_NAME" == prod-* ]]; then
echo "::notice::Deployment branch detected - Turbo cache DISABLED for pure build"
echo "::endgroup::"
exit 0
fi
# Skip if secrets are not available (fork PRs)
if [[ -z "$TURBO_TOKEN" || -z "$TURBO_SIGNATURE_KEY" ]]; then
echo "::notice::Turbo secrets not available (likely a fork PR) - Turbo cache DISABLED"
echo "::endgroup::"
exit 0
fi
# Base configuration for all other contexts
echo "TURBO_API=https://turbo-cache.freecodecamp.net" >> $GITHUB_ENV
echo "TURBO_TEAM=team_freecodecamp" >> $GITHUB_ENV
echo "TURBO_TOKEN=$TURBO_TOKEN" >> $GITHUB_ENV
echo "TURBO_REMOTE_CACHE_SIGNATURE_KEY=$TURBO_SIGNATURE_KEY" >> $GITHUB_ENV
echo "TURBO_TELEMETRY_DISABLED=1" >> $GITHUB_ENV
# Determine if this context should have write access
# Write access: main branch push OR renovate branches
# Read-only: PRs and other branches (can read from cache, can't pollute it)
if [[ "$GITHUB_REF_NAME" == "main" && "$GITHUB_EVENT_NAME" == "push" ]]; then
echo "::notice::Main branch push - Turbo cache READ/WRITE enabled"
elif [[ "$GITHUB_REF_NAME" == renovate/* ]]; then
echo "::notice::Renovate branch - Turbo cache READ/WRITE enabled"
else
# All other contexts: read-only
# Use TURBO_CACHE=remote:r for read-only remote cache (local still read/write)
echo "TURBO_CACHE=local:rw,remote:r" >> $GITHUB_ENV
echo "::notice::PR/other branch - Turbo cache READ-ONLY enabled"
fi
echo "::endgroup::"
.github/workflows/curriculum-i18n-submodule.yml
+6
View File
@@ -44,6 +44,12 @@ jobs:
with:
run_install: false
- name: Setup Turbo Cache
uses: ./.github/actions/setup-turbo-cache
with:
turbo-token: ${{ secrets.TURBO_TOKEN }}
turbo-signature-key: ${{ secrets.TURBO_REMOTE_CACHE_SIGNATURE_KEY }}
- name: Set Environment variables
run: |
cp sample.env .env
.github/workflows/e2e-playwright.yml
+6
View File
@@ -40,6 +40,12 @@ jobs:
with:
run_install: false
- name: Setup Turbo Cache
uses: ./.github/actions/setup-turbo-cache
with:
turbo-token: ${{ secrets.TURBO_TOKEN }}
turbo-signature-key: ${{ secrets.TURBO_REMOTE_CACHE_SIGNATURE_KEY }}
- name: Checkout client-config
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
with:
.github/workflows/i18n-validate-builds.yml
+6
View File
@@ -33,6 +33,12 @@ jobs:
with:
run_install: false
- name: Setup Turbo Cache
uses: ./.github/actions/setup-turbo-cache
with:
turbo-token: ${{ secrets.TURBO_TOKEN }}
turbo-signature-key: ${{ secrets.TURBO_REMOTE_CACHE_SIGNATURE_KEY }}
- name: Set freeCodeCamp Environment Variables
run: |
cp sample.env .env
.github/workflows/node.js-tests.yml
+32
View File
@@ -6,6 +6,8 @@ on:
- 'main'
- 'prod-**'
- 'renovate/**'
- 'hotfix-**'
- 'temp-**'
pull_request:
branches:
- 'main'
@@ -54,6 +56,12 @@ jobs:
with:
run_install: false
- name: Setup Turbo Cache
uses: ./.github/actions/setup-turbo-cache
with:
turbo-token: ${{ secrets.TURBO_TOKEN }}
turbo-signature-key: ${{ secrets.TURBO_REMOTE_CACHE_SIGNATURE_KEY }}
- name: Set Environment variables
run: |
cp sample.env .env
@@ -100,6 +108,12 @@ jobs:
with:
run_install: false
- name: Setup Turbo Cache
uses: ./.github/actions/setup-turbo-cache
with:
turbo-token: ${{ secrets.TURBO_TOKEN }}
turbo-signature-key: ${{ secrets.TURBO_REMOTE_CACHE_SIGNATURE_KEY }}
- name: Set freeCodeCamp Environment Variables
run: |
cp sample.env .env
@@ -136,6 +150,12 @@ jobs:
with:
run_install: false
- name: Setup Turbo Cache
uses: ./.github/actions/setup-turbo-cache
with:
turbo-token: ${{ secrets.TURBO_TOKEN }}
turbo-signature-key: ${{ secrets.TURBO_REMOTE_CACHE_SIGNATURE_KEY }}
- name: Set Environment variables
run: |
cp sample.env .env
@@ -182,6 +202,12 @@ jobs:
with:
run_install: false
- name: Setup Turbo Cache
uses: ./.github/actions/setup-turbo-cache
with:
turbo-token: ${{ secrets.TURBO_TOKEN }}
turbo-signature-key: ${{ secrets.TURBO_REMOTE_CACHE_SIGNATURE_KEY }}
- name: Set Environment variables
run: |
cp sample.env .env
@@ -231,6 +257,12 @@ jobs:
with:
run_install: false
- name: Setup Turbo Cache
uses: ./.github/actions/setup-turbo-cache
with:
turbo-token: ${{ secrets.TURBO_TOKEN }}
turbo-signature-key: ${{ secrets.TURBO_REMOTE_CACHE_SIGNATURE_KEY }}
- name: Set Environment variables
run: |
cp sample.env .env
turbo.json
+2 -1
View File
@@ -11,5 +11,6 @@
"//#lint-root": {
"dependsOn": ["@freecodecamp/shared#build"]
}
}
},
"remoteCache": { "signature": true }
}