Skip to main content

Notas de versão geradas automaticamente

Você pode gerar automaticamente notas de versão para as suas versões do GitHub

Who can use this feature

Repository collaborators and people with write access to a repository can generate and customize automated release notes for a release.

Sobre notas de versão geradas automaticamente

As otas de versão geradas automaticamente fornecem uma alternativa automatizada para escrever notas de versão manualmente para as suas versões de GitHub. Com as notas de versões geradas automaticamente, você pode gerar rapidamente uma visão geral do conteúdo de uma versão. As notas sobre a versão geradas automaticamente incluem uma lista de solicitações de pull mescladas, uma lista de colaboradores da versão e um link para um changelog completo.

Você também pode personalizar suas notas de versão automatizadas, usando etiquetas para criar categorias personalizadas e organizar pull requests que você deseja incluir e excluir certas etiquetas e usuários para que não apareçam na saída.

Criando notas de versão geradas automaticamente para uma nova versão

  1. No GitHub.com, navegue até a página principal do repositório. 1. À direita da lista de arquivos, clique em Versões. Seção de versões na barra lateral à direita
  2. Clique em Criar rascunho de uma nova versão. Botão Rascunho de versões
  3. Clique em Escolher uma tag e digite um número de versão para a versão. Como alternativa, selecione um tag existente. Inserir uma tag
  4. Se estiver criando uma marca, clique em Criar marca. Confirme se deseja criar uma marca
  5. Se você criou uma nova tag, use o menu suspenso para selecionar o branch que contém o projeto que você deseja liberar. Escolher um branch
  6. Opcionalmente, no canto superior direito da caixa de texto de descrição, selecione o menu suspenso Tag anterior e clique na tag que identifica a versão anterior. Captura de tela mostrando como selecionar uma tag para identificar a versão anterior
  7. No canto superior direito da caixa de texto da descrição, clique em Gerar notas sobre a versão. Gerar as notas sobre a versão
  8. Selecione as notas geradas para garantir que elas incluem todas (e apenas) as informações que você deseja incluir.
  9. Opcionalmente, para incluir arquivos binários, como programas compilados em sua versão, arraste e solte ou selecione arquivos manualmente na caixa de binários. Como fornecer um DMG com a versão
  10. Para notificar os usuários de que a versão não está pronta para produção e pode ser instável, selecione Este é um pré-lançamento. Caixa de seleção usada para marcar uma versão como pré-lançamento
  11. Opcionalmente, selecione Criar uma discussão para esta versão, escolha o menu suspenso Categoria e clique em uma categoria para ver a discussão da versão. Caixa de seleção usada para criar uma discussão sobre versão e menu suspenso usado para escolher uma categoria
  12. Se estiver pronto para tornar sua versão pública, clique em Publicar versão. Para trabalhar na versão posteriormente, clique em Salvar rascunho. Botões Publicar versão e Criar rascunho de versão

Configurar notas de versões geradas automaticamente

  1. No GitHub.com, navegue até a página principal do repositório. 1. Acima da lista de arquivos, usando o menu suspenso Adicionar arquivo, clique em Criar arquivo. "Criar arquivo" no menu suspenso "Adicionar arquivo"
  2. No campo de nome do arquivo, digite .github/release.yml para criar o arquivo release.yml no diretório .github. Criar arquivo
  3. No arquivo, usando as opções de configuração abaixo, especifique no YAML as etiquetas de pull request e autores que você deseja excluir desta versão. Você também pode criar novas categorias e listar as etiquetas de pull request para que sejam incluídas cada uma delas.

Opções de configuração

ParâmetroDescrição
changelog.exclude.labelsUma lista de etiquetas que excluem um pull request de aparecer nas notas de versão.
changelog.exclude.authorsUma lista de usuários ou servidores de login com os quais os pull requests devem ser excluídos das notas de versão.
changelog.categories[*].titleNecessário. O título de uma categoria de alterações nas notas sobre a versão.
changelog.categories[*].labelsNecessário. Rótulos que qualificam uma solicitação de pull para essa categoria. Use * como um catch-all para as solicitações de pull que não correspondem a nenhuma das categorias anteriores.
changelog.categories[*].exclude.labelsUma lista de etiquetas que excluem um pull request de aparecer nesta categoria.
changelog.categories[*].exclude.authorsUma lista gerenciamento de login de sessão de usuários ou bot, cujos pull requests devem ser excluídos desta categoria.

Configuração de exemplo

YAML
# .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:
        - "*"

Leitura adicional