Notas de versão geradas automaticamente

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. Automatically generated release notes include a list of merged pull requests, a list of contributors to the release, and a link to a full changelog.

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.

3. Clique em Draft a new release (Rascunhar uma nova versão).

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.

   

5. Se você estiver criando uma nova tag, clique em Criar 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.

7. Optionally, to the top right of the description text box, select the Previous tag drop-down menu and click the tag that identifies the previous release.

8. To the top right of the description text box, click Generate release notes.

9. Selecione as notas geradas para garantir que elas incluem todas (e apenas) as informações que você deseja incluir.

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

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

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

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

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).
3. No campo de nome de arquivo, digite .github/release.yml para criar o arquivo release.yml no diretório .github.
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

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

Leia mais

• "Gerenciando etiquetas"