Cache GitHub Actions · artefacts · Turborepo

Votre cache CI, dans votre propre compte Cloudflare

Les actions standard actions/cache et upload-artifact mettent en cache via CacheFlow sans aucune modification de vos workflows, et Turborepo en une seule étape de configuration. Ajoutez une politique de consommateurs de confiance, et vos jobs de release ne restaurent que ce qu'un build de confiance a produit.

Un cache qui vous appartient, fiable et transparent

Possédez-le

Votre compte, vos octets

CacheFlow s'exécute sur votre compte Cloudflare : les octets du cache et des artefacts ne sont jamais confiés à un tiers, et les ressources apparaissent sur votre propre facture Cloudflare.

  • Les octets des artefacts dans R2, sans frais de sortie
  • La propriété des clés dans D1, un chemin de lecture rapide dans KV, les sessions en cours dans les Durable Objects
  • Un seul déploiement sert le cache Actions, les artefacts Actions et le cache distant Turborepo

Faites-lui confiance

Ne restaurez que ce qu'un build de confiance a enregistré

Les entrées enregistrées avec un jeton GitHub OIDC, comme le font les actions CacheFlow, consignent l'événement, la ref, le commit et le workflow qui les ont produites. Ajoutez une politique de consommateurs de confiance, et vos jobs de release ne restaurent que les entrées qu'un push, une exécution planifiée ou une exécution manuelle a enregistrées sur votre branche protégée.

  • Uniquement des identifiants de courte durée : GitHub OIDC pour les actions CacheFlow, le jeton d'exécution propre à GitHub pour les jobs sur actions standard
  • Chaque branche n'écrit que dans son propre périmètre et lit via sa branche de base et la branche par défaut
  • Sur les jobs OIDC, les enregistrements issus d'événements que des personnes extérieures peuvent déclencher sur une branche protégée, comme pull_request_target, sont mis en quarantaine ; les jobs sur actions standard suivent l'autorisation de cache accordée par GitHub

Voyez-y clair

Connaissez votre taux de succès du cache

Chaque restauration, défaut de cache et enregistrement du cache Actions et des artefacts est consigné avec ses octets, tout comme les téléchargements et envois Turborepo, en précisant si une restauration a correspondu à sa clé exacte ou s'est rabattue sur un préfixe.

  • Les clés du cache Actions et les noms d'artefacts ne sont consignés que sous forme de hachage à clé, jamais tels qu'ils ont été écrits
  • Les sessions mettent en tampon les écritures des jobs de matrice parallèles et les valident de façon atomique
  • Les sessions obsolètes sont nettoyées lorsque les builds se terminent ou expirent

Partez de là où vous en êtes

Quatre points d'entrée, de zéro changement au contrôle total. La plupart des équipes commencent par le premier et ne modifient jamais un seul workflow.

  1. Zéro changement

    Gardez vos workflows actuels

    Pointez vos runners vers CacheFlow une seule fois. Les actions standard actions/cache, setup-node, Swatinem/rust-cache et upload-artifact passent alors par lui, sans aucune modification. Sur les runners hébergés par GitHub, le même workflow se rabat sur le cache de GitHub.

    # 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. Une étape

    Ne reconstruisez plus ce que Turborepo a déjà construit

    Ajoutez setup-cacheflow : chaque tâche dont les entrées n'ont pas changé rejoue ses sorties au lieu de s'exécuter à nouveau, entre jobs, branches et dépôts.

    Voir le workflow complet ↓
  3. Qualité release

    Ne livrez que ce qu'un build de confiance a produit

    Enregistrez les caches de release et de déploiement via les actions CacheFlow. Chaque entrée consigne l'événement, la ref, le commit et le workflow qui l'ont produite. Avec une politique de consommateurs de confiance, vos jobs de release ne restaurent que les entrées qu'un push, une exécution planifiée ou une exécution manuelle a enregistrées sur votre branche protégée.

    # 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. Tout outil

    Mettez n'importe quoi en cache depuis la ligne de commande

    La cacheflow CLI et le Python SDK enregistrent et restaurent n'importe quel artefact issu de n'importe quel outil de build. Les sessions mettent en tampon les écritures des jobs de matrice parallèles et les valident de façon atomique : aucun job n'écrase celui d'un autre.

    # 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

Le cache distant Turborepo en une étape

setup-cacheflow génère un identifiant OIDC de courte durée et exporte TURBO_API, TURBO_TOKEN et TURBO_TEAM. Aucun secret stocké :

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

Les questions que les équipes posent en premier

Devons-nous modifier nos workflows ?
Pas pour le cache et les artefacts Actions. Pointez une seule fois l'environnement de vos runners vers CacheFlow, et les actions standard actions/cache, setup-node, Swatinem/rust-cache et upload-artifact l'utilisent sans modification. Sur les runners hébergés par GitHub, les mêmes workflows continuent d'utiliser le cache de GitHub. Le cache distant Turborepo nécessite une étape setup-cacheflow par workflow.
Où se trouvent nos données ?
Dans votre compte Cloudflare : les octets dans R2, la propriété des clés dans D1, un chemin de lecture dans KV et les sessions en cours dans les Durable Objects. La télémétrie ne consigne les clés du cache Actions et les noms d'artefacts que sous forme de hachage à clé. Nous prévoyons aussi une offre gérée, exploitée pour vous par CacheFlow.
Combien ça coûte ?
Les ressources Cloudflare qu'utilise CacheFlow sont facturées sur votre propre compte Cloudflare, et R2 ne facture pas de frais de sortie. Nous communiquerons la tarification de CacheFlow lui-même aux équipes en accès anticipé.
Est-ce plus rapide que le cache de GitHub ?
Nous n'avançons aucune affirmation sur la vitesse. Les octets proviennent de Cloudflare R2 via Internet, et nous n'avons pas mesuré d'avantage en vitesse de restauration. Si vous avez besoin d'un cache situé à côté du runner, le cache d'un fournisseur de runners vous conviendra peut-être mieux.
Comment les jobs s'authentifient-ils ?
Les jobs qui utilisent les actions CacheFlow ou setup-cacheflow échangent un jeton GitHub OIDC de courte durée. Les jobs qui utilisent directement les actions standard se servent du jeton d'exécution que GitHub fournit déjà à chaque job. Dans les deux cas, aucun secret de longue durée n'est stocké dans vos pipelines. Les autres systèmes de CI et les ordinateurs portables des développeurs utilisent un jeton émis par votre opérateur.
Pouvons-nous revenir en arrière ?
Oui. CacheFlow parle les protocoles que vos outils utilisent déjà : les services de cache et d'artefacts Actions et le cache distant Turborepo. Supprimez le réglage des runners ou l'étape setup-cacheflow, et vos workflows reviennent au cache qu'ils utilisaient auparavant.

Obtenez un accès anticipé

Rejoignez la liste d'attente et nous vous contacterons dès que votre équipe pourra démarrer.