Cache GitHub Actions · artifacts · Turborepo

Η cache του CI σας, στον δικό σας λογαριασμό Cloudflare

Τα τυπικά actions/cache και upload-artifact περνούν από το CacheFlow χωρίς αλλαγές στα workflows, και η cache του Turborepo με ένα βήμα ρύθμισης. Προσθέστε μια πολιτική αξιόπιστων καταναλωτών και τα release jobs σας θα επαναφέρουν μόνο ό,τι παρήγαγε ένα αξιόπιστο build.

Μια cache που σας ανήκει, την εμπιστεύεστε και βλέπετε τι συμβαίνει μέσα της

Ιδιοκτησία

Ο λογαριασμός σας, τα bytes σας

Το CacheFlow εκτελείται στον λογαριασμό σας Cloudflare, οπότε τα bytes της cache και των artifacts δεν βρίσκονται ποτέ σε τρίτους και οι πόροι εμφανίζονται στον δικό σας λογαριασμό χρέωσης Cloudflare.

  • Τα bytes των artifacts στο R2, χωρίς χρεώσεις εξερχόμενης κίνησης
  • Η ιδιοκτησία των κλειδιών στο D1, μια γρήγορη διαδρομή ανάγνωσης στο KV, οι ενεργές συνεδρίες στα Durable Objects
  • Μία εγκατάσταση εξυπηρετεί την cache του Actions, τα artifacts του Actions και την απομακρυσμένη cache του Turborepo

Εμπιστοσύνη

Επαναφέρετε μόνο ό,τι αποθήκευσε ένα αξιόπιστο build

Οι εγγραφές που αποθηκεύονται με token OIDC του GitHub, όπως κάνουν τα CacheFlow actions, καταγράφουν το event, το ref, το commit και το workflow από τα οποία προήλθαν. Προσθέστε μια πολιτική αξιόπιστων καταναλωτών και τα release jobs σας θα επαναφέρουν μόνο εγγραφές που αποθήκευσε στο προστατευμένο branch σας ένα push, μια προγραμματισμένη ή μια χειροκίνητη εκτέλεση.

  • Μόνο βραχύβια διαπιστευτήρια: OIDC του GitHub για τα CacheFlow actions, το runtime token του ίδιου του GitHub για τα jobs με τα τυπικά actions
  • Κάθε branch γράφει μόνο στο δικό του πεδίο και διαβάζει μέσω του base branch του και του default branch
  • Στα jobs με OIDC, οι αποθηκεύσεις σε προστατευμένο branch από events που μπορούν να ενεργοποιήσουν τρίτοι, όπως το pull_request_target, τίθενται σε καραντίνα· τα jobs με τα τυπικά actions ακολουθούν την άδεια cache που δίνει το ίδιο το GitHub

Ορατότητα

Γνωρίστε το hit rate σας

Κάθε επαναφορά, αστοχία και αποθήκευση στην cache και στα artifacts του Actions καταγράφεται μαζί με τα bytes της, όπως και οι λήψεις και οι αποστολές του Turborepo, καθώς και το αν μια επαναφορά ταίριαξε με το ακριβές κλειδί της ή κατέφυγε σε ένα πρόθεμα.

  • Τα κλειδιά της cache του Actions και τα ονόματα των artifacts καταγράφονται μόνο ως keyed hash, ποτέ όπως γράφτηκαν
  • Οι συνεδρίες συγκεντρώνουν τις εγγραφές από παράλληλα matrix jobs και τις δεσμεύουν ατομικά
  • Οι ξεχασμένες συνεδρίες καθαρίζονται όταν τα builds ολοκληρώνονται ή λήγει ο χρόνος τους

Ξεκινήστε από εκεί που ήδη βρίσκεστε

Τέσσερις τρόποι να ξεκινήσετε, από μηδενικές αλλαγές έως πλήρη έλεγχο. Οι περισσότερες ομάδες ξεκινούν με τον πρώτο και δεν αγγίζουν ποτέ κανένα workflow.

  1. Μηδέν αλλαγές

    Κρατήστε τα workflows που ήδη έχετε

    Στρέψτε τους runners σας στο CacheFlow μία φορά. Τα τυπικά actions/cache, setup-node, Swatinem/rust-cache και upload-artifact αποθηκεύουν πλέον στην cache μέσω αυτού, χωρίς καμία αλλαγή. Σε runners που φιλοξενεί το GitHub, το ίδιο workflow επιστρέφει στην cache του 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. Ένα βήμα

    Σταματήστε να ξαναχτίζετε ό,τι έχει ήδη χτίσει το Turborepo

    Προσθέστε το setup-cacheflow και κάθε εργασία της οποίας οι είσοδοι δεν έχουν αλλάξει αναπαράγει τις εξόδους της αντί να εκτελεστεί ξανά — σε jobs, branches και repositories.

    Δείτε ολόκληρο το workflow ↓
  3. Για releases

    Κυκλοφορήστε μόνο ό,τι παρήγαγε ένα αξιόπιστο build

    Αποθηκεύστε τις caches release και deploy μέσω των CacheFlow actions. Κάθε εγγραφή καταγράφει το event, το ref, το commit και το workflow από τα οποία προήλθε. Προσθέστε μια πολιτική αξιόπιστων καταναλωτών και τα release jobs σας θα επαναφέρουν μόνο εγγραφές που αποθήκευσε στο προστατευμένο branch σας ένα push, μια προγραμματισμένη ή μια χειροκίνητη εκτέλεση.

    # 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. Κάθε εργαλείο

    Cache για οτιδήποτε από τη γραμμή εντολών

    Το cacheflow CLI και το Python SDK αποθηκεύουν και επαναφέρουν οποιοδήποτε artifact από οποιοδήποτε εργαλείο build. Οι συνεδρίες συγκεντρώνουν τις εγγραφές από παράλληλα matrix jobs και τις δεσμεύουν ατομικά, ώστε κανένα job να μην αντικαθιστά κάποιο άλλο.

    # 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 Turborepo σε ένα βήμα

Το setup-cacheflow εκδίδει ένα βραχύβιο διαπιστευτήριο OIDC και εξάγει τα TURBO_API, TURBO_TOKEN και TURBO_TEAM. Χωρίς αποθηκευμένα μυστικά:

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

Οι πρώτες ερωτήσεις που κάνουν οι ομάδες

Πρέπει να αλλάξουμε τα workflows μας;
Όχι για την cache και τα artifacts του Actions. Στρέψτε το περιβάλλον των runners σας στο CacheFlow μία φορά, και τα τυπικά actions/cache, setup-node, Swatinem/rust-cache και upload-artifact το χρησιμοποιούν χωρίς αλλαγές. Σε runners που φιλοξενεί το GitHub, τα ίδια workflows συνεχίζουν να χρησιμοποιούν την cache του GitHub. Η απομακρυσμένη cache του Turborepo απαιτεί ένα βήμα setup-cacheflow ανά workflow.
Πού βρίσκονται τα δεδομένα μας;
Στον λογαριασμό σας Cloudflare: τα bytes στο R2, η ιδιοκτησία των κλειδιών στο D1, μια διαδρομή ανάγνωσης στο KV και οι ενεργές συνεδρίες στα Durable Objects. Η τηλεμετρία καταγράφει τα κλειδιά της cache του Actions και τα ονόματα των artifacts μόνο ως keyed hash. Σχεδιάζουμε επίσης ένα διαχειριζόμενο πρόγραμμα, το οποίο θα λειτουργεί η CacheFlow για εσάς.
Πόσο κοστίζει;
Οι πόροι Cloudflare που χρησιμοποιεί το CacheFlow χρεώνονται στον δικό σας λογαριασμό Cloudflare, και το R2 δεν έχει χρεώσεις εξερχόμενης κίνησης. Θα μοιραστούμε την τιμολόγηση του ίδιου του CacheFlow με τις ομάδες πρώιμης πρόσβασης.
Είναι ταχύτερο από την cache του GitHub;
Δεν προβάλλουμε κανέναν ισχυρισμό για την ταχύτητα. Τα bytes έρχονται από το Cloudflare R2 μέσω του διαδικτύου, και δεν έχουμε μετρήσει κάποιο πλεονέκτημα στην ταχύτητα επαναφοράς. Αν χρειάζεστε μια cache δίπλα στον runner, η cache ενός παρόχου runners ίσως σας ταιριάζει καλύτερα.
Πώς πιστοποιούνται τα jobs;
Τα jobs που χρησιμοποιούν τα CacheFlow actions ή το setup-cacheflow ανταλλάσσουν ένα βραχύβιο token OIDC του GitHub. Τα jobs με τα τυπικά actions χρησιμοποιούν το runtime token που το GitHub ήδη δίνει σε κάθε job. Σε κάθε περίπτωση, κανένα μακρόβιο μυστικό δεν αποθηκεύεται στα pipelines σας. Άλλα συστήματα CI και οι φορητοί υπολογιστές των developers χρησιμοποιούν ένα token που εκδίδει ο διαχειριστής σας.
Μπορούμε να επιστρέψουμε σε ό,τι είχαμε;
Ναι. Το CacheFlow μιλά τα πρωτόκολλα που ήδη χρησιμοποιούν τα εργαλεία σας: τις υπηρεσίες cache και artifacts του Actions και την απομακρυσμένη cache του Turborepo. Αφαιρέστε τη ρύθμιση του runner ή το βήμα setup-cacheflow, και τα workflows σας επιστρέφουν στην cache που χρησιμοποιούσαν πριν.

Αποκτήστε πρώιμη πρόσβαση

Μπείτε στη λίστα αναμονής και θα επικοινωνήσουμε μόλις η ομάδα σας μπορεί να ξεκινήσει.