Piotr Karwasz created LANG-1776:
-----------------------------------
Summary: Use GitHub URLs in `project.scm.url` for improved
automation support
Key: LANG-1776
URL: https://issues.apache.org/jira/browse/LANG-1776
Project: Commons Lang
Issue Type: Improvement
Reporter: Piotr Karwasz
h2. Description:
The {{`project.scm`}} section of the Maven POM is primarily used by Maven
plugins (e.g., the Maven Release Plugin) to interact with the source control
system. However, the {{`project.scm.url`}} field serves a documentation-only
purpose and can be updated without impacting the build or release process.
In recent years, automation tools like *Dependabot* have begun leveraging this
field to determine the GitHub repository associated with a Maven artifact.
Setting {{`project.scm.url`}} to the GitHub repository URL allows tools like
Dependabot to:
* Link the Maven artifact to its GitHub repository
* Automatically retrieve release notes, changelogs, and commit history for new
versions
h3. Example:
See the difference in metadata provided by Dependabot in the PR for upgrading
{{`commons-csv`}} versus {{`commons-lang3`}} in the following pull request:
[ppkarwasz/logging-log4j2#566|https://github.com/ppkarwasz/logging-log4j2/pull/566]
h2. Proposal:
Update the value of {{`project.scm.url`}} in the POM to:
{code}
https://github.com/apache/commons-lang
{code}
This change will help automation tools better support the project and improve
the experience for downstream users.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
