Dependabot usa os campos url, scm e issueManagement em arquivos pom.xml para criar solicitações de pull para atualizações de dependência Java. Quando você incluir esses metadados, as solicitações de pull conterão links para notas de versão e rastreadores de problemas, ajudando os usuários a atualizar pacotes com confiança.
Metadados que Dependabot precisa nos arquivos pom.xml
O Dependabot usa as URLs do projeto, do sistema de gerenciamento de código-fonte e do sistema de gerenciamento de incidentes para criar o resumo dos pull requests de atualização.
- : a home page do projeto. Veja mais informações sobre o projeto na referência POM
- : a URL do sistema de gerenciamento de código-fonte usado pelo projeto. Consulte SCM na Referência POM
- : a URL do sistema de gerenciamento de problemas usado pelo projeto. Consulte o Gerenciamento de Problemas no POM Referencex
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>
Impacto da omissão de metadados do projeto nos arquivos pom.xml
Se você esquecer de incluir as URLs que Dependabot verifica, as solicitações pull 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: sem links para notas de lançamento nas pull requests do Dependabot
- URL de gerenciamento de problemas indefinido: não há 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
- Plugin SCM do Maven