Automatizar notas sobre a versão com o GitHub

  • 5 minutos

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

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

É possível usar rótulos para criar categorias personalizadas para organizar as solicitações de pull desejadas para incluir ou excluir rótulos usuários específicos na exibição do resultado.

Configurar notas sobre a versão geradas automaticamente

Ao configurar sua versão, você verá a opção Gerar notas sobre a versão automaticamente para incluir todas as alterações entre a sua marcação e a última versão. Caso nunca tenha criado uma versão, ela será formada por todas as alterações no repositório.

Captura de tela de como criar notas sobre a versão no GitHub.

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

Configurar modelo de notas sobre a versão geradas automaticamente

Você pode personalizar o modelo de notas sobre a versão geradas automaticamente usando as etapas a seguir.

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

    Captura de tela de como criar um 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 um arquivo release.yml no GitHub.

  3. No YAML, especifique os rótulos das solicitações de pull e os autores que você deseja excluir da versão. Você também pode criar categorias e listar rótulos de solicitações de pull em cada uma delas. Para obter mais informações sobre as opções de configuração, confira Notas sobre a 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. Faça commit do novo arquivo.

    Captura de tela de como fazer commit de um novo arquivo no GitHub.

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

Para obter mais informações, consulte: