Skip to content

Commit 488b096

Browse files
authored
[EDI] Optimizing Java packages for Dependabot updates (#59809)
1 parent 19064e3 commit 488b096

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ children:
1313
- /customizing-dependabot-security-prs
1414
- /controlling-dependencies-updated
1515
- /configuring-the-dependency-review-action
16-
- /optimizing-java-packages-dependabot
1716
- /configuring-notifications-for-dependabot-alerts
1817
- /configuring-access-to-private-registries-for-dependabot
1918
- /removing-dependabot-access-to-public-registries

content/code-security/reference/supply-chain-security/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ children:
2727
- /dependabot-on-actions
2828
- /criteria-for-preset-rules
2929
- /troubleshoot-dependabot
30+
- /java-package-metadata-dependabot
31+
3032
redirect_from:
3133
- /code-security/dependabot/ecosystems-supported-by-dependabot
3234
---

content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/optimizing-java-packages-dependabot.md renamed to content/code-security/reference/supply-chain-security/java-package-metadata-dependabot.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Optimizing Java packages for Dependabot updates
3-
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.
4-
shortTitle: Optimize Java packages
2+
title: Java package metadata for Dependabot updates
3+
intro: Include metadata in your `pom.xml` file to provide helpful links and context in {% data variables.product.prodname_dependabot %} pull requests for Java package updates.
4+
shortTitle: Java package metadata
55
allowTitleToDifferFromFilename: true
66
versions:
77
fpt: '*'
@@ -13,18 +13,19 @@ topics:
1313
- Repositories
1414
redirect_from:
1515
- /code-security/dependabot/ecosystems-supported-by-dependabot/optimizing-java-packages-dependabot
16+
- /code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/optimizing-java-packages-dependabot
1617
contentType: how-tos
1718
---
1819

19-
{% 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.
20+
{% data variables.product.prodname_dependabot %} uses the `url`, `scm`, and `issueManagement` fields in `pom.xml` files to create pull requests for Java dependency updates. When you include this metadata, pull requests will contain links to release notes and issue trackers, helping users update packages with confidence.
2021

21-
## Including the metadata {% data variables.product.prodname_dependabot %} needs in pom.xml files
22+
## Metadata that {% data variables.product.prodname_dependabot %} needs in pom.xml files
2223

2324
{% 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.
2425

25-
* `url` the home page for the project, see [More Project Information](https://maven.apache.org/pom.html#More_Project_Information) in the POM reference
26-
* `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
27-
* `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
26+
* `url`: The home page for the project. See [More Project Information](https://maven.apache.org/pom.html#More_Project_Information) in the POM reference
27+
* `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
28+
* `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 Referencex
2829

2930
### Example for a project hosted on {% data variables.product.github %}
3031

@@ -40,8 +41,6 @@ contentType: how-tos
4041
</project>
4142
```
4243

43-
Replace `OWNER` and `REPOSITORY` with the detailed for your project.
44-
4544
## Impact of omitting project metadata from pom.xml files
4645

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

0 commit comments

Comments
 (0)