Gestire le release e lo sviluppo con i rami

Giulio@754: Giulio@754: Giulio@754: Gestire le release e lo sviluppo con i rami Giulio@754: Giulio@763: Mercurial vi fornisce diversi meccanismi per gestire un progetto che sta facendo progressi su più fronti contemporaneamente. Per comprendere questi meccanismi, come prima cosa daremo una breve occhiata alla struttura di un progetto software abbastanza ordinario. Giulio@763: Giulio@763: Molti progetti software distribuiscono periodicamente release principali (o maggiori) che contengono nuove funzionalità sostanziali. In parallelo, possono distribuire release secondarie (o minori) che di solito sono identiche alle release principali su cui sono basate e in più contengono alcune correzioni di bug. Giulio@763: Giulio@792: In questo capitolo, cominceremo parlando di come mantenere una registrazione delle milestone di progetto come le release, poi continueremo parlando del flusso di lavoro tra fasi differenti di un progetto e di come Mercurial può aiutarvi a isolare e gestire questo lavoro. Giulio@754: Giulio@754: Giulio@754: Dare un nome persistente a una revisione Giulio@754: Giulio@792: Una volta che avete deciso che vi piacerebbe chiamare release una particolare revisione, è una buona idea registrare l'identità di quella revisione. Questo vi permetterà di riprodurre quella release in un momento successivo, qualsiasi sia lo scopo che avete bisogno di raggiungere in quel momento (riprodurre un bug, convertirla verso una nuova piattaforma, etc). Giulio@792: Giulio@792: &interaction.tag.init; Giulio@754: Giulio@763: Mercurial vi consente di dare un nome permanente a qualsiasi revisione usando il comando hg tag. Ovviamente, questi nomi sono chiamati etichette (in inglese, appunto, tag). Giulio@754: Giulio@754: &interaction.tag.tag; Giulio@754: Giulio@763: Un'etichetta non è altro che un nome simbolico per una revisione. Le etichette esistono puramente per la vostra convenienza: vi offrono un modo comodo e permanente per fare riferimento a una revisione. Mercurial non interpreta in alcun modo i nomi delle etichette che usate, né impone alcuna restrizione sul nome di un'etichetta a parte le poche che sono necessarie affinché l'etichetta possa essere riconosciuta senza ambiguità. Un nome di etichetta non può contenere i seguenti caratteri: Giulio@754: Giulio@754: due punti (ASCII 58, Giulio@754: :) Giulio@754: Giulio@754: ritorno a capo (ASCII 13, Giulio@754: \r) Giulio@754: Giulio@754: nuova riga (ASCII 10, Giulio@754: \n) Giulio@754: Giulio@754: Giulio@763: Potete usare il comando hg tags per visualizzare le etichette presenti nel vostro repository. Nel risultato del comando, ogni revisione etichettata è identificata prima dal proprio nome, poi dal numero di revisione e infine dall'hash unico della revisione. Giulio@754: Giulio@754: &interaction.tag.tags; Giulio@754: Giulio@763: Notate che tip viene inclusa nell'elenco mostrato da hg tags. L'etichetta tip è una speciale etichetta mobile che identifica sempre la revisione più recente contenuta in un repository. Giulio@763: Giulio@763: Il comando hg tags elenca le etichette in ordine inverso secondo il numero di revisione. Di solito questo significa che le etichette recenti vengono elencate prima delle etichette più vecchie. Significa anche che tip è sempre la prima etichetta elencata nel risultato di hg tags. Giulio@763: Giulio@763: Il comando hg log stamperà le etichette associate a ogni revisione visualizzata. Giulio@754: Giulio@754: &interaction.tag.log; Giulio@754: Giulio@763: I comandi Mercurial a cui dovete passare un identificatore di revisione accetteranno il nome di un'etichetta al suo posto. Internamente, Mercurial tradurrà il nome della vostra etichetta nel corrispondente identificatore di revisione e poi userà quest'ultimo per operare. Giulio@754: Giulio@754: &interaction.tag.log.v1.0; Giulio@754: Giulio@763: Non c'è alcun limite al numero di etichette che potete avere in un repository, o al numero di etichette che una singola revisione può avere. Nella pratica, non è una grande idea averne troppe (un numero che varierà da progetto a progetto), semplicemente perché le etichette sono pensate per aiutarvi a rintracciare le revisioni: se avete molte etichette, la comodità di usarle per identificare le revisioni diminuisce rapidamente. Giulio@763: Giulio@792: Per esempio, se il vostro progetto definisce nuove milestone con una frequenza di alcuni giorni, è perfettamente ragionevole dotare ognuna di un'etichetta. Ma se avete un sistema di assemblaggio continuo che si assicura di poter assemblare ogni revisione in modo pulito, introdurreste troppo rumore etichettando ogni assemblaggio pulito. Invece, potreste etichettare gli assemblaggi falliti (supponendo che siano rari!) o semplicemente evitare di usare le etichette per tenere traccia degli assemblaggi. Giulio@754: Giulio@754: Se volete rimuovere un'etichetta che non volete più, usate hg tag --remove. Giulio@754: Giulio@754: &interaction.tag.remove; Giulio@754: Giulio@763: Potete anche modificare un'etichetta in qualsiasi momento, in modo che identifichi una revisione differente, semplicemente invocando di nuovo il comando hg tag. Dovrete usare l'opzione per dire a Mercurial che volete davvero aggiornare l'etichetta. Giulio@754: Giulio@754: &interaction.tag.replace; Giulio@754: Giulio@763: La precedente identità dell'etichetta rimarrà permanentemente registrata, ma Mercurial non la userà più. Quindi non c'è alcuna penalità da pagare se etichettate la revisione sbagliata, ma tutto quello che dovete fare dopo aver scoperto il vostro errore è tornare sui vostri passi ed etichettare la revisione corretta. Giulio@763: Giulio@792: Mercurial memorizza le etichette nel vostro repository in un normale file soggetto al controllo di revisione. Troverete le etichette che avete creato in un file chiamato .hgtags alla radice del vostro repository. Quando eseguite il comando hg tag, Mercurial modifica questo file, poi ne effettua automaticamente il commit registrandone i cambiamenti. Questo significa che ad ogni esecuzione di hg tag corrisponderà un changeset nell'elenco mostrato da hg log. Giulio@754: Giulio@754: &interaction.tag.tip; Giulio@754: Giulio@754: Giulio@754: Gestire i conflitti di etichette durante un'unione Giulio@754: Giulio@796: Avrete raramente bisogno di preoccuparvi del file .hgtags, ma talvolta la sua presenza si farà sentire durante un'unione. Il formato del file è semplice: consiste di una serie di righe, ognuna delle quali comincia con un hash di changeset, seguito da uno spazio, seguito dal nome di un'etichetta. Giulio@763: Giulio@763: Se state risolvendo un conflitto nel file .hgtags durante un'unione, c'è una particolarità da ricordare quando modificate il file .hgtags: quando Mercurial sta analizzando le etichette in un repository, non legge mai la copia di lavoro del file .hgtags, ma legge la revisione del file registrata più recentemente. Giulio@763: Giulio@796: Una sfortunata conseguenza di questo comportamento è che non potete verificare la correttezza del file .hgtags risultato dall'unione se non dopo aver effettuato il commit di un cambiamento. Quindi, se vi trovate a risolvere un conflitto su .hgtags durante un'unione, assicuratevi di eseguire hg tags dopo aver effettuato il commit. Se il comando trova un errore nel file .hgtags, vi indicherà la posizione dell'errore, che potrete dunque correggere, registrando la correzione nel repository. Dovreste poi eseguire ancora hg tags, giusto per essere sicuri che la vostra correzione sia valida. Giulio@754: Giulio@754: Giulio@754: Giulio@754: Etichette e cloni Giulio@754: Giulio@763: Potreste aver notato che il comando hg clone offre un'opzione per lasciarvi clonare la copia esatta di una particolare revisione di un repository. Il nuovo clone non conterrà alcuna cronologia del progetto registrata dopo la revisione che avete specificato. Questa operazione interagisce con le etichette in un modo che potrebbe sorprendere i più distratti. Giulio@763: Giulio@763: Se ricordate, un'etichetta viene memorizzata come una revisione del file .hgtags. Quando create un'etichetta, il changeset in cui viene registrata si riferisce a un changeset precedente. Quando eseguite hg clone -r foo per clonare un repository all'etichetta foo, il nuovo clone non conterrà alcuna revisione più recente di quella a cui si riferisce l'etichetta, compresa la revisione in cui l'etichetta è stata creata. Come risultato, otterrete esattamente il sottoinsieme corretto della cronologia del progetto nel nuovo repository, ma non l'etichetta che vi sareste potuti aspettare. Giulio@754: Giulio@754: Giulio@754: Giulio@754: Quando le etichette permanenti sono eccessive Giulio@754: Giulio@763: Dato che le etichette di Mercurial sono soggette a controllo di revisione e fanno parte della cronologia del progetto, chiunque lavori con voi vedrà le etichette che avete creato. Ma i nomi delle revisioni possono essere usati in modi che vanno oltre la semplice annotazione che la revisione 4237e45506ee è in realtà la v2.0.2. Se state provando a rintracciare un bug intricato, poteste volere un'etichetta per ricordarvi di qualcosa come Anna ha visto gli effetti del bug in questa revisione. Giulio@763: Giulio@763: In casi come questo, quello che potreste voler usare sono le etichette locali. Un'etichetta locale viene creata tramite l'opzione del comando hg tag e viene memorizzata in un file chiamato .hg/localtags. Diversamente da .hgtags, .hg/localtags non è soggetto a controllo di revisione, quindi qualsiasi etichetta creiate usando l'opzione rimarrà strettamente locale al repository in cui state attualmente lavorando. Giulio@754: Giulio@754: Giulio@754: Giulio@754: Giulio@754: Il flusso dei cambiamenti&emdash;la visione d'insieme e la visione di dettaglio Giulio@754: Giulio@792: Per ritornare allo schema abbozzato all'inizio del capitolo, consideriamo un progetto che contiene molteplici attività di sviluppo parallele in lavorazione contemporaneamente. Giulio@763: Giulio@763: Potrebbero esserci attività dedicate a una nuova release principale, a una nuova release minore che corregge alcuni bug trovati nell'ultima release principale e a un'inattesa correzione a caldo di una vecchia release che ora si trova in fase di manutenzione. Giulio@763: Giulio@763: Di solito, ognuna di queste direzioni di sviluppo parallele viene chiamata ramo (in inglese, branch). Tuttavia, abbiamo già visto più volte che Mercurial tratta tutta la cronologia come una serie di rami e unioni. In realtà, quello che abbiamo qui sono due idee marginalmente correlate che condividono casualmente lo stesso nome. Giulio@754: Giulio@763: Nella visione d'insieme i rami rappresentano il flusso dell'evoluzione di un progetto. Ognuno di questi rami ha il proprio nome ed è oggetto di conversazione tra gli sviluppatori. Giulio@754: Giulio@763: Nella visione di dettaglio i rami sono artefatti costruiti durante l'attività quotidiana di sviluppo e unione dei cambiamenti. Questi rami narrano la storia di come il codice è stato sviluppato. Giulio@754: Giulio@754: Giulio@754: Giulio@754: Giulio@754: Gestire i rami nella visione d'insieme Giulio@754: Giulio@792: Nella visione d'insieme, il modo più facile per isolare un ramo in Mercurial è quello di utilizzare un repository dedicato. Se avete un repository condiviso esistente&emdash;chiamiamolo mioprogetto&emdash;che raggiunge una milestone 1.0, potete cominciare a preparare le future release di manutenzione basate sulla versione 1.0 etichettando la revisione dalla quale avete preparato la release 1.0. Giulio@754: Giulio@754: &interaction.branch-repo.tag; Giulio@754: Giulio@792: Potete quindi clonare un nuovo repository condiviso mioprogetto-1.0.1 da quella etichetta. Giulio@754: Giulio@754: &interaction.branch-repo.clone; Giulio@754: Giulio@792: Successivamente, chi ha bisogno di lavorare sulla correzione di un bug che dovrebbe essere contenuta in una prossima release minore 1.0.1 potrà clonare il repository mioprogetto-1.0.1, fare le proprie modifiche e poi trasmetterle a quel repository. Giulio@754: Giulio@754: &interaction.branch-repo.bugfix; Giulio@754: Giulio@763: Nel frattempo, lo sviluppo della prossima release principale può continuare, isolato e ininterrotto, nel repository mioprogetto. Giulio@754: Giulio@754: &interaction.branch-repo.new; Giulio@754: Giulio@754: Giulio@754: Giulio@763: Non ripetetevi: le unioni tra rami Giulio@763: Giulio@792: In molti casi, se avete un bug da correggere su un ramo di manutenzione, è probabile che il bug sia presente anche sul ramo principale del progetto (e magari anche su altri rami di manutenzione). È raro che uno sviluppatore voglia correggere lo stesso bug più volte, quindi diamo un'occhiata ad alcuni modi in cui Mercurial può aiutarvi a gestire queste correzioni senza duplicare il vostro lavoro. Giulio@763: Giulio@763: Nel caso più semplice, tutto quello che dovete fare è propagare i cambiamenti dal vostro ramo di manutenzione al vostro clone locale del ramo di destinazione. Giulio@754: Giulio@754: &interaction.branch-repo.pull; Giulio@754: Giulio@792: Poi dovrete unire le teste dei due rami e trasmettere i cambiamenti al ramo principale. Giulio@754: Giulio@754: &interaction.branch-repo.merge; Giulio@754: Giulio@754: Giulio@754: Giulio@754: Denominare i rami in un repository Giulio@754: Giulio@792: Nella maggior parte dei casi, isolare ogni ramo in un proprio repository è l'approccio giusto, perché la sua semplicità lo rende facile da capire e quindi è difficile commettere errori. Esiste una relazione uno-a-uno tra i rami in cui state lavorando e le directory sul vostro sistema che vi consente di usare strumenti ordinari (ignari dell'esistenza di Mercurial) per lavorare sui file all'interno di un ramo/repository. Giulio@763: Giulio@763: Se invece appartenete alla categoria degli utenti avanzati (e vi appartengono anche i vostri collaboratori), potete considerare un modo alternativo di gestire i rami. Ho già menzionato la distinzione con cui gli sviluppatori percepiscono i rami nella visione di dettaglio e nella visione d'insieme. Se Mercurial lavora con molteplici rami di dettaglio alla volta in un repository (per esempio dopo che avete propagato i cambiamenti, ma prima di incorporarli), può anche lavorare con molteplici rami d'insieme. Giulio@763: Giulio@763: La chiave per lavorare in questo modo è che Mercurial vi permette di assegnare un nome persistente a un ramo. In ogni repository c'è sempre un ramo chiamato default. Anche prima che cominciate a creare voi stessi nuovi rami con il proprio nome, potete trovare tracce del ramo default se le cercate. Giulio@763: Giulio@792: Per esempio, quando eseguite il comando hg commit e vi viene presentato un editor in modo che possiate inserire un messaggio di commit, cercate una riga che contiene il testo HG: ramo default verso il fondo. Questo comando vi informa che il vostro commit avverrà sul ramo chiamato default. Giulio@754: Giulio@754: Per cominciare a lavorare con i rami con nome, usate il comando hg branches. Questo comando elenca i rami con nome già presenti nel vostro repository, dicendovi quale changeset è in cima a ognuno di loro. Giulio@754: Giulio@754: &interaction.branch-named.branches; Giulio@754: Giulio@763: Dato che non avete ancora creato alcun ramo con nome, l'unico ramo esistente è default. Giulio@763: Giulio@792: Per trovare qual è il ramo attuale, eseguite il comando hg branch senza passargli alcun argomento. Otterrete il nome del ramo in cui trova il genitore del changeset corrente. Giulio@754: Giulio@754: &interaction.branch-named.branch; Giulio@754: Giulio@763: Per creare un nuovo ramo, eseguite ancora il comando hg branch. Questa volta, passategli un argomento: il nome del ramo che volete creare. Giulio@754: Giulio@754: &interaction.branch-named.create; Giulio@754: Giulio@763: Dopo che avete creato un ramo, potreste chiedervi qual è stato l'effetto del comando hg branch. Che cosa ci dicono i comandi hg status e hg tip? Giulio@754: Giulio@754: &interaction.branch-named.status; Giulio@754: Giulio@796: Nulla è cambiato nella directory di lavoro e non è stata creata nuova cronologia. Come queste osservazioni suggeriscono, il comando hg branch non ha alcun effetto permanente, ma si limita a dire a Mercurial quale nome di ramo usare la prossima volta che effettuerete il commit di un changeset. Giulio@763: Giulio@763: Quando inserite un cambiamento nel repository, Mercurial registra il nome del ramo su cui lo avete inserito. Una volta che siete passati dal ramo default a un altro e avete eseguito il commit, vedrete apparire il nome del nuovo ramo nel risultato di hg log, hg tip e altri comandi che mostrano lo stesso tipo di informazioni. Giulio@754: Giulio@754: &interaction.branch-named.commit; Giulio@754: Giulio@763: I comandi come hg log stamperanno il nome del ramo di ogni changeset che non appartiene al ramo default. Come risultato, se non avete mai usato i rami con nome, non vedrete mai questa informazione. Giulio@754: Giulio@754: Una volta che avete denominato un ramo e inserito un cambiamento in quel ramo, ogni commit successivo che discende da quel cambiamento erediterà lo stesso nome di ramo. Potete cambiare il nome a un ramo in ogni momento, usando il comando hg branch. Giulio@754: Giulio@754: &interaction.branch-named.rebranch; Giulio@754: Giulio@792: In pratica, questa non è una cosa che farete molto spesso, dato che i nomi di ramo tendono ad avere un tempo di vita piuttosto lungo. (Questa non è una regola, ma solo un'osservazione.) Giulio@754: Giulio@754: Giulio@754: Giulio@754: Gestire molti rami con nome in un repository Giulio@754: Giulio@792: Se un repository contiene più di un ramo con nome, Mercurial ricorderà il ramo su cui si trova la vostra directory di lavoro quando eseguite un comando come hg update o hg pull -u e aggiornerà la directory di lavoro alla revisione di punta di quel ramo, a prescindere da quale sia la punta dell'intero repository. Per aggiornare la directory di lavoro a una revisione che si trova su un ramo con un nome diverso, potreste dover usare l'opzione del comando hg update. Giulio@792: Giulio@792: Questo comportamento è leggermente complicato, quindi vediamolo in azione. Per prima cosa, controlliamo su quale ramo ci troviamo al momento e quali sono i rami contenuti nel nostro repository. Giulio@754: Giulio@754: &interaction.branch-named.parents; Giulio@754: Giulio@754: Ci troviamo sul ramo bar, ma esiste anche un ramo più vecchio chiamato foo. Giulio@754: Giulio@754: Possiamo utilizzare hg update per spostarci avanti e indietro tra le revisioni di punta dei rami foo e bar senza aver bisogno di impiegare l'opzione , perché questi spostamenti avvengono linearmente attraverso la nostra cronologia dei cambiamenti. Giulio@754: Giulio@754: &interaction.branch-named.update-switchy; Giulio@754: Giulio@792: Se torniamo indietro al ramo foo e invochiamo hg update, il comando ci manterrà su foo piuttosto che spostarci alla punta di bar. Giulio@754: Giulio@754: &interaction.branch-named.update-nothing; Giulio@754: Giulio@763: Il commit di una nuova modifica sul ramo foo introduce una nuova testa. Giulio@754: Giulio@754: &interaction.branch-named.foo-commit; Giulio@754: Giulio@754: Giulio@754: Giulio@754: I nomi di ramo e le unioni Giulio@754: Giulio@792: Come avete probabilmente notato, le unioni in Mercurial non sono simmetriche. Diciamo che il nostro repository possiede due teste, 17 e 23. Se uso hg update per aggiornare alla 17 e poi eseguo hg merge per incorporare la 23, Mercurial registra la 17 come primo genitore dell'unione e la 23 come secondo. Ma se uso hg update per aggiornare alla 23 e poi eseguo hg merge per incorporare la 17, Mercurial registra la 23 come primo genitore e la 17 come secondo. Giulio@792: Giulio@792: Questo comportamento influenza la scelta del nome di ramo compiuta da Mercurial quando effettuate un'unione. Dopo un'unione, Mercurial manterrà il nome del ramo del primo genitore quando registrate i risultati dell'unione. Se il nome del ramo del primo genitore è foo e unite quel ramo con bar, dopo l'unione il nome del ramo in cui vi troverete sarà ancora foo. Giulio@763: Giulio@763: Capita spesso che un repository contenga più teste, ognuna con lo stesso nome di ramo. Diciamo che io sto lavorando sul ramo foo e così fate anche voi. Eseguiamo il commit di cambiamenti differenti, dopodiché io estraggo i vostri cambiamenti e mi ritrovo con due teste, ognuna che dichiara di appartenere al ramo foo. Sperabilmente, il risultato di un'unione sarà una singola testa sul ramo foo. Giulio@754: Giulio@755: Ma se io sto lavorando sul ramo bar e incorporo il lavoro dal ramo foo, il risultato rimarrà sul ramo bar. Giulio@754: Giulio@754: &interaction.branch-named.merge; Giulio@754: Giulio@773: Per farvi un esempio più concreto, se sto lavorando sul ramo sperimentale e voglio incorporare le ultime correzioni dal ramo stabile, Mercurial sceglierà il nome del ramo corretto (sperimentale) quando estrarrò e incorporerò i cambiamenti da stabile. Giulio@754: Giulio@754: Giulio@754: Giulio@754: La denominazione dei rami è generalmente utile Giulio@754: Giulio@763: Non dovreste pensare che i rami con nome si possano utilizzare solo in situazioni dove avete molteplici rami di lunga data che coabitano in un singolo repository. Sono molto utili anche nel caso in cui utilizziate un singolo ramo per repository. Giulio@763: Giulio@792: Nel caso più semplice, dare un nome a ogni ramo vi offre una registrazione permanente dell'identità del ramo da cui un changeset ha avuto origine. Questo vi fornisce un contesto più ampio quando state cercando di seguire la cronologia di un progetto ramificato di lunga data. Giulio@763: Giulio@773: Se state lavorando con repository condivisi, potete impostare un hook pretxnchangegroup su ogni repository in modo da bloccare i cambiamenti in entrata che appartengono al nome di ramo sbagliato. Questo accorgimento vi offre una difesa semplice ma efficace nei confronti di chi trasmette accidentalmente i cambiamenti da un ramo sperimentale a un ramo stabile. Un hook di questo tipo potrebbe somigliare al seguente, contenuto all'interno del file /.hgrc del repository condiviso. Giulio@754: [hooks] Giulio@792: pretxnchangegroup.branch = hg heads --template '{branches} ' | grep mioramo Giulio@754: Giulio@754: