Passa al contenuto principale

JM4.2 - Avvisi per chi aggiorna

In una frase. Ogni cambiamento che chiede di fare qualcosa a chi aggiorna è scritto in un solo file, con la data e con le cose da fare.

Alcune modifiche non si vedono guardando il codice. Una variabile nuova da scrivere nel file delle impostazioni. Un valore predefinito cambiato. Un comando da rilanciare. Se nessuno lo dice, chi aggiorna il proprio PC o il server lo scopre dall'errore. Gli avvisi servono a dirlo prima.

Il file è un diario al contrario: l'avviso più recente sta in cima. Ogni avviso ha un titolo con la data e due parti fisse.

  • Cosa cambia. Che cosa è diverso da prima, in poche righe.
  • Cosa fare. I passi da fare, e dove. Quando non c'è niente da fare, c'è scritto «Niente».

Si legge in due momenti.

  1. Dopo aver scaricato il codice aggiornato. Leggi gli avvisi dalla cima fino all'ultimo che conoscevi. Fai quello che riguarda il tuo PC.

  2. Prima di premere il pulsante del deploy. Controlla se un avviso recente chiede qualcosa sul server: una riga nel file delle impostazioni, una cartella, un archivio da creare. Va fatto prima del clic, altrimenti il servizio nuovo non parte.

Tre esempi veri, di novembre 2026:

  • la riga AUTH_ENABLED diventa obbligatoria nel file delle impostazioni del server: senza, ogni comando si ferma;
  • GPEnext entra nella pipeline: prima del deploy vanno creati il suo archivio e le sue cartelle sul server;
  • una libreria dell'app web cambia versione: dopo aver scaricato il codice va rilanciata l'installazione delle librerie.

Cosa ci guadagni.
• Niente sorprese dopo un aggiornamento. Quello che va fatto è scritto prima, non scoperto dall'errore.
• Un posto solo dove guardare. Non serve chiedere in giro né rileggere la storia delle modifiche.
• Il server non resta a metà. Chi preme il pulsante sa già cosa va preparato.

Chi scrive una modifica che chiede un'azione agli altri aggiunge l'avviso nello stesso momento, una voce per cambiamento. Non dopo.

Per chi sviluppa. La regola sta nelle istruzioni del repository: variabile nuova, valore predefinito cambiato o regola nuova vogliono una voce negli avvisi nella stessa sessione di lavoro. Le variabili vanno anche nel registro docs/devops/ENVIRONMENT.md.

Per approfondire.
• Avvisi per chi lavora sul repo, cosa fare dopo il pull: docs/AVVISI-SVILUPPATORI.md