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 notas de versão geradas automaticamente para suas versões do GitHub.

Você pode criar uma visão geral do que está incluído em uma versão e também pode personalizar suas notas de versão automatizadas.

Você pode usar rótulos para criar categorias personalizadas para organizar solicitações pull. Você também pode optar por incluir ou excluir rótulos e usuários específicos da saída.

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

Ao configurar sua versão, você tem 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 antes, ela inclui todas as alterações do seu repositório.

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

Você pode optar por 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 gerado automaticamente seguindo estas etapas:

  1. Vá para o repositório e crie um novo arquivo.

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

  2. Use 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. Escreva no formato YAML, que extrai rótulos de solicitação e autores que você deseja excluir desta versão. Você também pode criar novas categorias e listar os rótulos de pull request em cada uma. Para obter mais informações sobre as 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 selecione + Gerar automaticamente notas de versão para ver como o modelo funciona.

Para mais informações, consulte: