From 4505acd5ec33c65b675a2a01eca11b62ea1c149e Mon Sep 17 00:00:00 2001 From: Mariano Date: Wed, 8 Jan 2020 22:04:26 +0100 Subject: [PATCH 1/3] Modifica dei titoli e rimossa sezione artifacts #129 --- .../Sez2-ProcessiPrimari/Fornitura.tex | 2 ++ .../Sez2-ProcessiPrimari/processiPrimari.tex | 2 -- .../Sez3-ProcessiSupporto/Documentazione.tex | 4 ++- .../GestConfigurazione.tex | 31 ++++++++++--------- .../processiSupporto.tex | 2 -- .../GestProcessi.tex | 2 ++ .../processiOrganizzativi.tex | 2 -- 7 files changed, 23 insertions(+), 22 deletions(-) diff --git a/interni/norme_progetto/res/sections/Sez2-ProcessiPrimari/Fornitura.tex b/interni/norme_progetto/res/sections/Sez2-ProcessiPrimari/Fornitura.tex index a892a5c..0d521cd 100644 --- a/interni/norme_progetto/res/sections/Sez2-ProcessiPrimari/Fornitura.tex +++ b/interni/norme_progetto/res/sections/Sez2-ProcessiPrimari/Fornitura.tex @@ -1,3 +1,5 @@ +\section{Processi Primari} + \subsection{Fornitura} diff --git a/interni/norme_progetto/res/sections/Sez2-ProcessiPrimari/processiPrimari.tex b/interni/norme_progetto/res/sections/Sez2-ProcessiPrimari/processiPrimari.tex index c67a8e3..e64165d 100644 --- a/interni/norme_progetto/res/sections/Sez2-ProcessiPrimari/processiPrimari.tex +++ b/interni/norme_progetto/res/sections/Sez2-ProcessiPrimari/processiPrimari.tex @@ -1,4 +1,2 @@ -\section{Processi Primari} - \yetAnotherSectionNamed{Sez2-ProcessiPrimari/Fornitura} \yetAnotherSectionNamed{Sez2-ProcessiPrimari/Sviluppo} \ No newline at end of file diff --git a/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/Documentazione.tex b/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/Documentazione.tex index 942173f..88a28a8 100644 --- a/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/Documentazione.tex +++ b/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/Documentazione.tex @@ -1,4 +1,6 @@ -\subsection{Documentazione} +\section{Processi di Supporto} + + \subsection{Documentazione} \subsubsection{Scopo} Lo scopo principale di questo capitolo è fornire una guida esaustiva di tutti gli standard e regole per quanto riguarda la stesura ed approvazione dei documenti. diff --git a/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/GestConfigurazione.tex b/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/GestConfigurazione.tex index 77f9560..f69df45 100644 --- a/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/GestConfigurazione.tex +++ b/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/GestConfigurazione.tex @@ -83,7 +83,7 @@ \subsubsection{Versionamento e Rilascio} \paragraph{Documentazione} - Tutti i file che riguardano la documentazione vengono conservati in una repository e ogni documento viene versionato per mezzo di un identificativo, in base alla loro fase di avanzamento. Questo permette di poter fare riferimento alle nuove versioni del documento durante tutto il ciclo di vita del software.\\ + Tutti i file che riguardano la documentazione vengono conservati in una repository e ogni documento viene versionato per mezzo di un identificativo, in base alla loro fase di avanzamento. Questo permette di poter fare riferimento alle nuove versioni del documento durante tutto il ciclo di vita del software. \subparagraph{Codice di Versionamento} @@ -126,7 +126,7 @@ \subsubsection{Versionamento e Rilascio} \subparagraph{Rilascio} Un documento viene rilasciato alle parti proponenti solamente quando vi è un incremento del primo numero (\(\alpha\)), che ne implica una approvazione da parte del responsabile. \\ - Per quanto concerne la distribuzione interna, tutti gli \glock{artefatti} dei documenti realizzati durante la fase di sviluppo sono resi disponibili in modo rapido e automatizzato a tutti i membri del gruppo, a cui vengono notificate tutte le modifiche tramite il \glock{workspace} di \textit{Slack} (vedi \hyperref[sec:cd_docs]{\S 3.2.4.1}). + Per quanto concerne la distribuzione interna, tutti gli \glock{artefatti} dei documenti realizzati durante la fase di sviluppo sono resi disponibili in modo rapido e automatizzato a tutti i membri del gruppo, a cui vengono notificate tutte le modifiche tramite il \glock{workspace} di \textit{Slack}. \paragraph{Software} @@ -257,21 +257,22 @@ \subsubsection{Tecnologie} Nel nostro caso, le \glock{Github Actions} permettono di fare in un'unica configurazione i passaggi fondamentali in base al \glock{workflow} che ci interessa svolgere. +% ndr: RIMOSSO A SEGUITO DI COLLOQUIO CON TULLIO -\subsubsection{Processi di DevOps} % Da verificarne la posizione e il contenuto +% \subsubsection{Processi di DevOps} % Da verificarne la posizione e il contenuto - \paragraph{Countinuous Deployment dei documenti} - \label{sec:cd_docs} +% \paragraph{Countinuous Deployment dei documenti} +% \label{sec:cd_docs} - La repository è stata configurata per garantire una buona accessibilità e correttezza nello sviluppo dei documenti di progetto da parte dei membri del team. A tal proposito, è stato messo in atto un processo di \glock{Continuous Deployment} in ambiente di sviluppo, per avere sempre disponibili gli ultimi documenti modificati. +% La repository è stata configurata per garantire una buona accessibilità e correttezza nello sviluppo dei documenti di progetto da parte dei membri del team. A tal proposito, è stato messo in atto un processo di \glock{Continuous Deployment} in ambiente di sviluppo, per avere sempre disponibili gli ultimi documenti modificati. - \begin{enumerate} - \item Ad ogni \glock{commit} del branch \verb!develop!, viene fatta una \glock{build} di tutti i documenti modificati; - \item la \glock{build} crea un \glock{artefatto} con tutti i documenti PDF, che viene salvato online, oltre che nella repository, e reso disponibile per essere visionato da remoto: - \begin{itemize} - \item \href{https://artifacts.redroundrobin.site}{artifacts.redroundrobin.site} - \end{itemize} - \item Tramite gli appositi canali di comunicazione, vengono notificati tutti i membri del team delle nuove modifiche. - \end{enumerate} +% \begin{enumerate} +% \item Ad ogni \glock{commit} del branch \verb!develop!, viene fatta una \glock{build} di tutti i documenti modificati; +% \item la \glock{build} crea un \glock{artefatto} con tutti i documenti PDF, che viene salvato online, oltre che nella repository, e reso disponibile per essere visionato da remoto: +% \begin{itemize} +% \item \href{https://artifacts.redroundrobin.site}{artifacts.redroundrobin.site} +% \end{itemize} +% \item Tramite gli appositi canali di comunicazione, vengono notificati tutti i membri del team delle nuove modifiche. +% \end{enumerate} - Nel caso di \textbf{errori} nella compilazione dei file, viene inviato un avviso all'ultima persona che ha eseguito il \glock{commit} e vengono mantenuti gli ultimi file correttamente compilati. +% Nel caso di \textbf{errori} nella compilazione dei file, viene inviato un avviso all'ultima persona che ha eseguito il \glock{commit} e vengono mantenuti gli ultimi file correttamente compilati. diff --git a/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/processiSupporto.tex b/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/processiSupporto.tex index 792c148..b817789 100644 --- a/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/processiSupporto.tex +++ b/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/processiSupporto.tex @@ -1,5 +1,3 @@ -\section{Processi di supporto} - \yetAnotherSectionNamed{Sez3-ProcessiSupporto/Documentazione} \yetAnotherSectionNamed{Sez3-ProcessiSupporto/GestConfigurazione} \yetAnotherSectionNamed{Sez3-ProcessiSupporto/ProcDiRisoluzioneDeiProblemi} diff --git a/interni/norme_progetto/res/sections/Sez4-ProcessiOrganizzativi/GestProcessi.tex b/interni/norme_progetto/res/sections/Sez4-ProcessiOrganizzativi/GestProcessi.tex index 3210642..37cfd80 100644 --- a/interni/norme_progetto/res/sections/Sez4-ProcessiOrganizzativi/GestProcessi.tex +++ b/interni/norme_progetto/res/sections/Sez4-ProcessiOrganizzativi/GestProcessi.tex @@ -1,3 +1,5 @@ +\section{Processi Organizzativi} + \subsection{Gestione dei Processi} \subsubsection{Scopo} diff --git a/interni/norme_progetto/res/sections/Sez4-ProcessiOrganizzativi/processiOrganizzativi.tex b/interni/norme_progetto/res/sections/Sez4-ProcessiOrganizzativi/processiOrganizzativi.tex index 507bed3..7c9b2d5 100644 --- a/interni/norme_progetto/res/sections/Sez4-ProcessiOrganizzativi/processiOrganizzativi.tex +++ b/interni/norme_progetto/res/sections/Sez4-ProcessiOrganizzativi/processiOrganizzativi.tex @@ -1,5 +1,3 @@ -\section{Processi organizzativi} - \yetAnotherSectionNamed{Sez4-ProcessiOrganizzativi/GestProcessi} \yetAnotherSectionNamed{Sez4-ProcessiOrganizzativi/FormazionePersonale} \ No newline at end of file From b51816f9ad2a110fd78ce84c75bac0c2db3322c3 Mon Sep 17 00:00:00 2001 From: Mariano Date: Wed, 8 Jan 2020 23:21:34 +0100 Subject: [PATCH 2/3] Aggiunta nomenclatura baseline di prodotto e versione #129 --- .../GestConfigurazione.tex | 50 ++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/GestConfigurazione.tex b/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/GestConfigurazione.tex index f69df45..86f0f7c 100644 --- a/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/GestConfigurazione.tex +++ b/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/GestConfigurazione.tex @@ -81,6 +81,46 @@ \subsubsection{Repository} \subsubsection{Versionamento e Rilascio} + \paragraph{Prodotto} + + Il prodotto viene inteso come l'insieme di componenti che dovranno essere progettate, sviluppate, verificate e validate prima di essere consegnate al cliente. Il prodotto si compone principalmente di: + \begin{itemize} + \item documentazione; + \item software. + \end{itemize} + + Ciascuna componente viene versionata seguendo la propria evoluzione, mentre nel caso del prodotto si segue un versionamento più macroscopico e basato sulla \glock{baseline}. + Nell'ambito del progetto, il gruppo ha deciso di integrare una prassi di versionamento che permetta di avere un riferimento del prodotto dalle singole componenti sviluppate. + + \subparagraph{Codice di Versionamento} + + Per una versione del prodotto associato a una baseline si associa il seguente identificativo: + + \[% + \text{@}[\alpha].[\beta] + \] + + \begin{itemize} + \item \((\alpha)\): numero identificativo del rilascio del prodotto; + \begin{itemize} + \item parte da 0 e non si resetta mai; + \item viene incrementato quando tutte le componenti sono state concluse e pronte per la consegna al cliente. + \end{itemize} + \item \((\beta)\): numero identificativo che viene associato a una baseline del prodotto; + \begin{itemize} + \item parte da 0 e si resetta solo a incrementi di \(\alpha\); + \item viene incrementato quando si raggiunge una nuova baseline di prodotto. + \end{itemize} + \end{itemize} + + \subparagraph{Esempi Codice di Versionamento} + + \begin{itemize} + \item \textbf{v0.5.1 @ 0.1}: indica la versione 0.5.1 di una componente proveniente dalla baseline di prodotto in versione 0.1 + \item \textbf{v1.13.1 @ 1.2}: indica la versione 1.12.1 di una componente proveniente dalla baseline di prodotto 1.2 + \item \textbf{v3.0.2 @ 0.13}: indica la versione 3.0.2 di una componente proveniente dalla baseline di prodotto 0.13 + \end{itemize} + \paragraph{Documentazione} Tutti i file che riguardano la documentazione vengono conservati in una repository e ogni documento viene versionato per mezzo di un identificativo, in base alla loro fase di avanzamento. Questo permette di poter fare riferimento alle nuove versioni del documento durante tutto il ciclo di vita del software. @@ -128,9 +168,13 @@ \subsubsection{Versionamento e Rilascio} Un documento viene rilasciato alle parti proponenti solamente quando vi è un incremento del primo numero (\(\alpha\)), che ne implica una approvazione da parte del responsabile. \\ Per quanto concerne la distribuzione interna, tutti gli \glock{artefatti} dei documenti realizzati durante la fase di sviluppo sono resi disponibili in modo rapido e automatizzato a tutti i membri del gruppo, a cui vengono notificate tutte le modifiche tramite il \glock{workspace} di \textit{Slack}. + \subparagraph{Integrazione con il Versionamento di Prodotto} + + La documentazione viene interpretata come componente, e in quanto tale riceve come aggiunta al proprio codice di versionamento anche l'identificativo di prodotto. Questo identificativo aggiuntivo viene esplicitato solamente all'interno del documento e non nella nominazione dei file. + \paragraph{Software} - I sorgenti del software che riguardano la codifica e la configurazione del prodotto da realizzare sono mantenuti nella repository, insieme alla documentazione. Ogni file viene versionato con un apposito storico delle modifiche, mentre l'intero software viene versionato come \glock{baseline} in relazione alle funzionalità presenti e dei requisiti obbligatori implementati. + I sorgenti del software che riguardano la codifica e la configurazione del prodotto da realizzare sono mantenuti nella repository, insieme alla documentazione. Ogni file viene versionato con un apposito storico delle modifiche, mentre ogni componente software viene versionata come \glock{baseline} di prodotto in relazione alle funzionalità presenti e dei requisiti obbligatori implementati. \subparagraph{Codice di Versionamento} @@ -205,6 +249,10 @@ \subsubsection{Versionamento e Rilascio} \item le versioni \verb!dev! e/o \glock{Patch} non richiedono approvazione e possono essere rilasciate autonomamente dal \glock{programmatore}. \end{itemize} + \subparagraph{Integrazione con il Versionamento di Prodotto} + + Il software, che è formato da diverse parti con le proprie evoluzioni, viene considerato come componente del prodotto. Pertanto, nel codice di versionamento viene aggiunto in coda l'identificativo della baseline di prodotto su cui si basa. Questa prassi non si applica alla nomenclatura dei nomi dei file che riportano la versione. + \subsubsection{Tecnologie} Le tecnologie coinvolte per la configurazione del workflow del progetto sono essenzialmente di 2 tipologie: From fca26a541eca64ed1da7179525a112e8259131e7 Mon Sep 17 00:00:00 2001 From: Mariano Date: Thu, 9 Jan 2020 13:53:28 +0100 Subject: [PATCH 3/3] Cambiamento in corso versione prodotto --- .../sections/Sez3-ProcessiSupporto/GestConfigurazione.tex | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/GestConfigurazione.tex b/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/GestConfigurazione.tex index 86f0f7c..a610b73 100644 --- a/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/GestConfigurazione.tex +++ b/interni/norme_progetto/res/sections/Sez3-ProcessiSupporto/GestConfigurazione.tex @@ -97,7 +97,7 @@ \subsubsection{Versionamento e Rilascio} Per una versione del prodotto associato a una baseline si associa il seguente identificativo: \[% - \text{@}[\alpha].[\beta] + \text{+b}[\alpha].[\beta] \] \begin{itemize} @@ -116,9 +116,9 @@ \subsubsection{Versionamento e Rilascio} \subparagraph{Esempi Codice di Versionamento} \begin{itemize} - \item \textbf{v0.5.1 @ 0.1}: indica la versione 0.5.1 di una componente proveniente dalla baseline di prodotto in versione 0.1 - \item \textbf{v1.13.1 @ 1.2}: indica la versione 1.12.1 di una componente proveniente dalla baseline di prodotto 1.2 - \item \textbf{v3.0.2 @ 0.13}: indica la versione 3.0.2 di una componente proveniente dalla baseline di prodotto 0.13 + \item \textbf{v0.5.1+b1}: indica la versione 0.5.1 di una componente proveniente dalla baseline (di prodotto in versione 1 + \item \textbf{v1.13.1+b2}: indica la versione 1.12.1 di una componente proveniente dalla baseline (di prodotto in versione 2 + \item \textbf{v3.0.2+b13}: indica la versione 3.0.2 di una componente proveniente dalla baseline (di prodotto in versione 13 \end{itemize} \paragraph{Documentazione}