Automatizzare le note sulla versione con GitHub

  • 5 minuti

Dopo aver appreso come creare e gestire i tag di versione nel repository, si apprenderà come configurare il modello di note sulla versione generate automaticamente dalle versioni di GitHub.

È possibile generare una panoramica del contenuto di una versione ed è anche possibile personalizzare le note sulla versione automatizzate.

È possibile usare le etichette per creare categorie personalizzate per organizzare le richieste pull e includere o escludere etichette e utenti specifici dalla visualizzazione nell'output.

Creazione di note di rilascio generate automaticamente

Durante la configurazione della versione, viene visualizzata l'opzione Genera automaticamente le note sulla versione per includere tutte le modifiche tra il tag e l'ultima versione. Se non hai mai creato un rilascio, esso consiste di tutte le modifiche nel tuo repository.

Screenshot di come generare note di rilascio da GitHub.

È possibile scegliere se personalizzarlo o lasciarlo invariato.

Configurazione del modello di note di rilascio generate automaticamente

È possibile personalizzare il modello di note di rilascio generate automaticamente attenendosi alla procedura seguente.

  1. Passare al repository e creare un nuovo file.

    Screenshot di come creare un nuovo file in GitHub.

  2. È possibile usare il nome .github/release.yml per creare il file release.yml nella directory .github.

    Screenshot di come creare il file release.yml su GitHub.

  3. Specifica in YAML le etichette delle richieste pull e gli autori da escludere da questa versione. È anche possibile creare nuove categorie ed elencare le etichette delle richieste pull in ognuna. Per altre informazioni sulle opzioni di configurazione, vedere Note sulla versione generate automaticamente - GitHub Docs.

    configurazione di esempio :

    # .github/release.yml

changelog:
  exclude:
    labels:
    - ignore-for-release
    authors:
    - octocat
  categories:
    - title: Breaking Changes 🛠
      labels:
        - Semver-Major
        - breaking-change
    - title: Exciting New Features 🎉
      labels:
        - Semver-Minor
        - enhancement
    - title: Other Changes
      labels:
        - *

  4. Eseguire il commit del nuovo file.

    Screenshot di come eseguire il commit di un nuovo file in GitHub.

  5. Prova a creare un nuovo rilascio e clicca su + Note sul rilascio generate automaticamente per vedere la struttura del modello.

Per altre informazioni, vedere: