Cache GitHub Actions · artefakty · Turborepo

Vaša CI cache vo vašom vlastnom účte Cloudflare

Štandardné actions/cache a upload-artifact cachujú cez CacheFlow bez zmien workflow a Turborepo po jednom kroku nastavenia. Pridajte politiku dôveryhodných konzumentov a vaše release joby obnovia len to, čo vytvoril dôveryhodný build.

Cache, ktorú vlastníte, ktorej dôverujete a do ktorej vidíte

Vlastnite ju

Váš účet, vaše bajty

CacheFlow beží vo vašom účte Cloudflare, takže bajty cache a artefaktov nikdy neležia u tretej strany a prostriedky sa zobrazujú na vašom vlastnom vyúčtovaní Cloudflare.

  • Bajty artefaktov v R2, bez poplatkov za odchádzajúci prenos
  • Vlastníctvo kľúčov v D1, rýchla cesta na čítanie v KV, prebiehajúce relácie v Durable Objects
  • Jedno nasadenie obsluhuje cache Actions, artefakty Actions aj vzdialenú cache Turborepo

Dôverujte jej

Obnovujte len to, čo uložil dôveryhodný build

Záznamy uložené s tokenom GitHub OIDC, ako to robia akcie CacheFlow, uchovávajú udalosť, ref, commit a workflow, z ktorých pochádzajú. Pridajte politiku dôveryhodných konzumentov a vaše release joby obnovia len záznamy, ktoré na vašej chránenej vetve uložil push, plánované spustenie alebo manuálne spustenie.

  • Len krátkodobé poverenia: GitHub OIDC pre akcie CacheFlow, vlastný runtime token GitHubu pre drop-in joby
  • Každá vetva zapisuje len do vlastného rozsahu a číta cez svoju základnú a predvolenú vetvu
  • Pri joboch s OIDC idú do karantény uloženia na chránenú vetvu z udalostí, ktoré môžu spustiť ľudia zvonka, napríklad pull_request_target; drop-in joby sa riadia vlastným oprávnením GitHubu pre cache

Majte prehľad

Poznajte svoju mieru zásahov

Každá obnova, minutie a uloženie v cache Actions a pri artefaktoch sa zaznamenáva aj s počtom bajtov, rovnako ako sťahovania a nahrávania Turborepo, vrátane toho, či obnova zodpovedala presnému kľúču, alebo sa vrátila k prefixu.

  • Kľúče cache Actions a názvy artefaktov sa zaznamenávajú len ako hash s kľúčom, nikdy v pôvodnej podobe
  • Relácie zhromažďujú zápisy z paralelných matrix jobov a potvrdzujú ich atomicky
  • Neaktuálne relácie sa vyčistia, keď buildy skončia alebo vyprší ich časový limit

Začnite tam, kde už ste

Štyri cesty, od nulových zmien po plnú kontrolu. Väčšina tímov začne prvou a workflow už nikdy neupravuje.

  1. Nulové zmeny

    Ponechajte si workflow, ktoré už máte

    Raz nasmerujte svoje runnery na CacheFlow. Štandardné actions/cache, setup-node, Swatinem/rust-cache a upload-artifact potom bez úprav cachujú cezeň. Na runneroch hostovaných GitHubom sa ten istý workflow vráti k cache GitHubu.

    # runner environment: set once, per runner pool
    ACTIONS_RESULTS_URL=https://cache.cacheflow.sh/
    
    # your workflows: unchanged
    - uses: actions/cache@v4
    - uses: Swatinem/rust-cache@v2
    - uses: actions/upload-artifact@v4
  2. Jeden krok

    Prestaňte znova buildovať to, čo Turborepo už zbuildovalo

    Pridajte setup-cacheflow a každá úloha, ktorej vstupy sa nezmenili, namiesto opätovného spustenia prehrá svoje výstupy — naprieč jobmi, vetvami aj repozitármi.

    Pozrite si celý workflow ↓
  3. Pre release

    Nasadzujte len to, čo vytvoril dôveryhodný build

    Ukladajte release a deploy cache cez akcie CacheFlow. Každý záznam uchováva udalosť, ref, commit a workflow, z ktorých pochádza. Pridajte politiku dôveryhodných konzumentov a vaše release joby obnovia len záznamy, ktoré na vašej chránenej vetve uložil push, plánované spustenie alebo manuálne spustenie.

    # the job needs permissions: { contents: read, id-token: write }
    - uses: CaptainEmpower/cacheflow/.github/actions/cache/save@v1
      with:
        path: dist
        key: release-${{ github.sha }}
        cache-url: ${{ vars.CACHEFLOW_CACHE_URL }}
    
    # Rust: the rust-cache fork, same attestation
    - uses: CaptainEmpower/rust-cache@v2-cacheflow
      with:
        cache-provider: cacheflow
  4. Akýkoľvek nástroj

    Cachujte čokoľvek z príkazového riadka

    cacheflow CLI a Python SDK ukladajú a obnovujú akýkoľvek artefakt z akéhokoľvek build nástroja. Relácie zhromažďujú zápisy z paralelných matrix jobov a potvrdzujú ich atomicky, takže žiadny job neprepíše iný.

    # In a GitHub Actions step after setup-cacheflow, which exports
    # CACHEFLOW_CACHE_URL, CACHEFLOW_TOKEN, CACHEFLOW_TENANT,
    # CACHEFLOW_REPOSITORY and CACHEFLOW_BRANCH (export them yourself
    # elsewhere). GITHUB_SHA is set by Actions.
    cacheflow cache namespace ci-build   # idempotent
    SESSION=$(cacheflow session start --namespace ci-build)
    cacheflow cache put ci-build "dist-$GITHUB_SHA" dist.tar.gz \
      --session "$SESSION"
    cacheflow session commit --namespace ci-build \
      --session "$SESSION" --status success
    cacheflow cache get ci-build "dist-$GITHUB_SHA" --out dist.tar.gz

