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 e organizzare le richieste pull per includere o escludere etichette e utenti specifici dalla visualizzazione nell'output.

Creazione di note sulla versione generate automaticamente

Durante la configurazione della versione viene visualizzata l'opzione per la generazione automatica delle note sulla versione per includere tutte le modifiche tra il tag e l'ultima versione. Se non è mai stata creata una versione, questa è costituita da tutte le modifiche presenti nel repository.

Screenshot di come creare note sulla versione da GitHub.

È possibile scegliere se si vuole personalizzarla o lasciarla invariata.

Configurazione del modello di note sulla versione generate automaticamente

Per personalizzare il modello di note sulla versione generate automaticamente, usare la 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 in GitHub.

  3. Specificare in YAML gli autori e le etichette di richiesta pull da escludere da questa versione. È anche possibile creare nuove categorie ed elencare le etichette di richiesta pull in ognuna di esse. Per altre informazioni sulle opzioni di configurazione, vedere Automatically generated release notes - 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. Provare a creare una nuova versione e fare clic su Genera automaticamente note sulla versione per visualizzare la struttura del modello.

Per altre informazioni, vedi: