[LANG-1776] Use GitHub URL in project.scm.url#1405
Conversation
This PR updates the `project.scm.url` field in the Maven POM to point to the GitHub repository URL (`https://github.com/apache/commons-lang`). While this field is not used directly by Maven during builds, it is increasingly leveraged by tools like *Dependabot* to: * Associate the Maven artifact with its GitHub repository * Automatically include release notes, changelogs, and commit history in pull requests for new versions By using the GitHub URL, we improve the quality and completeness of metadata shown in automated upgrade PRs and make it easier for users to trace changes between releases.
|
Hi @ppkarwasz Do we really want to point to a non-Apache resource for something that is NOT the canonical Apache repository? I would think twice about this... Dependabot doesn't seem to need this change FWIW, it just works fine today. |
This adds a `ciManagement` property that points to the GitHub Actions URL. This is a valid alternative to `project.scm.url` to allow Dependabot and other tooling to associate an artifact with the GitHub repo.
That's a valid concern. I've reverted To help tooling like Dependabot discover the GitHub repository (without compromising the canonical SCM reference), I've added a
That's mostly true — Dependabot can detect and propose version bumps even without this change. However, without a GitHub URL present, it cannot automatically enrich PRs with changelogs and commit diffs. For an example of this difference in behavior, see PR ppkarwasz/logging-log4j2#566, where This small metadata tweak improves the user experience for downstream consumers without altering the authoritative SCM reference. |
|
TY @ppkarwasz Merged. |
2 participants
This PR updates the
project.scm.urlfield in the Maven POM to point to the GitHub repository URL (https://github.com/apache/commons-lang).While this field is not used directly by Maven during builds, it is increasingly leveraged by tools like Dependabot to:
By using the GitHub URL, we improve the quality and completeness of metadata shown in automated upgrade PRs and make it easier for users to trace changes between releases.