Como otimizar pacotes Java para atualizações do Dependabot

Ao incluir metadados no arquivo pom.xml, você pode aprimorar as informações disponíveis para os usuários em pull requests do Dependabot para atualizar seus pacotes Java.

Neste artigo

O Dependabot usa as informações definidas nos arquivos pom.xml para criar pull requests a fim de atualizar as dependências do Java para os ecossistemas do Gradle e do Maven. Quando você inclui os metadados do projeto esperados pelo Dependabot, as pull requests contêm links para as notas sobre a versão para a atualização de pacote sugerida e um link no qual os usuários podem relatar qualquer problema. Essas informações significam que os usuários podem atualizar os pacotes com confiança depois de ler todas as informações sobre a versão.

Para incluir os metadados, o Dependabot precisa de arquivos pom.xml

O Dependabot usa as URLs para o projeto, o sistema de gerenciamento de código-fonte e o sistema de gerenciamento de problemas para criar o resumo para pull requests de atualização.

  • url: a home page do projeto. Confira Mais informações sobre o projeto na referência do POM
  • scm: a URL do sistema de gerenciamento de código-fonte usado pelo projeto. Confira SCM na referência do POM
  • issueManagement: a URL do sistema de gerenciamento de problemas usado pelo projeto. Confira Gerenciamento de problemas na referência do POM

Exemplo de um projeto hospedado no GitHub

<project>
  <url>https://github.com/OWNER/REPOSITORY</url>
  <scm>
    <url>https://github.com/OWNER/REPOSITORY</url>
  </scm>
  <issueManagement>
    <url>https://github.com/OWNER/REPOSITORY/issues</url>
  </issueManagement>
</project>

Substitua OWNER e REPOSITORY pelos detalhes do seu projeto.

Impacto da omissão de metadados de projeto de arquivos pom.xml

Se você esquecer de incluir as URLs que o Dependabot verifica, as pull requests usadas para atualizar os pacotes Java ainda serão criadas. No entanto, as informações disponíveis para os usuários no resumo da pull request serão limitadas.

  • Repositório de projeto ou URL de gerenciamento de código-fonte indefinido: nenhum link para notas sobre a versão nas pull requests do Dependabot
  • URL de gerenciamento de problemas indefinida: nenhum link para a página de problemas para relatar problemas.

A adição dessas informações ajuda o Dependabot a fornecer atualizações melhores e mais precisas para seu projeto, com links úteis para notas sobre a versão e rastreadores de problemas.

Leitura adicional