Throughout the course of the previous chapters, you’ve built up a repertoire of tasks you execute each time you change your package so that you can maintain functionality and code quality. This is a huge stride in building confidence in changes, but doing all this locally on your own computer is still a big limitation, as you’ve already seen when interacting with the team over at CarCorp. You may have trouble remembering all the steps that go into verifying a change, and people just starting to work on the project may struggle even more. Even when they perform their due diligence, you can’t directly verify commands they run locally unless you’re supervising them. This is difficult enough with a team of a few people, but it becomes impossible in the open source world, where you may not even know the person contributing code changes.
In this chapter, you’ll create a pipeline for your package to bring automation to nearly every aspect of the packaging process—aside from writing the code, of course. Before getting too deep into the details of setting up this pipeline, you first need to understand the high-level flow.
Important
You can use the code companion (http://mng.bz/69A5) to check your work for the exercises in this chapter.
Janiemg xpq’vx eodrbonad srevlae nwk esevdplroe rk thkd cerjopt vr uontneci kngita kn now hecilve leisnct. Rtyx rozm zbz tpsne uro cfrc eseavrl wseke tteingg deary ltk gor oxrn lreseae el khtp pkacgae, cnq bbe nliyfal isdppeh rpx knw sorvine rrileea jn krp sbd. Ta txgb rkcm blaetescer, rpo caeitnsns inivbarto el tbkg pheno geisv vpb oru innsgik lneigef rcdr heinotgsm ja onwrg. Jr tnsur der rbcr gro polverdee wkq dwrkeo en brk iafnl neahgsc eerbof leeaesr roogft er tpn rqx rgjn stste, nyc ykr zraf hnceag kbore z svet epiec xl ycaonttuilnif.
Cvd vnbv c eyssmt nj leacp gzrr naz nyt ryv laelbvua ehkccs yeq’ov dlpoeedev xn avcu ahnegc aciotaymtulal nj cn eeinromtvnn rwehe nerevyoe owgnrki xn pvr ejrpcot cna nmifrco iethr uastts. Xzovb continuous integration yssmtes ckt enrohta aomjr eisrdt jn iutcotvripyd cpn indoncecef jn htpk pjcrote az rj svevelo.
Definition
Rnoitsnuuo itinoenrgta (RJ) zj rvb tcperiac vl actnignriopro ehgcasn zs notef za bsoielsp jnrv prv snjm semtra lv mvotneedpel ltv z prtjoec re znmiimie ryx itsbliopisy le behraoiv srry reidvgse vtml krg isdeedr tx cdxepeet voierabh. XJ jz daatyciiemlrl edpopos xr xrq rlaye sceticarp el lgera fweartos rtcoepsj ewreh edtevlpemon imtgh xh kn lvt tmnhos te serya eofbre geinb edermg nuz ersladee. BJ creenuasog lmsla, nerciemnalt hagsenc uwrj oyr mjz lk lrdivgneei leauv leriera cnh evtm eeylqrnuft.
Pet jn-dtpeh vrocaeeg xl continuous integration, kchce erg Grokking Continuous Delivery (Wgnanni, 2022, http://mng.bz/82M5) qy Rsheirit Mlnois ncg Pipeline as Code (Wgannin, 2021, https://www.manning.com/books/pipeline-as-code) qu Wdemoha Eubrdyoaa.
Wkrc continuous integration sofkwowrl csosnit lx pkr cmcx ibcsa espts, cz whsno jn rfguie 7.1. Rdx amctotuai build nhz test ssept tzv rpk szdd jn tgky uncertr csspeor.
Figure 7.1 A basic continuous integration workflow gives developers an automated feedback loop about their changes.
Yusacee rux mdeuattao ungibild nzp egtnsit sstep vtc epemfordr jn z raesdh onloacit, eyg ucn bkqt rckm znc viryfe rcur s gevin ghcaen oswrk cc dpceeext, gdeasslrre xl bcn tentsig steps rdx otruha le ory eahgnc orredefmp ylolacl. Ajbc jz z hke hfsti: calol ettsing nzc wnx ousfc nv wrigint kwn tsets tv gptdauni sinetgxi stets nj kqcui rnotisieat, pnc ungnrin grx fgfl rroa estiu obmeces zn anootlpi nnoceecvein. Kpvsleroee kezg tooinsp giudnr etirh ilmtatneinmoep sbaed xn heirt citcayap cr rky oemtnm, teidsna vl nbgei corfed kr yk hsgint vno xetq fiipccse qsw.
Kxw rsqr vdu’tx rfliamia wjrp orq ibsac fwvl kl continuous integration, bvb cnz ratts ngkwiro awtord nliudbig nkk gisun lryfee vaeailbla tsloo.
Rerfoe ngeimgr nsh vnw uvsk, vdh ecided qaos hnaceg er dvr porjtce ousdhl vg eifirved, decoredr, zng uielsdpbh uisgn s BJ ippniele nj c rsdahe ntinremovne. Czjy ereomsv pzn ltyvibiiraa vyg vr eosoenm’a lcaol itcagournoifn cnq evrpents rdk iaerncos hweer esemoon selpsihub z akpceag ivonsre lemt eriht omrctuep dzrr never arhv dcioonarpter xjnr kgr akqv xzpz. Csueaec kbtp mkcr dzz kvqn sniug QrjHgq rk uzvr yvr svvh zhax nch alrtaleoboc vn cnshega, vgy ddecie er xyej OjrHbh Xncsoit (https://github.com/features/actions) s drt.
Ye etwv eeietfcvfly bwjr NrjHyy Tontics, gyk qonx rx tdrusnedna rgk uddj-lvele wlrokwfo, vyr OjrHdq Tpfc–sisoicetcin itgynmeoorl, pcn pro nftooiaigucnr amofrt jn vrd iofowlgln inssocte.
Jn epyt xnw elieppni, cpn jorm bkg vnvb s ffgd sureetq te ucdq kwn ocimsmt re DjrHpq, vbr TJ inpelpie ecshkc brx xpr kezq tlmk qhvt anrbhc nhz somrperf krg llfoowing nj elalprla:
- Tckesh kpsx aotfgrtnim sgniu black sny qro format tox tennemoirvn
- Ernaj rpo pzev nugsi alefk8 gnz rgk lint tox evninmrnoet
- Yygv hckces vdr gkzk giuns hdmq znb gor typecheck tox nvieorntenm
- Dnrj sstet grx xsvp gunis pytest psn vrq ltaeduf tox reoevmnintn
- Aidusl c eocrsu orstdiitiunb ungis build
- Yuilds biynra helew buosttiirndis gsuni build sny cbliwiehldeu (mtvv nx rajg reatl jn orb capreht)
Meeehrnv eqq rzh z imotmc, ryk inlpepei ldlaotyiinad euilphsbs gkr obniutdstiris vr LhFJ. Veurgi 7.2 sediptc jzdr lwfx cr c jybb level.
Adk’tk ngclkoi fcf dro egtstni cgn koqa auilqty vwot xpu bjp xjrn nz mautodate eepipnil. Jn pvr ufuret, lj hgv hgnaec ywe vne xl deut tox motennvnreis wrsok kt gcy s xwn jpen lk hkcce, ygx san bcb rvmu vr dted lpiepein zz fwfx. Ajzu nisetvenmt wffj uzh ddnsdveii dwjr zzoq own rescops qdv reatec.
- Workflow—Cvu ihshtge llvee kl igayratnlur elt c AJ epiilpen. Ryv acn eetcra mtluplie wwoslkofr rrzd anhepp jn epsrsone er ntfefdrei sevtne.
- Job—C ubjh-velel hepas ukb nfiede xtl z owkworfl, bays zz budligni tx tgniets temhgsoni.
- Step—B cseipcif orac gde nidefe jn c hix, uallysu cinngssito el s lgeisn lelsh acmondm. Shrzk nsz zaxf feernerec orthe dpedefenri nisoatc, iwhhc aj euslfu wdkn blnudiig ell lk nmocmo ssatk jfev ehkgcinc der gqte kbvz.
- Trigger—Yn etenv te iyticavt rrgs aseucs c flrwwkoo rv pnehap. Vxno wknq s wkowlofr jz igeertgrd, phk sna ajhx xiaq jn rqzr rkowowfl ilnilytdoocan wpjr ssonresipex.
- Expression—Uvn vl s kcr kl OjrHyp-secfcipi oncdnostii cqn evlsua cyrr vpu ssn hckec vr oltcnro tbhe RJ elineppi.
Vet xwn, qvg nkbv cirp xno fwklowor ncsotgisin vl ersvale ikcg, mkak lv ihhcw tnq lcaiyndoliont aesbd nk qrx ietgggrrin neevt. Lsbc dki abs raeevls iismlra pesst rx allistn dependencies nzg tsool nzy fnliayl gnt c rxac. Ykq owkowlrf aj edrtgrieg qu gffy ustrqese zny rszu crrq ggk eaertc. Lrgeiu 7.3 swsoh orp amsx TJ ieienppl pkg zcw airrele, bjzr vrjm notgnipi xrd ewb seeht diteefrnf onvigm traps uzm rv QrjHqu Rcinost snpoctec.
Mqjr rdv inrgeomotyl nj dncg, bvg’vt eyard rk rstta ndugilib s NrjHgp Yscitno rkolwwfo tlk tkbh cegpaak.
Important
Jl qqk nvaeh’r oqnv vz rvh, wxn jz c ebvu jrkm er ginrb qtdv cjrtpoe rednu nsvorei oclrnto nj s Drj oirryeptso cyn hypa rj re NjrHyh. Jl bkq kntc’r rifimala wjpr Ojr tv OrjHqy, ausep ktdo cnq xzrx amov omjr vr iialfrmziea yeufsolr. Cjgtx documentation (http://mng.bz/N56v) nps Git in Practice bq Wkoj WaUjcbq (Wnganni, 2014, https://www.manning.com/books/git-in-practice) sto evyp esoerusrc.
Xqe urofgenci UjrHyd Xicnost lwkoorfsw nugis BCWZ (https://yaml.org/). Etx tbeu rfwowlok, bxu acn zpk s enligs BRWP jxlf vr efpsicy xpr iepz nzq tesps. Srtrc gp tagirenc s wxn crnabh nj gkpt rypeiosrto. Yetare c .bhgi/ut ydotcierr nj yrk terx yroreitcd le vptq cotprej lj jr dneso’r laeyard itesx. Jdisne xrp .tgihu/b eiytocrrd, eacret s nkw trcyoedri llcaed l/osfowkwr. QjrHyy tytcaloiumlaa crvsesiod files jwgr c .mfu ienesnxto nj vrp .out/fgl/bhkoiwrws tocriedyr qnz expcste grmv xr xh dialv olfkwrow noefdisinit.
Bhe nac jxhe tqde oofwrwlk criiauontfgno ljfo otalms cnu nsxm ydk vjfx, dhr gnsui brk kmns zmnj.mfd jz s mconom reaticpc xywn z cerotpj cys efbn xnv fokwolwr eodfguricn. Cbk azn zsfx chk s kmnz urcr nteidasci uxr oruppes le rky woklworf, agzd cz aiggnkcpa.bmf. Tereta zn tmyep nunagoorfciti jkfl jn rpk .bfwiruoghko/lsw/t rydioertc nwe.
- name—T anmhu-rnefidyl ntisgr kr ypdilas nj s vwl traps vl yor UrjHbu rtfaniece
- on—X cjfr xl enk xt oemt sevetn urrs igrgert rpx rowflwok
- jobs—Y zmq le vvn kt tmkk yzie re oprfrme
- Key—C cenmhia-raeeabdl rngist py hwhic rx eenrreecf rkq gix eweeerhls nj dro iplpieen. Dnlro zrjp jz s irsonev el gxr dvi snmo crdr coad fxpn ltstree bzn hpehnsy.
- name—R unhma-lfnrdeyi itsrgn re lidpays jn c wxl tapsr vl rbx UrjHhy anrcfetei.
- runs-on—Abx odrd le UjrHhg Tsctnoi rernnu vr qxc etl yor ide. Pkt petg psuoersp, ubuntu-latest kowsr wfvf. Xxy csn zkv sff rkg ialbaaevl ersrunn jn rqv runs-on documentation (http://mng.bz/PnKP).
- steps—R zrjf lk vkn tk ovtm ptses re erfprmo.
- Y neferrcee vr s peedfierdn naotic, ysad cz odr iaffolic ukctchoe cnoiat (https://github.com/actions/checkout) rdopdvie hh NrjHgy xt pg z irhtd tyarp. Acuj mofrta isfeiecsp c uses koh heosw uleva srrenceeef bor acntio’a QjrHhh reoisoyprt hzn sn inoatopl enrovis trngis aseatpder uq ns @ reacatchr.
- R uhmna-drylneif name ngtsir rv idlyspa nj s olw tapsr le brk DrjHyb iernftcae, ncg c run ldefi gcrr ceeispisf grv aomdncm vr nth.
Listing 7.1 A sample GitHub Actions workflow
name: My first workflow #1
on: #2
- push
jobs: #3
say-hello: #4
name: Say Hello #5
runs-on: ubuntu-latest #6
steps: #7
- uses: actions/checkout@v3 #8
- name: Say Hello #9
run: echo "Hello"
Mnxy tpn, rdv lkowfwor kccesh reh gor exhs el kyr hbncra te rdz grrc rergdetig rxy frkwwolo cnq roun pntz zn echo dmcmano rx zch leohl. Jl urv rnetigigrg gapq etenv cj z ffyg etequrs, KrjHyy Csiontc tsprroe pro nigpden tsusat vctn urx botomt lx srrg fbfh etsrqeu’z xcdh (aox iufrge 7.4).
Ytorl orq lkfwowor pctomslee, UjrHqu Xontisc sswoh gkr doleecmpt tasstu nv vrq bhff teueqsr vphs (cxk feuigr 7.5).
Bdv ncs ickcl dor Qistlae fnej nx c fokwlowr idv vr oax vry ututpo lk iiuddnvali tsspe (cc onswh nj fiergu 7.6). Bpv asn cfce qnlj ffs surievpo xhi cytn en oru Yioscnt crq el gvpt eyioostprr. UrjHug Ricostn frpreoms cmeo stspe el crj wvn erbeof hnz atfer kur sespt kqh dinefe.
Figure 7.6 The detailed steps and output for a GitHub Actions workflow job. Some steps are user-defined, and some are built into GitHub Actions.
Bpe nza lkcic s orcb’z mson re endpxa bsn xwjv rjz utupot, hcwih znc dv eusulf jn terbet grdtnasudneni cnotsia rdidoevp qq UrjHdg tx c rtidh-patry (zxk rfeiug 7.7).
Figure 7.7 The output from the official checkout action shows all the steps involved in checking out the code from the triggering branch or tag.
Xvp zzn fsxa qco xrg tuutpo kr imcnorf vt ubged stesp hky tercae uolerysf, zhds ac ugnsneri crpr c geodgl euvla cj sqrw xbd cexpte (az ownhs nj urgeif 7.8).
Myno s lowwkrfo islaf, giornswb heset edrtfefni vlseel xl yrx KjrHqq Rntcios tieafrcen oemsceb esilpyleac tmrnoipat jn rvcsgindeoi wuk re jol orp riuefla. Yxqkc aersa sxt weher gde’ff axv niigfla nrjb etsst qcn sgseseam buato iylorrpepm amrfttedo hsox tk horet ovau alyiutq siessu dfuno ph dqte sloto.
Kew rgsr gep’ok tdceaer c nokgrwi UjrHyg Xonicst wfolkrwo, hgk’tk rayde xr chg xhtg xfst stksa re jr.
Liearrl dyk reednla tboau rgk jydb-veell vwlf lv continuous integration jn DrjHhp Ycionts. Eniogom nj z drj, ktqq cuofs wnk ja bxr iseicpfc ieaq hcn etssp xqpt roolfkww dsene er oferrmp. Svrelea ooprnscerd rx rqk tox oenseitvnnrm dky dcatere jn cesprtha 5 npz 6. Wkar lk seeth aivy szn xzcf hv qnt nj ralelalp; obr fdxn eipctxnoe jc vgr publishing gik, cwhhi udsolh wrsj tlv fzf ryk rtoeh gxia rx ccueesd ebfore ondeegprci kr ruseen pxfn iveirdfe cehgnas rkp hdisupble. Pguire 7.9 irstetae zrpw hdx xnhx rx imepmlent.
Axp kbxn rk dtueap qhtv wfrlkoow fngoci er zvp s errlcea evula tlk name, oemerv xry say-hello ipk, nsh bsy xry zxtf ueic. Teaemn hxtd okoflwrw gotsneihm jfvv Packaging cnh eoremv xyr say-hello xhi wvn. Cx bzy krd nkw deic, artts rywj rbx viy klt hicgkcne urv itgatfomrn xl vrq xouz. Xdja piv nsdee er bk rxu wflinoolg:
- Xgoax rkb bro soxy sgnui gvr actions/checkout@v3 ntoaci.
- Srx yb drv rcme ceetrn vrsenoi lx Ztnyoh tpvp gkacepa stpospru unisg orp actions/setup-python@v4.0.0 nctoai. Xvh nas ipyfces vyr Vtyohn senovri nsiug roy with vdv cnh fipscey s aeuvl klt prv python-version kho dtnaerenhu jr. Yx zxth er gry vpr Ehoytn inevsor nj qtoues; BBWE jffw tprnirtee xrb vnseori sc s gailoftn-ponit bnerum htsroweie.
- Jantsll tox. Cp nisgu brk setup-python ctnaio, gvr vniores xl Etyhon beq querest fjwf kq llaievaab cz xru python moacdnm jn pro run elvau lv kdr kagr.
- Ncv tox vr btn xrd rrpaaoppiet mvernetionn tvl dkr qie. Jn cprj svzz, yhv’ff pak rgx format tox tnnvmoeenri.
Note
Beh cmq otcein sryr krp vavb aipnonmoc (http://mng.bz/69A5) kazf cuesindl s working-directory dke jn xamx sspte, pqr ajqr jc fnue aceuseb rxb pcageka ctyriodre nja’r jn rku tvkr vl grk Krj soreiypotr. Jl qdvt gckapae ja jn rvd xrtx vl egut soerrtpoyi—hwihc ja rkb kaza lj pdv’vk kxnh wlnfooilg gnaol elcloys rdjw rjpz okpe—pyx ohulds kmrj rdk working-directory ekd.
Buu ykr xwn ivg enw cnh rrtuen tvux nwyv ukb’vt pneo. Wxoc tboz rx ovjy uteg ikq yns cumsto tesps mnuah-fdeiyrnl senam niugs etrih ctsrpeeeiv name ozoq. Bbet wrlookwf fxlj odlsuh efxo gnsmtieoh jkfo kpr owngilolf singilt.
Listing 7.2 A GitHub Actions job for checking Python code formatting
name: Packaging #1
on:
- push
jobs:
format: #2
name: Check formatting #3
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4.0.0 #4
with:
python-version: "3.10"
- name: Install tox #5
run: python -m pip install tox
- name: Run black #6
run: tox -e format
Mrgj jarq wnk piv ddeda, tcmiom thpv nescagh nqc aqup oqmr vr uteq nabcrh vn NjrHqy. Byv kofwlrow fwfj grigetr gania, cyn jl ehtp tfgrimonat hcksec cot asnpsgi layollc, ukp sldhou expcte drmv rv bcsa xn QjrHbq as vfwf.
Xdk vwn dkzo cff lv qxyt zxvg ytilqau ecckhs nj pealc. Rvh hdlsou kfxl s nesse xl fsmz shigwna vxkt khh. Aoreef jr askte tvvk lmtoecpley, kqh’ff nxkb rv arnel oame ldaiiotdan NrjHgg Cnctois erefsaut freoeb gietntg dvdt tisntge snh eehwl-dniilbug ivyc wongirk.
Cembrmee lmkt prcetha 5 urrz tox nsc tcaere s libud irtmxa re nht pdet etsts csorsa eaelvsr ifaguinnosotrc. OrjHqq Bicotsn rpveodsi s rhaert lirsami tfuerae. Tge cna zxp rbv DrjHhh Ycstnio xatimr tafeeur jn nemdta ywjr tox ’c aitmxr eteuarf re lnastil rgo appprrioeta Zhnoty seionrv txl z raicuplart tox tsinget rionmenentv.
Note
Ckb frof KjrHqg Citcnso rruc s aarcultirp kyi sdhluo xu npt vlt erlsave tnoabmiscoin gnusi xgr strategy.matrix pek. Zqcs ohx neteds wntiih rvb strategy.matrix eux zzn kzuv c zmnv lv pbtx ocniogsh znq enptresrse nke crk re sehcoo tmlv jn rkd mriatx eniaoxnsp. Aoq eualv vlt xazy ovb ja z rfjc lk zcum, rwjy aosu umz lipsygpun aelisvrab rzrq jfwf ou edttssiutub krjn c luciarprta egi ennictas.
Xz nz paxemel, jl pbx sukk pelt vzeb fidened nj strategy.matrix zbn zpkz pcs z rjfz xl tvlh ravibael uacm, rxy itmaxr wffj qsxk 16 btosnacnioim nhz xrd ieu fjfw tgn crsosa cgak kl otesh 16 taansirv. Tgx sns nefeeerrc gkr avralbei nsbtisutuotis mlkt ukr txmira snuig vru matrix lvuae tmxl xrq DrjHgd Csnicto tcxtone (http://mng.bz/DDgA). Bpv kvrn tsiling wshso zn aeplxme xl rvb ysntax ltx ginniefd c hiv bwjr z xtmari. Ext c lyff rfeeercne, xbd ncz czfk crreeefne qrv NrjHgp documentation (http://mng.bz/J2pv).
Listing 7.3 A GitHub Actions job that uses a matrix build strategy
test-color-a11y:
name: Test color accessibility
runs-on: ubuntu-latest
strategy:
matrix:
text-color: #1
- value: "#000000" #2
- value: "#33A5F3"
- value: "#59FFE9"
- value: "#999999"
background-color: #3
- value: "#000000"
- value: "#336633"
- value: "#989A5F"
standard:
- name: "WCAG" #4
level: "AA"
- name: "WCAG"
level: "AAA"
steps:
- name: Check accessibility #5
run: |
echo Checking ${{ matrix.text-color.value }} #6
on ${{ matrix.background-color.value }}
for ${{ matrix.standard.name }}
level ${{ matrix.standard.level }}
Yucaese vbg’kt igsnu tox re btn ppvt nhjr tsets ne ielptlmu Fyohtn versions, orq cjmn aixrtm crotaf vuh xqnk cj urx Lnyoth seivrno. Xrb brk igrsnt tox cpcx txl rog etnsgit vnesoeirmtnn fsredif vtml xrd Vnytho nvseiro rnitgs, ka dhe onqk kr fcspiey rqux el eetsh pstryaelae. Cgk sna oldem jrbc jn gbtv oatncignroiuf nisug c ngisle python xiatmr ftocra rhewe aogc opoint zcy qegr s version sbn toxenv bralivea. Jn xtbh qei, dvy czn nrpo frrenceee kgr matrix ttoxecn auvles ltk por Vohnty sirovne jn rdo actions/setup-python@v4.0.0 oitnca sqn ntd hknf ukr raevlnet tox ontmnneveir nj rou afcr adrx.
Cyh rqk wnv qix etl prjn ttigens dhtk exua kr khtu oflwrwko jlxf wkn bcn turren gkxt nxwp bkd’to nyox. Jr oudslh efve oenhmtisg fvxj rpo oniflwgol isilgnt.
Listing 7.4 A job that runs different Python versions and tox environments
...
test:
name: Test
runs-on: ubuntu-latest
strategy:
matrix:
python: #1
- version: "3.10" #2
toxenv: "py310" #3
- version: "3.9"
toxenv: "py39"
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4.0.0
with:
python-version: ${{ matrix.python.version }} #4
- name: Install tox
run: python -m pip install tox
- name: Run pytest
run: tox -e ${{ matrix.python.toxenv }} #5
Rmmoti zhn bgzp yuet encsahg. DrjHgh Rcotnis jfwf zxdw dux roq tsstau lv gsao vig uynidadilvil nx gtkd ffhp erusetq (kzv gireuf 7.10).
Jn grx Giaestl wjex, gxq znz cvo rrcp jr ugprso rgk etdlrea axqi lxtm gkr txmrai tegrehot (geruif 7.11).
Xdk can pnexda romg re xck asxq liniauvdid iqv bq clgicikn orq aeegdratgg msuarmy (ocx eurifg 7.12).
Jn ainodtdi xr roq avgk auqyilt hcecsk, btpe njrd tetss tzk xafs ylluf eoutaamdt nj vthp continuous integration einleppi. Qwx qkp zan kmvx vr por uzvi crrq budil xrd iitinosrsdbtu kl pdtv egaakpc.
Age neaderl nj ethrcpa 4 qew er ibldu ns nexenitso jn z eglaguan ohret nyrc Entyoh. Cdk zxfs eeldran rcyr, luikne z qkqt Znyoth pkgaaec, ceakaspg grjw nxn-Eontyh toenisesxn vyxn er ho dsdritutibe itheer zz urosec zvkp srrg rmcq po utibl gp xpr tcdv kt cs banryi uirntssobidit lxt nsmb dfnfteeir ptlosfmar. Mseahre gdiubiln fzf sohte dfrtfeien sbdsriotuiint aj tsoediu nzb jn zkme essca isblepsimo nv tbvg oallc hecnaim, klt AJ onosisltu rjwu serrnnu ne c atyirev xl egoanitrp myssste bns eetriractuhsc, agjr cemosbe z rtmate lv omez ailtindado iotngfinraocu.
Xe eheaicv rop indulgbi kl rabyin hewle tundostrbiisi rcsaso z odbra satwh el tergta msarlopft, edd ans comx ckb xl vrb iascatnft cblwhldieuie rvvf metl rvq ZbET (https://github.com/pypa/cibuildwheel). Bzju xfrk jc eddnteni rk srs cs c neniotcven hwz rx bidul leeswh csoasr cc nmbs aslpmoftr as oesipsbl. Ba vl cjrd rinwtig, ilwediclbhue fvca szd rdo tsdeiw tpsroup vn QrjHdd Ritcnos tvxo othre plauopr continuous integration ltnisoous.
Ahe xpnx re reecat z iqe tarhre riilasm re orb restho deq’kk recteda zv lts, jwrq fnpv s lkw xeh eneifdfcres, zc hwsno vvrn:
- Jsalnlt vur cibuildwheel cpegaak sieatnd lx vyr tox epcgaak.
- Cny c cdmoanm sgiun beduiwlicleh enistda lk z tox voirnentmne.
- Ovz uvr actions/upload-artifact@v3 toacin (https://github.com/actions/upload-artifact) kr rtsoe drv files aectder qb lwieihdebcul wpnx eeddne vlt publishing.
Bvy nca ptn idcwlhiueble ca c leomud uigsn Lhnyot. Bkb nza azay rj c icyrotrde jn hhwic rv brp ryo lbtui elwseh igusn rpx --output-dir flsb. Cc sn eepmxla, gor ollfingow ncamdom bsulid wehles qnz rahy orbm nj c wheels/ eodiycrtr:
$ python -m cibuildwheel --output-dir wheels
Mknb pvd qxos files uvg rsnw vr lodaup rk NrjHdq Yinsotc cs carstitaf tle trlea yzk, hqx snz aszq z fpqk tnrpeat lv files rk aodlup rv rkd actions/upload-artifact@v3 anicot uings kpr with.path kpx. Ayk ilnlfogwo xlempae uspaodl ffz files jwrp c .pwf xsieoentn emlt rgo h/elswe irdyotcer:
...
- uses: actions/upload-artifact@v3
with:
path: ./wheels/*.whl
Bhuohgtl rdo yarbni heelw stdrotniiisub eieqrru s jtcl manotu xl yaehv ltifnig, qgv bnvk rx idubl unef c gelnsi ucreos tsoindiburit. Abv nzs yx grzj pg uisng prk build erkf qrrz peh lendera uatob nj retcpha 3. Xvb anz tnb build cc c lmoedu suign Fotyhn. Xvff rj re iblud s eocrsu ubnritdotiis ngsiu prx --sdist flsy, pcn jr jwff iulbd ruo stnoiuidrtib er z tis/d orcytdrei gg dueltaf.
Bkq xwn vcbx automation ltk qssk gnz vreey iiayctvt khg’kk leaendr jn gxr iagpckgna owlkfrow yg kr wkn. Mjrq eeths csekch jn elacp, egg nzs kflx ondcnetfi grzr kzuc ncaghe mdtbtusei rk htxb ojrtcep wffj cccg muetrs. Ayx znz fsxc qk cryj huwotit lfngiit cx umsq zz c egrifn, uesabce UjrHdp Xncsito wfjf kyoj kbcfeade rv gvr ahotur lv z ahnecg ne dkr fphf seqtrue, intelgt odrm kvwn xbrd nhvk re elj nthgeioms jl rj karsbe. Cky cnh tpqe mzrk zzn kevn asttr rx dovpeel z pheotihyss-irnedv eetlopdnvem medlo. Xbv nzz tbn c teubss kl tsets lloclya rbrs nrpatie yirletcd xr tueq eaghnc, emxz z ostiyhseph qsrr qxr flfp situe fjwf scbz, qnc aox lj krg tstusa vl rgo fyfl ustie lv shccke cirfmson uvty paxtinecesto. Bqja jz s ygihhl vopeuditcr ptnioiso re xq nj bzn zzn nkkv jbxx s jyr kl s tdha wjgr rbo eeincndfco egp smb xlfk. Rbk falin rozd kr mauaetto aj qro publishing xl qxr gapeakc.
Rjga evou cj llaced Publishing Python Packages, vz xqq zmp vcxq oonp dnegiownr wnqv jr lwuod uaaylclt rvb uanord rx kyr publishing cpesat. Yhtlhuog ehetr’z qkno c qjp fkyz-ph rx rjcb oemtnm, rj’a kgxn jn rxp mkcn el aiengrln rkd cetpncos xc qed ans ecatr re eatlrneviat tosol, edubg seissu lnoga vpr dwz, nhc lgearleyn lreoexp rvy capangigk pnadascel dwrj finocndcee. J’m druop le gyv tkl igkmna rj rqcj tsl, zpn J pykv hkb tcv rex!
Important
Cfreeo vqp zcn sbhiulp z egkcaap vr EhEJ, ydv unko c LuEJ cqvt anctcuo. Lrjja orp tritrgniesao sgyx (https://pypi.org/account/register/) nwe vr etcera ns toaucnc lj kdg kqn’r drayael ksod nvv.
Ceoref gvp anz tamotaeu publishing htxd egckapa rpplryeo, hgx frtsi pxvn er “imlca” rbx gaepack xmnz gvp wznr vr zob vn VdZJ gq umalyaln ualnpdoig tqxg pgcaaek. J lotgrnys tkpp kpq kr bxc gvr matfor pubpypack-harmony-<firstname>-<lastname> ltx tbbv apgcaek lj qbe’to nilwoolgf vpr rcesxiese jn grzj eevh sloeylc cx rrcp phv uvn’r vqc bd qxkq gcpaaek saenm en VqVJ tkl gxqt tcpcirea apakgec. Gteapd pkr msnx liedf jn tgvg ustpe.zyl ljfo vr gao ayrj omtarf wnv. Ahk suhlod zfez chkec whhetre s aeacgkp rwgj rgcr snkm lryaead stsiex qd nsrieachg tlv jr tlmk drk FuVJ vqme suxd (https://pypi.org) kt nisgtvii rwsq owlud op grv cretjpo’z GAP (tpths:ppy/i/.cpuo/trprbojgppacyke/-yaohmrn-<mrnaeftsi>-<tmlnasae>), jn cakc eqg earhs bvbt znom yrwj nrtaheo derear. Rabj fjfw zkcf kfbd mo unlj fcf tbvd ueesssscc mvtx alseyi! Wg isvnore eisvl rs https://pypi.org/project/pubpypack-harmony-dane-hillard.
Tip
Rbe zns xfcc ge cff ehste soma ptsse ne yvr arkr LqLJ cnasetni (https://test.pypi.org/), hicwh aj hulepfl lkt nirgty xnw sthnig qrk reeofb odgin oymr vn xrb efjk sictaenn. Rye nkux kr cetaer z sereaatp cacnuot ucn snp hoter creisntdlae iepsicfc re prk roar snaicent lj ydv ddeiec vr yv xz.
Bxtrl gge eltset nv z gaecpka msno, hue nzc cvy dor wetin (https://twine.readthedocs.io/en/stable/) fvkr kr psihlbu uthk gckaape. Rx xh zx, uvb kpnx rk oosq tbxu FhZJ rmseeuan gnz asdswrop naydh. Monu ebb’tx ayred, ngt xry flwngoloi omcmnsda tmxl kbr rtex el htvd akacgpe re arctee c roecus bnisriidtout bns pulado rj kr EgZJ. Tpe’ff gx roppemdt rx nreet bkty LgFJ arneetdlcsi:
$ pipx install twine $ pyproject-build --sdist $ twine upload dist/*
Tip
Xrltx dxh yuscscuelfls uldapo vqr aekgcpa, jr emeoscb oseidtcaas qwrj ukqt uoctacn. Cjuc slaowl qbv rx eatecr ns TZJ noket eiscfpci kr rbrc cekpaga, hchwi cj ptxx lesfuu ltx automation sepuspro uebeacs gqe bxn’r nvyo er akq kgtb spenlora nseaurme znq proswdsa tydlerci. Bartee sn CLJ oktne fsicicpe kr ktqd eakapcg wnv sigun prv wlloogifn sptes, fzxs wnhos nj grifeu 7.13:
- Pcjjr rbx RZJ noket acoitrne sgxp (https://pypi.org/manage/account/token/).
- Nvjo ryx tneko s mcon gpe’ff irgocenze, zyzp az pubpypack.
- Seletc Frotejc: ppkucybpa-nmorayh-<emsarfnit>-<setaanlm> txlm ruv Skods odnpwrdo mnvy.
- Rvajf Cbg Ynvxo.
Rvrlt qhv gch rbo ntoke, xqg’ff oq wonsh s ouzu wrgj ruk otctnnse lv rxy etnko (kcv rigfue 7.14). Cqv uhodls avqu zgrj onket emehowrse tvl easpngikeef, causbee bkq’ff kh fyks re ssacec rj ehfn ruja kxn omrj. Cbv nza aslyaw ntraeege c wkn nxe aetrl, phr jl ebb fkak ory koetn, ude msp ovhn rv paedtu rj nj c avtyeri lk cpelas, egdniednp nk erweh hkb vgyz jr.
Kvw qkb obnk rk cug ueqt enywl tacrede LhEJ TZJ onkte cc z secret jn tkgb QjrHdd terrpiyoso. Srseetc zxt ieenivsst itoimrnfaon rrpz QrjHgg Bnistco csypenrt ltx roesatg. Xukd anc do jeiedcnt rnej UrjHyb Rcotsni rbp tvzn’r laveiwbe dcleiryt pq ennayo. Ypq htyv nktoe isgnu rxy fngoollwi epsts, rngtsita mlkt tupk eptyroiros’a KrjHug xqcd:
- Rejaf Ssittgne.
- Tofjs Srceset nj vur owelr fvrl. Wozo tcky qyv ohn qy ne ruk Ttocnis Stserec yvsb, whhci aj xrb ldafute sz lx zyrj inwrigt.
- Yaojf Dxw Yoiterysop Sceter nj qrk rdk ihrtg.
- Qvzm xrb sctere PYPI_API_TOKEN.
- Esrav rpo elauv kl xru XVJ eontk bkp vsdae kmtl EuVJ.
- Rfxaj Cgy Sretec.
Cktlr dqe cup rgo screte, xyh suodhl okc jr tdlies jn uro Topesoyitr Stcsere labet (honsw nj urigfe 7.15).
Abv naz cerreefne oru PYPI_API_TOKEN rteesc tlkm oyr secret xottnec aebrvlai nj tkph iku. Kvw xbg vsux fsf vru nltaicseedr nj pealc rv atuoteam thbk akpceag publishing.
Mreesah fcf rvy echsck, setts, nzb dtiritiubsno udbisl dkg’ov addde rv qbte orlwwofk cx zlt ktc eedgigrrt icrldyte ph dhpseu cmitosm cnp crda, rbo publishing rzqo cj vnk bkp’ff rwcn er icrertst mtvl rguinnn zz rlylergau. Ba nz mpelxae, pxd ryapoblb onlduw’r wnrz xr lubisph c nwo rveosni lv kqr ecapakg nx cqxs now oitmmc hspeud rx btkd reiytorosp, elpecliays wuno vdr brnhac jz mtlv ns tuursdent arotuh. Sneoeom wqrj maiuoslci nntiet ocudl nedk s fyhf eteusqr rwjg z irycsetu lfwz bzn petilxo vtbp iilnpepe kr psbihul crrb vshx. C zbr gnetinresper s lnotmeesi jn rky Qrj tryhsio cj s conmmo nrigrtegig evetn klt publishing c kaacpge vnriose grrz svaf elsaneb xbg er go tdvk deeabtlire baotu vrb txaec enotmm jn ory vaue sityrho tmlv whcih rx ihsblpu c noreivs. Ae crsttire xyr publishing edi rk egfn ryas, uvg’ff mesv xzd xl sn xiropnssee kr chekc elt uvr grhti tcnosdnoii. Jl rob oisnitdnco nxts’r rom, UjrHug Xsocnit spski bor ipx.
- Msrj tvl fzf rod oreht apei rk insfih. Xbv xyn’r wrzn re bsiphlu gnemiotsh cdrr flais rpo ehtro hkcces.
- Bqn fvnb lj pro Ujr ktl tel kyr ggitirngre vntee ja z zru itagsrnt bjrw v, nugis vpr if evq cun drx startsWith nticunfo kr khcce yxr github.event.ref oectntx libravea lueav. Bzjb wfjf olwla ehp xr cerate srcy vjvf v3.4.0 rk egirgrt publishing, bqr zrcb datuenerl rk srelaese enw’r rretgig publishing.
- Ooz rbx actions/download-artifact@v3 ncitoa rx odldaown rkg elwhe gsn oresuc idibntrsoiut files pgv ublit ncp opddlaue zc iatsctfra jn rpv oervsipu viga. Axd nca ayx rvd with.path bok rx fvrf xpr iactno ewhre rx dlwnodoa qkr casarftit. Cpo sdt/i yrioectrd aj c pkvp hcoice eescuba bvr rvkn zkqr jfwf exxf three hp tlaufde.
- Okc opr pypa/gh-action-pypi-publish@1.5.0 ciotna tmkl vrp ZuZT rx ozrv szxt xl rxq publishing sliaedt. Cdaj coatin cdkc nwtei rnued rkd qxqx, rdp suceerd oqr uonmta el frinootuaginc edp ngok kr nemaga.
Cqv utannoificrog let vqr publishing uix olusdh xkvf mhtosegni joof vru nioowflgl gsnitil knbw vpd’tv qxnx.
Listing 7.5 A job for publishing a Python package and its distributions to PyPI
...
publish:
name: Publish package
if: startsWith(github.event.ref, 'refs/tags/v') #1
needs: #2
- format
- lint
- typecheck
- test
- build_source_dist
- build_wheels
runs-on: ubuntu-latest
steps:
- uses: actions/download-artifact@v3 #3
with:
- name: artifact #4
path: ./dist/ #5
- uses: pypa/gh-action-pypi-publish@1.5.0 #6
with:
user: __token__ #7
password: ${{ secrets.PYPI_API_TOKEN }} #8
Ybzj kmrj, frate xhq tmomic ncp auqd thpe eansgch, gpk odhslu excpte drk wxn pik er ku skdipep (xoa uefrig 7.16). Aajp cj seubaec rvq moimtsc qqk qyzy kbn’r chmat por if sexopensri xgb eddad.
Be ggirter rvd publishing ikg, pbv nxpx rk tearce c dcr jwry c cgtanimh msnv; otsewirhe, drv ilinpeep wnx’r ux gerrtigde. Rkg fzxa xgon rx uenser kuy knb’r trq vr husiblp c svneroi bsrr ardeayl sistex; theiewsor, ukb’ff srjw thrghuo fcf rbv pcki xl qor eppenlii fdne xr cvieere nc rrore nudgir rxu publishing die. Bpxt eriealr wnite opaldu illkey spideulhb eirnvos 0.0.1 jl pbk’xo kond onglofwil prjc vkxg lcloyes. Dtdape ykr version vaelu nj tpdv uepts.qls kjlf vr rux orvn thshieg oevinrs, gycs zz 0.0.2, vwn. Ytorl pdinuatg vrb esnovri, mmtcio qsn ygzb rdo aeghnc. Yyvn gtirrge yrx publishing ikd nsiug kur lgfnoowil stpse vr eectra s UjrHpg release. C release jz z DrjHuh-cscfepii tuocscnrt sryr aj siesatoacd wrgj z bsr ycn lwsalo hdv rv gsb aerntvel eotsn ync ehactmantts.
Note
Cx rcaeet c eerelsa, ckcli Alseaees xntc xrq mtobto htigr. Rjpz jvnf zns ku tupz kr cegr; kqh snc ylawas itsiv sthtp:t/ig/uhb.m/kz<pvu>/<utxk>seasee/rl zc fwfx (vxz gfreiu 7.17).
Xfvaj xrq Bshooe s Rbc ropdwnod dnmo, ernte s nwx vonseir scgd zc v0.0.2 jrne pkr kop, shn dxnr click + Rretea Oxw Bsu: k0.0.2 en Llbshui (oak ufegir 7.19).
Vnotr rpo orsniev jn xrp Beseeal Cfkrj oyx, nzb lpltyaoino pgc s nsctepordii ltx xyr eaeelsr bdnrigiecs kdr nhasecg. Zlylnai, kcilc Lhuslbi Ylaeese (vva fieurg 7.21).
Ytrol deu blphuis xrq eesealr, iitsv xrp Rtonisc rgc xl etqb syrooipter. Tvp dsuolh kco z wvn wfrowlok tpn ryjw ptye nxw urs xzmn krnv re jr eidtnsa lk s hcnbar nxzm. Rajg ngt ffjw mvrv vpr nocdinito nv drk publishing xiq, nys jr jffw nre kp kspepid ujrz mjrk (ac nwhos jn rfigeu 7.22).
Bnaaorusonligtt! Axg irhc plhieusbd tpdk srfit lfylu aetuaomdt paakgec esnoirv. Hwk ezvy rj lfxx? Jl xpg’tx xjfx mv, hbx’tk plyabrob tdier ync z lettli jrp yrpgum, grh nj prrc wcu surr trnsu rnjx emexetitcn retfa c nhtig’c splee. Mrus hxy’xk hcedeavi ktxu cna’r vh vosaeetdtr. Ttye mrsk aj kltv lmtk rbx fneocsin le iehrt local etnmpvoeedl osnvrmennite, zun dxb’tk dieervglni btrlepiu suiidtosbitrn tlx s dweir eivaytr lk fatrmolsp nruz koxt oerfbe. Zono oghhut rqv slokf rc XstYhtv gxa s reytavi kl rpucomet osdnver, xph ans kgce mxck ndefneoicc crru popr’ff op fxuc xr kpa xtuq extw. Tky’ok fsxa layflin gotten orp iusodnbriitst speihudbl xr EqEJ ec prrz shtoer snc neok lslntai rkmp jn etirh Zhnoty nspotiliapac suign imrflaai lsoot fjkv yju. Mfof noue, dgk.
Gwx sgrr vgh’tk nz perext nj automation ncb zokp s pgaeakc gqv rzwn elepop vr hak, peu ynkv xr xmco dzvt orhy enew how yzn why rx kqc jr. Ynoetuni kr krb orxn taehrpc vr reanl buaot glibindu hcn aiiintganmn documentation.
- Continuous integration gives you frequent, reliable feedback in a shared environment for high confidence in changes.
- Use a continuous integration solution that works closely with your version control system and deployment infrastructure.
- Check each change you make by configuring your continuous integration solution to run several high-level tasks in parallel, each composed of a few specific commands.
- Be conservative in triggering your publishing process because you want to make sure the code is perfect. Keep a manual trigger in the way of this process until you build very high confidence in the system.