Vzdialená cache pre Turborepo v jednom kroku

setup-cacheflow vydá krátkodobé OIDC poverenie a exportuje TURBO_API, TURBO_TOKEN a TURBO_TEAM. Žiadne uložené tajomstvá:

permissions:
  contents: read
  id-token: write

jobs:
  build:
    runs-on: ${{ vars.CI_RUNNER_LARGE || vars.CI_RUNNER_DEFAULT }}
    steps:
      - uses: actions/checkout@v4
      # exports TURBO_API, TURBO_TOKEN and TURBO_TEAM
      - uses: CaptainEmpower/cacheflow/.github/actions/setup-cacheflow@v1
        with:
          api-url: ${{ vars.CACHEFLOW_TURBO_API }}
          install-cli: 'false'
      - run: pnpm install --frozen-lockfile
      - run: pnpm turbo run build

Na čo sa tímy pýtajú najskôr

Musíme meniť svoje workflow?
Pri cache Actions a artefaktoch nie. Raz nasmerujte prostredie svojich runnerov na CacheFlow a štandardné actions/cache, setup-node, Swatinem/rust-cache a upload-artifact ho budú používať bez úprav. Na runneroch hostovaných GitHubom budú tie isté workflow naďalej používať cache GitHubu. Vzdialená cache Turborepo vyžaduje jeden krok setup-cacheflow v každom workflow.
Kde sú uložené naše dáta?
Vo vašom účte Cloudflare: bajty v R2, vlastníctvo kľúčov v D1, cesta na čítanie v KV a prebiehajúce relácie v Durable Objects. Telemetria zaznamenáva kľúče cache Actions a názvy artefaktov len ako hash s kľúčom. Plánujeme aj spravovaný tarif, ktorý za vás bude prevádzkovať CacheFlow.
Koľko to stojí?
Prostriedky Cloudflare, ktoré CacheFlow používa, sa účtujú na váš vlastný účet Cloudflare a R2 neúčtuje žiadne poplatky za odchádzajúci prenos. Ceny samotného CacheFlow oznámime tímom so skorým prístupom.
Je rýchlejší ako cache GitHubu?
O rýchlosti nič netvrdíme. Bajty prichádzajú z Cloudflare R2 cez internet a prípadnú výhodu v rýchlosti obnovy sme nemerali. Ak potrebujete cache priamo vedľa runnera, môže vám lepšie vyhovovať cache od poskytovateľa runnerov.
Ako sa joby overujú?
Joby používajúce akcie CacheFlow alebo setup-cacheflow vymieňajú krátkodobý GitHub OIDC token. Drop-in joby na štandardných akciách používajú runtime token, ktorý GitHub už dáva každému jobu. V oboch prípadoch nie je vo vašich pipeline uložené žiadne dlhodobé tajomstvo. Iné CI systémy a vývojárske notebooky používajú token vydaný vaším operátorom.
Môžeme sa vrátiť späť?
Áno. CacheFlow používa protokoly, ktoré vaše nástroje už poznajú: služby cache a artefaktov Actions a vzdialenú cache Turborepo. Odstráňte nastavenie runnera alebo krok setup-cacheflow a vaše workflow sa vrátia k cache, ktorú používali predtým.

Získajte skorý prístup

Pridajte sa do poradovníka a ozveme sa, len čo bude váš tím môcť začať.