Differenze

Queste sono le differenze tra la revisione selezionata e la versione attuale della pagina.

--- gwusermanual:handlerepository [2023/05/16 10:07]
giada.podelvento [Sincronizzare con il repository remoto]
+++ gwusermanual:handlerepository [2023/05/19 16:08] (versione attuale)
giada.podelvento
@@ Linea 62: / Linea 62: @@
 Una volta creato il [[gwusermanual:handlerepository#creazione_del_repository_remoto|repository remoto]] e averlo [[gwusermanual:handlerepository#creazione_del_repository_locale|clonato in locale]] è necessario dotare il progetto di una struttura specifica, adottata per convenzione, in modo tale che le risorse possano essere usate correttamente dai vari file eseguibili messi a disposizione per dispiegarle in maniera semiautomatica.
-La prima cosa da fare è cliccare sul seguente {{ :gwusermanual:progetto-template.zip |link}} e avviare il download della cartella ZIP contenente la struttura iniziale delle cartelle.  Al termine del download copiare il file zip nella cartella principale del repository locale (dove è già presente il file .git) e decomprimere qui il file. Una volta decompressa avremo così la seguente struttura {{ :gwusermanual:struttura_progetto_1.jpg?nolink |}}
+La prima cosa da fare è cliccare sul seguente {{ :gwusermanual:progetto-template.zip | link}}  e avviare il download della cartella ZIP contenente la struttura iniziale delle cartelle.  Al termine del download copiare il file zip nella cartella principale del repository locale (dove è già presente il file .git) e decomprimere qui il file. Una volta decompressa avremo così la seguente struttura {{ :gwusermanual:struttura_progetto_1.jpg?nolink |}}
 Di seguito riportiamo una breve descrizione di tutte le cartelle qui contenute.
@@ Linea 138: / Linea 138: @@
 Tutto ciò che è contenuto sotto la stringa ''<!-- NON MODIFICARE -->'' non necessita variazioni.
 Salvare le modifiche apportare e chiudere l'editor di testo.
+<color #ed1c24>**ACHTUNG!!**</color> Ricordarsi di aggiornare la versione di questo file (tag "version") quando si esegue un rilascio!!!
 ----
@@ Linea 190: / Linea 192: @@
 Le modifiche apportate ai vari file dipendono dal progetto, ma anche dall'ambiente in cui il progetto deve essere utilizzato, per qualsiasi dubbio rivolgersi alla sezione sviluppo
+----
+=== File ReleaseNotes.md ===
+Il file **ReleaseNotes.md** è un documento di testo formattato in formato Markdown ([[https://www.liberliber.it/progetti/manuzio/collaborare/manuale_markdown_20201226.pdf | Manuale]]) che contiene le note di rilascio del progetto. Le note di rilascio forniscono informazioni sugli aggiornamenti, le correzioni di bug, le nuove funzionalità e altre modifiche apportate nella versione specifica rilasciata.
+Alla prima apertura, il file presenta pochissime informazioni riassunte nel box di seguito
+<code>
+# Project Name - Release Notes
+## Version X.X.X
+Release Date: YYYY/MM/DD
+### Features
+### Bugfix
+### Deprecation and Removal
+</code>
+  * **Project Name** è il nome del progetto. Può coincidere con il nome del repository git
+  * **Version X.X.X** è la versione rilasciata. Sostituire X.X.X con la versione rilasciata. Le regole di versioning sono consultabili [[gwusermanual:handlerepository#regole_base_di_versionamento|qui]]
+  * **Release Date: YYYY/MM/DD** rappresenta la data di rilascio. Sostituire YYYY/MM/DD con la data del giorno in cui si esegue il rilascio
+  * **Features** contiene un elenco puntato delle nuove funzionalità aggiunte nella versione specifica oggetto di rilascio. Questa sezione fornisce una panoramica delle principali migliorie e aggiunte che gli utenti possono aspettarsi di trovare dopo l'aggiornamento. Le descrizioni delle nuove funzionalità spesso includono una breve spiegazione di cosa fanno e come possono essere utilizzate dagli utenti, senza entrare nel merito dei dettagli tecnici.
+  * **Bugfix** contiene informazioni sugli errori o problemi noti che sono stati risolti nella versione specifica oggetto di rilascio. Questa sezione elenca i bug o le anomalie che sono stati identificati e risolti: ogni voce di bugfix solitamente include una descrizione del problema risolto, i passi necessari per riprodurlo, e come è stata affrontata la correzione. Fornisce agli utenti una visione delle correzioni di bug apportate e degli eventuali problemi risolti per migliorarne la stabilità e l'esperienza utente.
+  * **Deprecation and Removal** indica le funzionalità, le API o altri componenti che sono stati contrassegnati come deprecati o rimossi nella versione specifica oggetto di rilascio. La deprecazione indica che una determinata funzionalità o componente è stata dichiarata obsoleta e verrà probabilmente eliminata nelle future versioni. Vengono inoltre fornite le informazioni sulle funzionalità deprecate o rimosse suggerendo, quando possibile, soluzioni alternative o sostitutive che possono essere utilizzate al loro posto.
+Ogni volta che viene eseguito un rilascio, è importante aggiornate le note di release, aggiornare il tag "version" sul [[gwusermanual:handlerepository#file_pomxml_esterno|pom esterno]] e seguire le regole di tag del repository descritte [[gwusermanual:handlerepository#rilascio_versione_e_tag|qui]]
 ===== Sincronizzare con il repository remoto =====