1367fa3214
Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com>
55 lines
2.9 KiB
Markdown
55 lines
2.9 KiB
Markdown
---
|
|
title: Optimizing Java packages for Dependabot updates
|
|
intro: 'By including metadata in your `pom.xml` file, you can enhance the information available to users in {% data variables.product.prodname_dependabot%} pull requests to update your Java packages.'
|
|
shortTitle: Optimize Java packages # Max 31 characters
|
|
allowTitleToDifferFromFilename: true
|
|
versions:
|
|
fpt: '*'
|
|
ghec: '*'
|
|
ghes: '*'
|
|
type: how_to
|
|
topics:
|
|
- Dependabot
|
|
- Dependencies
|
|
- Repositories
|
|
---
|
|
|
|
{% data variables.product.prodname_dependabot %} uses the information defined in `pom.xml` files to create pull requests to update Java dependencies for the Gradle and Maven ecosystems. When you include the project metadata that {% data variables.product.prodname_dependabot %} expects, pull requests contain links to the release notes for the suggested package update and a link where users can report any issues. This information means that users can update their packages with confidence after reviewing all the release information.
|
|
|
|
## Including the metadata {% data variables.product.prodname_dependabot %} needs in pom.xml files
|
|
|
|
{% data variables.product.prodname_dependabot %} uses the URLs for the project, the source code management system, and the issue management system to build the summary for update pull requests.
|
|
|
|
* `url` the home page for the project, see [More Project Information](https://maven.apache.org/pom.html#More_Project_Information) in the POM reference
|
|
* `scm` the URL of the source code management system used by the project, see [SCM](https://maven.apache.org/pom.html#scm) in the POM Reference
|
|
* `issueManagement` the URL of the issue management system used by the project, see [Issue Management](https://maven.apache.org/pom.html#issue-management) in the POM Reference
|
|
|
|
### Example for a project hosted on {% data variables.product.github %}
|
|
|
|
```xml
|
|
<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>
|
|
```
|
|
|
|
Replace `OWNER` and `REPOSITORY` with the detailed for your project.
|
|
|
|
## Impact of omitting project metadata from pom.xml files
|
|
|
|
If you forget to include the URLs that {% data variables.product.prodname_dependabot %} checks for, then pull requests to update Java packages are still created. However, the information available to users in the pull request summary will be limited.
|
|
|
|
* **Project repository or Source code management URL undefined:** no links to release notes in {% data variables.product.prodname_dependabot %} pull requests
|
|
* **Issue management URL undefined:** no link to the issues page for reporting problems.
|
|
|
|
Adding this information helps {% data variables.product.prodname_dependabot %} provide better, more accurate updates for your project, complete with helpful links to release notes and issue trackers.
|
|
|
|
## Further reading
|
|
|
|
* [Maven SCM Plugin](https://maven.apache.org/scm/maven-scm-plugin/)
|