Automatize as notas de versão com o GitHub

  • 5 minutos

Depois de aprender a criar e gerenciar tags de versão em seu repositório, você aprenderá como configurar o modelo de notas de versão gerado automaticamente a partir de suas versões do GitHub.

Você pode gerar uma visão geral do conteúdo de uma versão e também pode personalizar suas notas de versão automatizadas.

É possível usar rótulos para criar categorias personalizadas para organizar solicitações pull que você deseja incluir ou excluir rótulos e usuários específicos de aparecer na saída.

Criação de notas de versão geradas automaticamente

Ao configurar sua versão, você verá a opção Gerar automaticamente notas de versão para incluir todas as alterações entre sua tag e a última versão. Se você nunca criou uma versão, ela consiste em todas as alterações do seu repositório.

Captura de tela de como criar notas de versão do GitHub.

Você pode escolher se deseja personalizá-lo ou deixá-lo como está.

Configurando o modelo de notas de versão gerado automaticamente

Você pode personalizar o modelo de notas de versão de geração automática usando as etapas a seguir.

  1. Navegue até o repositório e crie um novo arquivo.

    Captura de tela de como criar um novo arquivo no GitHub.

  2. Você pode usar o nome .github/release.yml para criar o arquivo release.yml no diretório .github .

    Captura de tela de como criar release.yml arquivo no GitHub.

  3. Especifique em YAML os rótulos de solicitação pull e os autores que você deseja excluir desta versão. Você também pode criar novas categorias e listar os rótulos de solicitação pull em cada uma delas. Para obter mais informações sobre opções de configuração, consulte Notas de versão geradas automaticamente - GitHub Docs.

    Exemplo de configuração:

    # .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. Confirme seu novo arquivo.

    Captura de tela de como confirmar um novo arquivo no GitHub.

  5. Tente criar uma nova versão e clique em + Gerar automaticamente notas de versão para ver a estrutura do modelo.

Para obter mais informações, consulte: