Rilasciare un nuovo software open source¶
Dopo aver presentato i benefici del software open source, in questo capitolo viene descritta una possibile modalità di pubblicazione del proprio software in open source.
Scegliere una piattaforma di code hosting¶
Le pubbliche amministrazioni dovrebbero scegliere un sistema di controllo delle versioni basato sul sistema git, prendendo in considerazione l’utilizzo di una delle seguenti piattaforme di code hosting, in base alle loro funzionalità e all’adozione significativa da parte della comunità open source di riferimento.
Esistono piattaforme di code hosting sia on-premises che SaaS (anche a utilizzo gratuito). Tra queste ultime citiamo le più scelte tra i progetti open source moderni:
GitLab - https://gitlab.com
GitHub - https://github.com
Bitbucket - https://bitbucket.org
Codeberg - https://codeberg.org/
All’interno di uno strumento di code hosting è possibile organizzare i propri progetti in modo gerarchico, creando un’organizzazione che conterrà all’interno tutti i singoli repository di software. Tale organizzazione può assumere un nome diverso in base alla piattaforma utilizzata: “organizzazione” nel caso di GitHub, “Group” per Gitlab e “Team” per Bitbucket.
Si può immaginare l’organizzazione come un raccoglitore dei singoli repository che a loro volta conterranno il codice sorgente.
È buona norma definire il nome dell’organizzazione in modo coerente rispetto all’ente che la sta creando. Ad esempio, prendendo l’ente fittizio creato come esempio chiamato “Comune di Réuso”, l’organizzazione potrebbe chiamarsi “comune-reuso” e contenere al suo interno tutti i repository con il software di titolarità del comune. È infatti ragionevole pensare che, ad esempio, il software per la gestione del protocollo informatico abbia uno spazio a sé stante diverso da quello del software usato per gestire la lavorazione delle pratiche ricevute via PEC.
Il seguente schema ad albero rappresenta una possibile strutturazione dei repository all’interno di una organizzazione.
comune-reuso
|-- software-protocollo
| |-- LICENSE
| |-- README
|-- software-pec
| |-- LICENSE
| |-- README
La modalità di creazione di tali organizzazioni differisce a seconda della piattaforma adottata.
Qui di seguito saranno elencate le modalità di creazione di una organizzazione all’interno di alcune tra le piattaforme elencate nelle linee guida.
GitLab¶
Un’organizzazione (in questo caso “Gruppo”) in GitLab può essere creata in modo molto semplice direttamente dall’interfaccia online del servizio.
Per creare un’organizzazione, è possibile seguire i seguenti passi:
Fare login su Gitlab con le proprie credenziali
Aperto il sito https://www.gitlab.com/ è possibile fare accesso selezionando sulla barra in alto, a destra, il bottone “Sign In”.
Nella schermata che compare è possibile specificare il proprio nome utente e password o scegliere una modalità di accesso differente.
Se non si dispone di un utente è possibile selezionare “Register” per creare un nuovo utente sulla piattaforma.
Creare un nuovo “Gruppo”
Un gruppo può essere utilizzato anche per identificare l’organizzazione della nostra pubblica amministrazione.
Per creare un nuovo Gruppo dalla barra in alto basta portare il mouse sopra il bottone che presenta un’immagine con un + e selezionare dal menù a tendina “New group”.
Specificare le informazioni per il Gruppo
A questo punto sarà possibile specificare le informazioni rilevanti per la creazione del gruppo. È necessario specificare:
Group name: indicare il nome della PA (ad esempio Comune di Reuso).
Group URL: specificare il nome breve della PA che sarà usato come parte finale della URL dell’organizzazion. Questo nome non può avere spazi o caratteri speciali, come caratteri accentati (ad esempio comune-reuso)
Group description: opzionalmente si può specificare una descrizione della PA.
Visibility level: attenzione! è importante specificare il livello di visibilità del gruppo Public.
Al termine, cliccando sul bottone “Create group” il gruppo sarà creato e disponibile per contenere i repository della PA.
L’URL del gruppo così creato (nell’esempio fatto https://gitlab.com/comune-reuso) sarà il valore da specificare nel campo “URL dell’account nello strumento di code hosting” durante la procedura di aggiunta al Catalogo di Developers Italia.
GitHub¶
Un’organizzazione su GitHub può essere creata in modo molto semplice e gratuito direttamente tramite l’interfaccia online del servizio. Per creare un’organizzazione, è possibile seguire i seguenti passi:
Fare login su GitHub con le proprie credenziali
Aperto il sito https://www.github.com/ è possibile effettuare l’accesso selezionando sulla barra in alto a destra, il bottone “Sign In”.
Nella schermata che compare è possibile specificare il proprio nome utente e password o scegliere una modalità di accesso differente.
Se non si dispone di un utente è possibile selezionare “Create an account” per creare un nuovo utente sulla piattaforma.
Creare una nuova organizzazione
Per creare una nuova organizzazione è necessario selezionare il bottone “+“ a fianco dell’avatar del vostro utente e selezionare dal menù a tendina “New organization”.
Specificare le informazioni per l’organizzazione
Dopo aver specificato di voler creare una organizzazione, sarà possibile aggiungere le informazioni rilevanti. È necessario specificare:
Organization account name: indicare il nome dell’organizzazione della PA, ad esempio comune-di-reuso, in modo che sia raggiungibile su https://github.com/comune-di-reuso.
Contact email: specificare la mail di contatto per qualsiasi informazione riguardante l’organizzazione.
Belongs to: indicare il nome di un ente al quale l’organizzazione sarà legata
L’URL dell’organizzazione così creato sarà https://github.com/comune-di-reuso.
Bitbucket¶
Un’organizzazione (in questo caso “Team”) in Bitbucket può essere creata in modo molto semplice direttamente dall’interfaccia online del servizio.
Per creare un’organizzazione, è possibile seguire i seguenti passi:
Fare login su Bitbucket con le proprie credenziali
Aperto il sito https://bitbucket.org è possibile fare accesso selezionando “Log in” in alto e quindi specificando il proprio nome utente e password o scegliendo una modalità di accesso differente.
Se non si dispone di un utente è possibile selezionare “Registra un account” sotto ai bottoni di accesso per creare un nuovo utente sulla piattaforma.
Creare un nuovo “Team”
Un team può essere utilizzato anche per identificare l’organizzazione della nostra pubblica amministrazione.
Per creare un nuovo Team è possibile cliccare sull’icona con il simbolo + nel menu a scomparsa di sinistra e quindi selezionare Team.
Specificare le informazioni per il Team
A questo punto sarà possibile specificare le informazioni rilevanti per la creazione del team. É necessario dunque specificare:
Team name: indicare il nome della PA (ad esempio Comune di Reuso)
Workspace ID: specificare il nome breve della PA che sarà usato come parte dell’URL dell’organizzazione. Questo nome non può avere spazi o caratteri speciali, come caratteri accentati (ad esempio “comune-reuso”)
Al termine, premendo sul bottone “done” il team sarà creato e disponibile per contenere i repository della PA.
L’URL del team così creato sarà https://bitbucket.org/comune-reuso/.
Convertire un utente in organizzazione¶
Nel caso in cui si fosse inavvertitamente effettuato il processo di onboarding inserendo l’indirizzo (URL) di un utente invece che di un’organizzazione è possibile apportare una correzione senza dover rifare l’operazione di onboarding.
GitHub¶
La piattaforma GitHub permette di convertire un account utente in un’organizzazione ma, nel farlo, si perderà l’accesso al primo.
Ipotizziamo di avere un utente denominato “comune-reuso” da convertire in un’organizzazione. Per farlo si possono seguire i seguenti passi:
creare un nuovo utente che coprirà il ruolo di amministratore, ad esempio “admincomunedireuso”
Effettuare il login con il vecchio utente nel nostro esempio denominato “comune-reuso”.
Convertire l’utente denominato “comune-reuso” in una vera e propria organizzazione. Durante questa operazione è importante indicare il nome dell’utente che avrà la gestione dell’amministrazione, nel nostro esempio sarà “admincomunedireuso”.
A questo punto avremo una URL del tipo “github.com/comune-reuso” che sarà un’organizzazione gestita dall’utente “admincomunedireuso”
Più nel dettaglio:
Creare un utente di amministrazione (https://github.com/join)
Convertire l’account in un’organizzazione.
Per farlo è necessario effettuare il login come “comune-reuso”, selezionare il menu Settings e successivamente selezionare il menu sulla sinistra chiamato Organizations.
Selezionare il bottone Turn comune-reuso into an
organization.
Proseguire con la procedura, facendo molta attenzione ad assegnare l’utente creato al punto 1, ovvero “admincomunedireuso”, come titolare della nuova organizzazione . Se questo non dovesse essere effettuato correttamente si perderebbe l’accesso a tale organizzazione.
A questo punto la procedura è terminata, sarà dunque possibile visualizzare la propria organizzazione su https://github.com/comune-reuso
Aggiungere l’organizzazione a Developers Italia¶
Una volta ottenuta la propria organizzazione dallo strumento di code hosting la si può registrare nel Catalogo di software pubblico di Developers Italia, attraverso il sito https://onboarding.developers.italia.it. All’interno di questo portale si dovranno inserire le informazioni relative al referente e la URL dell’organizzazione dell’ente.
Questa operazione permetterà a Developers Italia di indicizzare automaticamente tutti i software dell’organizzazione in modo da renderli facilmente trovabili all’interno del Catalogo del software a riuso.
Scegliere il nome del progetto¶
La denominazione del progetto (e del repository associato) è una parte importante del rilascio.
Si suggerisce di:
usare un nome descrittivo che chiarisca le finalità del progetto.
non utilizzare marchi di terze parti se non quando necessario; ad esempio possono essere utilizzati come descrittori (ad esempio “Librerie di test per Java” anziché “Librerie di test Java”).
non scegliere come nome di progetto un marchio registrato di proprietà altrui.
per i nomi dei repository, separare le parole con trattini invece di concatenarle (ad esempio invece di “successortoserverless” utilizzare “successor-to-serverless”). Questo aumenta la leggibilità da parte di chi dovrà usare il software.
Scegliere e dichiarare la licenza¶
È fondamentale operare la scelta della licenza nel momento della nascita del progetto. Oltre al fatto che un progetto senza licenza non può essere considerato open source (a prescindere dalla leggibilità del suo codice sorgente) possono emergere problemi nel caso dovessero sopravvenire modifiche o suggerimenti di miglioramento. In questo caso la licenza dei contributi non sarebbe chiara e questo potrebbe comportare controversie legali.
Inoltre, è importante evitare di usare la dicitura “Tutti i diritti riservati” o “All rights reserved”, in quanto in contraddizione con l’apposizione di una licenza libera.
Per questo motivo ogni repository deve obbligatoriamente avere una licenza riportata nel file dedicato (chiamato normalmente LICENSE o LICENSE.md). In caso di conferimento iniziale, il file LICENSE può essere incluso direttamente nella prima pull request (come viene chiamato su molte piattaforme il meccanismo di proposta di modifiche) purché il commit sia effettuato dal soggetto titolare del codice.
Per indicazioni circa le licenze, si può fare riferimento alle “Linee guida su acquisizione e riuso di software per le pubbliche amministrazioni”, Allegato C: Guida alle licenze Open Source.
Accettare dei contributi dopo il rilascio¶
Dopo aver rilasciato una soluzione in open source per il riuso, è molto probabile che qualche altro soggetto o amministrazione la voglia utilizzare per i propri scopi. In questo riutilizzo, il codice potrebbe ricevere contributi di miglioramento, correzioni di errori o sviluppo di nuove funzionalità.
È bene che questi contributi siano accettati e integrati nel codice sorgente del progetto in modo da rappresentare un miglioramento per tutti coloro che sono interessati al suo riuso. Per accettare i contributi, tuttavia, occorre verificare alcuni aspetti:
i contributi devono essere revisionati in termini di potenziali rischi per la sicurezza della soluzione;
i contributi non devono riguardare personalizzazioni del software in questione non compatibili con un utilizzo generico da parte di terzi;
è consigliabile che il titolare e mantenga il controllo dell’architettura e della qualità del software da lui prodotto e verifichi quindi che i contributi non violino regole di struttura o di organizzazione del progetto.