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 le note sulla versione generate automaticamente per le versioni di GitHub.

È possibile creare una panoramica delle funzionalità incluse in una versione ed è anche possibile personalizzare le note sulla versione automatizzate.

È possibile usare le etichette per creare categorie personalizzate per organizzare le richieste pull. È anche possibile scegliere di includere o escludere etichette specifiche e utenti dall'output.

Creazione di note di rilascio generate automaticamente

Quando si configura la versione, si ha l'opzione "Genera automaticamente le note sulla versione" per includere tutte le modifiche tra il tag e l'ultima versione. Se non è mai stata creata una versione precedente, include tutte le modifiche dal repository.

Screenshot di come generare note di rilascio da GitHub.

È possibile scegliere di personalizzarlo o lasciarlo così come è.

Impostazione del modello di note di rilascio generate automaticamente

È possibile personalizzare il modello delle note sulla versione generato automaticamente seguendo questa procedura:

  1. Passare al repository e creare un nuovo file.

    Screenshot di come creare un nuovo file in GitHub.

  2. 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. Scrivi in formato YAML, specificando le etichette delle richieste e gli autori che vuoi escludere da questa versione. È anche possibile creare nuove categorie ed elencare le etichette delle richieste pull in ognuna. Per altre informazioni sulle opzioni di installazione, 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. Provare a creare una nuova versione e selezionare + Genera automaticamente note sulla versione per vedere il funzionamento del modello.

Per altre informazioni, vedere: