CI/CD
GitHub Actionsi vahemälu: kuidas see töötab ja mida see peidab
GitHub Actionsi vahemälu hoiab faile töövoo käivituste vahel, nii et tööd jätavad vahele allalaadimised, mis on juba tehtud. See teeb buildid kiiremaks. See tähendab ka, et paketid jõuavad teie buildi ilma allalaadimiseta, ja enamik buildi kirjeid ei näe seda kunagi.
Uuendatud
Kuidas vahemälu töötab
actions/cache action salvestab töö lõpus hulga radu võtme alla ja taastab need hilisema töö alguses.
Tüüpiline npm-i seadistus salvestab paketihalduri allalaadimisvahemälu ja moodustab võtme lukufailist (lockfile):
- uses: actions/cache@v4
with:
path: ~/.npm
key: npm-${{ runner.os }}-${{ hashFiles('package-lock.json') }}
restore-keys: |
npm-${{ runner.os }}-
- run: npm ci
Taastamisel otsib action kõigepealt täpset vastet võtmele key, seejärel osalist vastet ja siis järjest
iga restore-keys eesliidet. Kui eesliitele vastab mitu vahemälu, taastab see kõige hiljuti loodu. See
varuvariant hoiab buildid kiirena ka pärast lukufaili muutumist ja tähendab ka seda, et töö võib alustada
vahemälust, mis loodi vanema lukufaili jaoks.
Sageli pole actionit üldse vaja. setup-node, setup-python, setup-java,
setup-go, setup-ruby ja setup-dotnet sisaldavad vahemällu salvestamist.
Node.js-i puhul salvestab setup-node npm-i, Yarni ja pnpm-i globaalsed paketiandmed, mitte
node_modules kausta, ja lülitab npm-i vahemälu automaatselt sisse, kui package.json
deklareerib npm-i oma packageManager väärtusena.
Ulatus ja piirangud
| Reegel | Mida GitHub teeb |
|---|---|
| Milliseid vahemälusid käivitus saab taastada | Oma haru ja vaikeharu omasid; pull requestid ka oma baasharu omasid |
| Mida pull request saab kirjutada | Ainult oma merge ref'i ulatusega vahemälusid, mitte vaikeharu omasid |
| Salvestusruum | Vaikimisi 10 GB repositooriumi kohta; organisatsiooni ja ettevõtte omanikud saavad seda suurendada |
| Väljatõrjumine | Kirjed, mida pole üle 7 päeva kasutatud, ning salvestusruumi täitumisel kõige kauem kasutamata kirjed |
| Saladused | Ärge salvestage neid vahemällu: igaüks, kellel on pull requesti juurdepääs, saab vahemälu sisu lugeda |
Mida vahemälu teie SBOM-i eest peidab
Vahemälu on otsetee paketiregistrist mööda. Selles ongi selle mõte ja see on ka põhjus, miks see segab iga kirjet selle kohta, mida build kasutas:
- Pole allalaadimist, pole jälge. Vahemälust taastatud paketid installitakse ilma registrisse päringut tegemata. Buildi võrguliikluse põhjal koostatud kirjest jäävad need välja, kui see vahemälu ei jälgi.
-
Vana sisu uue võtme all. Osaline
restore-keysvaste taastab vahemälu, mis loodi varasema lukufaili jaoks. Installimine lisab või asendab seejärel muutunu, kuid see, millest töö alustas, ei ole see, mida praegune lukufail kirjeldab. - Rohkem kui teie sõltuvused. Vahemäludes on ka buildi tööriistad, kompilaatorid ja genereeritud failid, mida ükski rakenduse manifest ei loetle.
- Skannimine ei oska öelda. Lukufailil põhinev SBOM kirjeldab seda, mida lukufail ütleb, olenemata sellest, kas töö installis vahemälust täpselt selle.
Laiema probleemi kohta vaadake, miks lukufail ei ole kirje selle kohta, mis tarniti, ja transitiivsed sõltuvused.
Vahemälu mürgitamine
Vahemälud on repositooriumi töövoogude vahel jagatud, mis teeb neist tee töövoogude vahel. 2024. aasta mais näitas
turvauurija Adnan Khan, et igaüks, kes saab käivitada koodi vaikeharu kontekstis, kas haavatava
pull_request_target töövoo või kompromiteeritud sõltuvuse kaudu, saab üle kirjutada faile
töövoogudes, mis vahemälusid taastavad. Töötava töö vahemälutokeniga saab ründaja täita repositooriumi vahemälu
nii, et GitHub tõrjub välja õiged kirjed, ja kirjutada seejärel samade võtmete alla mürgitatud kirjed. Väljalaske
töövoog, mis need taastab, käivitab ründaja failid oma saladustega.
Riski vähendamiseks:
- Ehitage väljalasked puhtast olekust või vahemäludest, mida kirjutab ainult väljalaske töövoog.
- Ärge kunagi käivitage usaldamatu pull requesti koodi vaikeharu kontekstis.
- Hoidke saladused ja tokenid vahemällu salvestatavatest radadest eemal.
- Käsitlege vahemälust taastatut buildi sisendina, mis vajab sama põhjalikku kontrolli kui allalaadimine.
Kuidas CRACI vahemälusid käsitleb
CRACI on GitHub Actionsi runner, nii et actions/cache ja setup-* vahemälud töötavad nagu
praegu, koos konteinerikihtide vahemäluga. Vahemälu on ka üks põhjus, miks CRACI käitab builde umbes kaks korda
kiiremini kui GitHubi hallatud runnerid, lisaks kiiremale riistvarale ja lühematele järjekorraaegadele.
Muutub kirje. CRACI pakette tundev puhverserver salvestab paketid, mille töö alla laadib, ja tõendid liiguvad vahemäludega kaasa: kui töö taastab vahemälu, kannab CRACI teadaolevad sõltuvused edasi selle töö SBOM-i.
- Täielikkus vahemälu kohta. Igal vahemälul on täielikkuse olek, nagu igal tööl. Töö, mis taastab puuduliku vahemälu, saab puuduliku SBOM-i ja selle loodud vahemälu kannab selle oleku edasi, nii et lünk ei muutu kunagi vaikselt täielikuks kirjeks.
- Arhiivist ei arvata. CRACI ei loe vahemäluarhiivi sees olevaid paketimanifeste. See teab, mis vahemälus on, sest see salvestas töö, mis vahemälu lõi.
-
Üks vahemälu iga loova töö kohta hoiab need tõendid usaldusväärsena, koos loova töö väljuva
liikluse poliitikaga
default: deny. Vahemälu ja SBOM-i täielikkuse juhendis on üksikasjad.
Vaadake, kuidas salvestamine töötab, lehelt buildi ajal salvestatud SBOM-id või broneerige demo, et käitada üht oma vahemälu kasutavat töövoogu CRACI-s.
GitHub Actionsi vahemälu: korduma kippuvad küsimused
Kui kaua GitHub Actionsi vahemälu hoiab?
GitHub eemaldab vahemälu kirjed, mida pole üle 7 päeva kasutatud. Kui repositoorium ületab oma salvestusruumi piiri, vaikimisi 10 GB, tõrjub see vahemälusid välja ka viimase kasutuse järjekorras, vanimad enne.
Kas setup-node salvestab node_modules kausta vahemällu?
Ei. actions/setup-node sisend cache salvestab paketihalduri globaalsed paketiandmed npm-i, Yarni või pnpm-i jaoks, mitte node_modules kausta. Installisamm töötab endiselt, kuid loeb paketid taastatud vahemälust, selle asemel et neid alla laadida.
Kas pull request saab lugeda põhiharu vahemälusid?
Jah. Töövoo käivitus saab taastada vahemälusid oma harust ja vaikeharust ning pull request saab taastada vahemälusid ka oma baasharust. Pull requestis loodud vahemälud on piiratud selle merge ref'iga, nii et neid ei saa kirjutada vaikeharu ulatusse.
Kas Actionsi vahemälu on väljalaske töövoogudes turvaline kasutada?
See on kompromiss. 2024. aastal avaldatud uuring näitas, et igaüks, kes saab käivitada koodi vaikeharu töövoos, saab mürgitada vahemälusid, mida teised töövood taastavad, sealhulgas väljalaske töövood. Töövood, mis avaldavad väljalaskeid või hoiavad paigaldussaladusi, on turvalisemad, kui need ehitavad puhtast olekust või vahemäludest, mida kirjutavad ainult nemad.
Kas taastatud vahemälu muudab minu SBOM-i?
Võib muuta. Vahemälust taastatud paketid installitakse ilma allalaadimiseta, nii et võrguliikluse põhjal koostatud kirjest jäävad need välja, kui see vahemälu ei jälgi. Ja lukufaili skannimine ei ütle teile, kas vahemälus olid täpselt need versioonid.
Säilitage vahemälud ja täielik SBOM
Käitage oma töövoogu CRACI-s: vahemälud kiirendavad buildi endiselt ja nende kaasa toodud sõltuvused jäävad iga töö salvestatud SBOM-i.
Broneerige demo