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

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. 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.

  2. To the right of the list of files, click Releases. Seção de versões na barra lateral direita

  3. Clique em Draft a new release (Rascunhar uma nova versão). Botão Releases draft (Rascunho de versões)

  4. Clique em Escolher uma etiqueta e digite um número de versão para a sua versão. Como alternativa, selecione um tag existente.

    Insira uma tag

  5. Se você estiver criando uma nova tag, clique em Criar nova tag. Confirme que você deseja criar uma nova tag

  6. Se você criou uma nova tag, use o menu suspenso para selecionar o branch que contém o projeto que você deseja liberar. Escolha um branch

  7. Para o canto superior direito da caixa de texto de descrição, clique em Gerar notas de versão automaticamente. Gerar notas de versão automaticamente

  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. Fornecer um DMG com a versão

  10. Para notificar os usuários que a versão não está pronta para produção e pode ser instável, selecione This is a pre-release (Esta é uma versão prévia). Caixa de seleção para marcar uma versão como pré-versão

  11. Opcionalmente, selecione Criar uma discussão para esta versão e, em seguida, selecione a Categoria no menu suspenso e clique em uma categoria para a discussão da versão. Caixa de seleção para criar uma discussão de versão e menu suspenso para escolher uma categoria

  12. Se estiver pronto para tornar pública a sua versão, clique em Publish release (Publicar versão). Para trabalhar na versão posteriormente, clique em Save draft (Salvar rascunho). Botões Publish release (Publicar versão) e Draft release (Rascunhar versão)

Configurar notas de versões geradas automaticamente

  1. No GitHub.com, navegue até a página principal do repositório.
  2. Acima da lista de arquivos, utilizando o menu suspenso Add file (Adicionar arquivo), clique em Create new file (Criar novo arquivo). "Criar novo arquivo" no menu suspenso "Adicionar arquivo"
  3. No campo de nome de arquivo, digite .github/release.yml para criar o arquivo release.yml no diretório .github. Criar novo arquivo
  4. 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[*].titleObrigatório. O título de uma categoria de alterações nas notas de versão.
changelog.categories[*].labelsObrigatório. Etiquetas que qualificam um pull request para esta categoria. Use * como um coringa para pull requests 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.

Exemplo de configuração

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:
        - "*"

Leia mais