Sõltuvused
Mis on lukufail?
Lukufail (lockfile) salvestab iga sõltuvuse täpse versiooni, mille paketihaldur lahendas, nii otsesed kui ka transitiivsed, et järgmine installimine annaks sama puu. See on parim plaan, mis teil buildi jaoks on. See ei ole kirje sellest, mida build tegelikult kasutas.
Uuendatud
Mida lukufail salvestab
Teie manifest, näiteks package.json või pyproject.toml, loetleb paketid, millest sõltute,
ja versioonivahemikud, mida aktsepteerite. Paketihaldur muudab need vahemikud kogu puu ulatuses täpseteks versioonideks,
sealhulgas transitiivsete sõltuvuste puhul, ja kirjutab tulemuse lukufaili.
npm-i dokumentatsiooni järgi kirjeldab package-lock.json „täpset puud, mis genereeriti, nii et
järgnevad installimised suudavad genereerida identsed puud“.
Üks kirje failis package-lock.json näeb välja selline:
"node_modules/raw-body": {
"version": "3.0.0",
"resolved": "https://registry.npmjs.org/raw-body/-/raw-body-3.0.0.tgz",
"integrity": "sha512-...",
"dependencies": {
"bytes": "3.1.2",
"http-errors": "2.0.0",
"iconv-lite": "0.6.3",
"unpipe": "1.0.0"
}
}
- version on valitud täpne versioon.
- resolved näitab, kust see alla laaditi: registri tarballi URL või giti URL koos commitiga.
- integrity on tarballi Subresource Integrity räsi, nii et rikutud allalaadimine ebaõnnestub.
- dependencies on paketi enda sõltuvused – nii pannakse kokku puu ehk sõltuvusgraaf.
Lukufailid paketihalduri järgi
| Paketihaldur | Lukufail | Installimine seda muutmata |
|---|---|---|
| npm | package-lock.json | npm ci |
| Yarn (Berry) | yarn.lock | yarn install --immutable |
| pnpm | pnpm-lock.yaml | pnpm install --frozen-lockfile |
| uv | uv.lock | uv sync --locked |
| Poetry | poetry.lock | poetry install |
| Cargo | Cargo.lock | cargo build --locked |
| Bundler | Gemfile.lock | bundle config set frozen true |
| Go moodulid | go.mod versioonid ja go.sum kontrollsummad |
Buildikäsud ei uuenda vaikimisi faili go.mod |
Tavalise pipi puhul on levinud asendus täpsete versioonidega requirements.txt. See fikseerib, mida
loetleb, kuid kõik, mis sellest välja jääb, lahendatakse igal installimisel uuesti.
Kasutage CI-s külmutatud installimist
Lukufail aitab ainult siis, kui build installib selle järgi. Tavaline npm install võib uuendada faili
package-lock.json, kui see ei vasta enam failile package.json, nii et build lahendab
vaikselt uue puu. npm ci on loodud automatiseeritud keskkondade jaoks:
- See nõuab faili
package-lock.jsonvõinpm-shrinkwrap.json. - Kui lukufail ja
package.jsonei klapi, lõpetab see vigaga, selle asemel et lukku uuendada. - See eemaldab kõigepealt olemasoleva kausta
node_modules. - See ei kirjuta kunagi faili
package.jsonega lukufaili.
Ülaltoodud tabeli teised käsud teevad sama tööd oma paketihaldurite jaoks.
Rakendused ja teegid
Lisage lukufail repositooriumisse rakenduste ja kõige puhul, mida juurutate. Teekide puhul lukustab see ainult teie
enda arenduse ja CI: npm ei avalda kunagi faili package-lock.json ja eirab seda mujal kui juurprojektis.
Rakendused, mis teie teegi installivad, lahendavad selle sõltuvused ise teie versioonivahemike piires. Ainus npm-i
erand on npm-shrinkwrap.json, mis avaldatakse ja on eelisjärjekorras ning mida enamik teeke ei peaks
kasutama.
Miks lukufail ei ole kirje sellest, mis tarniti
Lukufail on ühe paketihalduri plaan ühes projektis. Build, millest teie väljalase sündis, tegi rohkem kui järgis seda plaani:
- Võib-olla ei kasutanud see seda. Külmutamata installimine, puuduv lukufail või teine lukufail monorepos tähendab, et puu lahendati teisiti kui failis, mida vaatate.
- Vahemälud. CI vahemälust taastatud paketid installitakse ilma allalaadimiseta ning osalise võtme järgi taastatud vahemälu võib olla praegusest lukufailist vanem. Vaadake mida GitHub Actionsi vahemälu varjab.
- Buildi tööriistad. Seadistusactionid, kompilaatorid, linterid ja koodigeneraatorid saabuvad teisi kanaleid pidi, oma sõltuvuspuudega.
-
Allalaadimised ja installiskriptid.
curlbuildi etapis või paketi installiskript laadib alla koodi, mida ükski lukufail ei loetle: varjatud sõltuvus. - Baastõmmised. Konteineri build tõmbab tõmmiseid ja operatsioonisüsteemi pakette, mis asuvad väljaspool kõiki keelepõhiseid lukufaile.
Terviklikkuse räsid ei aita siin midagi. Need tõendavad, et lukufailis olevaid pakette ei ole rikutud; need ei ütle midagi selle kohta, mida build väljastpoolt seda alla laadis. SCA tööriistad, mis muudavad lukufaili SBOM-iks, pärivad samad pimealad.
Salvestage build, hoidke lukufail alles
Lisage lukufaile jätkuvalt repositooriumisse ja installige neist külmutatud installimisega. Need muudavad buildid korratavaks, kuigi üksi ei taga need reprodutseeritavat buildi. Selleks, et teada, mida väljalase sisaldab, salvestab CRACI buildi enda: pakette tundev puhverserver selle GitHub Actionsi runneritel salvestab iga paketi, mille iga töö alla laadib, sealhulgas CI vahemäludest taastatud paketid, ning iga töö SBOM märgib oma täielikkuse. See kirje annab kasutatavatest sõltuvustest täielikuma pildi kui lukufaili skannimine. Vaadake buildi ajal salvestatud SBOM-e või broneerige demo, et võrrelda neid kahte ühe teie enda buildi peal.
Lukufailid: korduma kippuvad küsimused
Mis on lukufail?
Lukufail on fail, mille paketihaldur kirjutab, et salvestada iga lahendatud sõltuvuse – otsese ja transitiivse – täpne versioon koos päritolukoha ja kontrollsummaga. Hilisemad installimised loevad seda, et taasluua sama puu, selle asemel et versioonivahemikke uuesti lahendada.
Kas peaksin lukufaili repositooriumisse lisama?
Jah, rakenduste ja kõige puhul, mida juurutate. Ilma repositooriumis oleva lukufailita lahendab iga uus installimine versioonivahemikud uuesti ja võib kaasa tuua uusi transitiivseid versioone. Lisage see repositooriumisse ja installige sellest CI-s külmutatud installimisega, näiteks npm ci abil.
Kas lukufail fikseerib transitiivsed sõltuvused?
Jah. See on selle põhiülesanne. Manifest loetleb ainult teie otsesed sõltuvused ja nende lubatud vahemikud; lukufail salvestab puu iga paketi jaoks valitud täpse versiooni.
Kas lukufailid kehtivad teekidele, mida avaldan?
Teie kasutajate jaoks mitte. Näiteks npm ei avalda kunagi faili package-lock.json ja eirab seda mujal kui juurprojektis. Rakendused, mis teie teegi installivad, lahendavad selle sõltuvused ise nende vahemike piires, mida teie package.json lubab.
Mida teeb package-lock.json-i väli integrity?
See sisaldab paketi tarballi Subresource Integrity räsi, tavaliselt sha512. npm kontrollib allalaaditud paketti selle vastu, nii et lukustatud versiooni rikutud tarballi installimine ebaõnnestub. See kaitseb lukufailis olevaid pakette, mitte midagi, mida build väljastpoolt seda alla laadib.
Kas lukufail on sama mis SBOM?
Ei. Lukufail on sisend: plaan, mida paketihaldur ühe projekti jaoks järgib. SBOM on väljalaske inventar. SCA tööriistad muudavad sageli lukufaili SBOM-iks, mis toimib siis, kui build installis täpselt lukufaili sisu ja mitte midagi muud.
Võrrelge oma lukufaili oma buildiga
Käitage üht töövoogu CRACI-s ja pange selle salvestatud SBOM allalaaditud pakettidest kõrvuti sellega, mida teie lukufail ütleb.
Broneerige demo