Cache GitHub Actions · artefakty · Turborepo

Vaše CI cache ve vašem vlastním účtu Cloudflare

Standardní actions/cache a upload-artifact cachují přes CacheFlow bez změn workflow a Turborepo po jednom kroku nastavení. Přidejte zásadu důvěryhodných konzumentů a vaše release joby obnoví jen to, co vytvořil důvěryhodný build.

Cache, kterou vlastníte, které důvěřujete a do které vidíte

Vlastněte ji

Váš účet, vaše bajty

CacheFlow běží ve vašem účtu Cloudflare, takže bajty cache a artefaktů nikdy neleží u třetí strany a prostředky se objevují na vašem vlastním vyúčtování Cloudflare.

  • Bajty artefaktů v R2, bez poplatků za odchozí přenos
  • Vlastnictví klíčů v D1, rychlá cesta pro čtení v KV, probíhající relace v Durable Objects
  • Jedno nasazení obsluhuje cache Actions, artefakty Actions i vzdálenou cache Turborepo

Důvěřujte jí

Obnovujte jen to, co uložil důvěryhodný build

Záznamy uložené s tokenem GitHub OIDC, jak to dělají CacheFlow actions, uchovávají událost, ref, commit a workflow, ze kterých vznikly. Přidejte zásadu důvěryhodných konzumentů a vaše release joby obnoví jen záznamy, které na vaší chráněné větvi uložil push, plánované spuštění nebo ruční spuštění.

  • Jen krátkodobé přihlašovací údaje: GitHub OIDC pro CacheFlow actions, vlastní runtime token GitHubu pro drop-in joby
  • Každá větev zapisuje jen do vlastního rozsahu a čte přes svou základní a výchozí větev
  • U jobů s OIDC jdou do karantény uložení na chráněnou větev z událostí, které mohou spustit lidé zvenčí, například pull_request_target; drop-in joby se řídí vlastním oprávněním GitHubu pro cache

Mějte přehled

Znejte svou míru zásahů

Každá obnova, minutí a uložení v cache Actions a u artefaktů se zaznamenává i s počtem bajtů, stejně jako stahování a nahrávání Turborepo, včetně toho, zda obnova odpovídala přesnému klíči, nebo se vrátila k prefixu.

  • Klíče cache Actions a názvy artefaktů se zaznamenávají jen jako hash s klíčem, nikdy v původní podobě
  • Relace bufferují zápisy z paralelních matrix jobů a commitují je atomicky
  • Neaktuální relace se uklidí, když buildy skončí nebo vyprší jejich časový limit

Začněte tam, kde už jste

Čtyři cesty, jak začít — od nulových změn po plnou kontrolu. Většina týmů začne tou první a workflow nikdy neupravuje.

  1. Bez změn

    Ponechte si workflow, která máte

    Jednou nasměrujte své runnery na CacheFlow. Standardní actions/cache, setup-node, Swatinem/rust-cache a upload-artifact pak cachují přes něj, beze změn. Na runnerech hostovaných GitHubem se stejné workflow vrátí 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

    Přestaňte znovu buildovat, co Turborepo už sestavilo

    Přidejte setup-cacheflow a každá úloha, jejíž vstupy se nezměnily, místo opětovného běhu přehraje své výstupy — napříč joby, větvemi i repozitáři.

    Zobrazit celé workflow ↓
  3. Pro release

    Vydávejte jen to, co vytvořil důvěryhodný build

    Ukládejte cache pro release a deploy přes CacheFlow actions. Každý záznam uchovává událost, ref, commit a workflow, ze kterých vznikl. Přidejte zásadu důvěryhodných konzumentů a vaše release joby obnoví jen záznamy, které na vaší chráněné větvi uložil push, plánované spuštění nebo ruční spuštění.

    # 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. Jakýkoli nástroj

    Cachujte cokoli z příkazové řádky

    cacheflow CLI a Python SDK ukládají a obnovují jakýkoli artefakt z jakéhokoli build nástroje. Relace bufferují zápisy z paralelních matrix jobů a commitují je atomicky, takže žádný job nepřepíše jiný.

    # 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

Vzdálená cache Turborepo v jednom kroku

setup-cacheflow vydá krátkodobý OIDC přihlašovací údaj a exportuje TURBO_API, TURBO_TOKEN a TURBO_TEAM. Žádná uložená tajemství:

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 co se týmy ptají nejdřív

Musíme měnit svá workflow?
U cache Actions a artefaktů ne. Jednou nasměrujte prostředí svých runnerů na CacheFlow a standardní actions/cache, setup-node, Swatinem/rust-cache a upload-artifact jej budou používat beze změn. Na runnerech hostovaných GitHubem budou stejná workflow dál používat cache GitHubu. Vzdálená cache Turborepo vyžaduje jeden krok setup-cacheflow v každém workflow.
Kde jsou naše data uložena?
Ve vašem účtu Cloudflare: bajty v R2, vlastnictví klíčů v D1, cesta pro čtení v KV a probíhající relace v Durable Objects. Telemetrie zaznamenává klíče cache Actions a názvy artefaktů jen jako hash s klíčem. Plánujeme také spravovaný tarif, který za vás bude provozovat CacheFlow.
Kolik to stojí?
Prostředky Cloudflare, které CacheFlow používá, se účtují na váš vlastní účet Cloudflare a R2 neúčtuje žádné poplatky za odchozí přenos. Ceny samotného CacheFlow sdělíme týmům s předběžným přístupem.
Je rychlejší než cache GitHubu?
O rychlosti nic netvrdíme. Bajty přicházejí z Cloudflare R2 přes internet a případnou výhodu v rychlosti obnovy jsme neměřili. Pokud potřebujete cache přímo vedle runneru, může vám lépe vyhovovat cache od poskytovatele runnerů.
Jak se joby ověřují?
Joby používající CacheFlow actions nebo setup-cacheflow vyměňují krátkodobý GitHub OIDC token. Drop-in joby na standardních actions používají runtime token, který GitHub už dává každému jobu. V obou případech není ve vašich pipeline uloženo žádné dlouhodobé tajemství. Jiné CI systémy a vývojářské notebooky používají token vydaný vaším operátorem.
Můžeme se vrátit zpět?
Ano. CacheFlow používá protokoly, které už vaše nástroje znají: služby cache a artefaktů Actions a vzdálenou cache Turborepo. Odeberte nastavení runneru nebo krok setup-cacheflow a vaše workflow se vrátí k cache, kterou používala dříve.

Získejte předběžný přístup

Přidejte se na pořadník a ozveme se, jakmile bude váš tým moci začít.