Cache do GitHub Actions · artefactos · Turborepo

A sua cache de CI, na sua própria conta Cloudflare

As ações padrão actions/cache e upload-artifact passam a usar a cache através do CacheFlow sem alterações aos workflows, e o Turborepo com um único passo de configuração. Adicione uma política de consumidores de confiança e os seus jobs de release restauram apenas o que uma build de confiança produziu.

Uma cache que é sua, em que confia e que consegue ver por dentro

É sua

A sua conta, os seus bytes

O CacheFlow corre na sua conta Cloudflare, por isso os bytes da cache e dos artefactos nunca ficam com terceiros e os recursos aparecem na sua própria fatura Cloudflare.

  • Bytes dos artefactos no R2, sem taxas de saída
  • Propriedade das chaves no D1, um caminho de leitura rápido no KV, sessões em curso nos Durable Objects
  • Uma única implementação serve a cache do Actions, os artefactos do Actions e a cache remota do Turborepo

Confie

Restaure apenas o que uma build de confiança guardou

As entradas guardadas com um token OIDC do GitHub, como fazem as ações do CacheFlow, registam o evento, a ref, o commit e o workflow que as originaram. Adicione uma política de consumidores de confiança e os seus jobs de release restauram apenas entradas que um push, uma execução agendada ou uma execução manual guardou no seu branch protegido.

  • Apenas credenciais de curta duração: OIDC do GitHub para as ações do CacheFlow e o token de runtime do próprio GitHub para os jobs com ações padrão
  • Cada branch escreve apenas no seu próprio âmbito e lê através do seu branch base e do branch predefinido
  • Nos jobs com OIDC, as gravações provenientes de eventos que pessoas externas podem desencadear num branch protegido, como pull_request_target, ficam em quarentena; os jobs com ações padrão seguem a permissão de cache concedida pelo próprio GitHub

Veja por dentro

Conheça a sua taxa de acertos

Cada restauro, falha e gravação da cache do Actions e dos artefactos fica registado com os seus bytes, tal como os downloads e uploads do Turborepo, incluindo se um restauro correspondeu à chave exata ou recorreu a um prefixo.

  • As chaves da cache do Actions e os nomes dos artefactos são registados apenas como um hash com chave, nunca tal como foram escritos
  • As sessões agrupam as escritas de jobs de matriz paralelos e confirmam-nas de forma atómica
  • As sessões obsoletas são limpas quando as builds terminam ou excedem o tempo limite

Comece onde já está

Quatro formas de começar, de zero alterações a controlo total. A maioria das equipas começa pela primeira e nunca chega a editar um workflow.

  1. Zero alterações

    Mantenha os workflows que já tem

    Aponte os seus runners para o CacheFlow uma única vez. As ações padrão actions/cache, setup-node, Swatinem/rust-cache e upload-artifact passam a usar a cache através dele, sem qualquer alteração. Nos runners alojados pelo GitHub, o mesmo workflow recorre à cache do 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. Um passo

    Deixe de reconstruir o que o Turborepo já construiu

    Adicione setup-cacheflow e cada tarefa cujas entradas não mudaram reproduz os seus resultados em vez de voltar a ser executada, entre jobs, branches e repositórios.

    Ver o workflow completo ↓
  3. Nível de release

    Publique apenas o que uma build de confiança produziu

    Guarde as caches de release e deploy através das ações do CacheFlow. Cada entrada regista o evento, a ref, o commit e o workflow que a originaram. Adicione uma política de consumidores de confiança e os seus jobs de release restauram apenas entradas que um push, uma execução agendada ou uma execução manual guardou no seu branch protegido.

    # 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. Qualquer ferramenta

    Coloque qualquer coisa em cache a partir da linha de comandos

    A cacheflow CLI e o Python SDK guardam e restauram qualquer artefacto de qualquer ferramenta de build. As sessões agrupam as escritas de jobs de matriz paralelos e confirmam-nas de forma atómica, para que nenhum job sobrescreva outro.

    # 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

Cache remota do Turborepo num só passo

O setup-cacheflow emite uma credencial OIDC de curta duração e exporta TURBO_API, TURBO_TOKEN e TURBO_TEAM. Sem segredos armazenados:

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

As primeiras perguntas das equipas

Temos de alterar os nossos workflows?
Não para a cache e os artefactos do Actions. Aponte o ambiente dos seus runners para o CacheFlow uma única vez, e as ações padrão actions/cache, setup-node, Swatinem/rust-cache e upload-artifact passam a usá-lo sem alterações. Nos runners alojados pelo GitHub, os mesmos workflows continuam a usar a cache do GitHub. A cache remota do Turborepo requer um passo setup-cacheflow por workflow.
Onde ficam os nossos dados?
Na sua conta Cloudflare: bytes no R2, propriedade das chaves no D1, um caminho de leitura no KV e sessões em curso nos Durable Objects. A telemetria regista as chaves da cache do Actions e os nomes dos artefactos apenas como um hash com chave. Estamos também a planear um plano gerido, operado pela CacheFlow por si.
Quanto custa?
Os recursos Cloudflare que o CacheFlow usa são faturados na sua própria conta Cloudflare, e o R2 não cobra taxas de saída. Partilharemos os preços do próprio CacheFlow com as equipas com acesso antecipado.
É mais rápido do que a cache do GitHub?
Não fazemos qualquer afirmação sobre velocidade. Os bytes vêm do Cloudflare R2 através da internet, e não medimos qualquer vantagem na velocidade de restauro. Se precisa de uma cache junto ao runner, a cache de um fornecedor de runners poderá servi-lo melhor.
Como se autenticam os jobs?
Os jobs que usam as ações do CacheFlow ou o setup-cacheflow trocam um token OIDC do GitHub de curta duração. Os jobs que usam diretamente as ações padrão utilizam o token de runtime que o GitHub já fornece a cada job. Em ambos os casos, nenhum segredo de longa duração fica armazenado nas suas pipelines. Outros sistemas de CI e os portáteis dos programadores usam um token emitido pelo seu operador.
Podemos voltar atrás?
Sim. O CacheFlow fala os protocolos que as suas ferramentas já usam: os serviços de cache e de artefactos do Actions e a cache remota do Turborepo. Remova a definição dos runners ou o passo setup-cacheflow, e os seus workflows voltam à cache que usavam antes.

Obtenha acesso antecipado

Entre na lista de espera e entraremos em contacto quando a sua equipa puder começar.