Description
What article on docs.github.com is affected?
Configuring Apache Maven for use with GitHub Packages
What part(s) of the article would you like to see updated?
The instructions for configuring GitHub Packages for Apache Maven suggest user specific changes for package consumption that overrides inherited defaults and creates slight confusion.
In the resuable
, data/reusables/package_registry/apache-maven-snapshot-versions-supported.md
for SNAPSHOT
support, the note that GitHub Packages support SNAPSHOT
versions shows an example of configuring, and overriding, the inherited default of the Maven Central repository
...
<repositories>
<repository>
<id>central</id>
<url>https://repo1.maven.org/maven2</url>
<!-- default behavior, unnecessary
-->
<releases><enabled>true</enabled></releases>
<!-- overrides ``central'' behavior, but context suggests intended for the
``github'' repository
-->
<snapshots><enabled>true</enabled></snapshots>
</repository>
...
Instead, the reusable should be specific about the use of SNAPSHOT artifacts in the context of GitHub Packages. The resusable should provide additional context on how the artifact can be used by consuming projects.
The updated documentation is shown below.
{% data variables.product.prodname_registry %}
supportsSNAPSHOT
versions of Apache Maven. To use the GitHub Package repository for downloadingSNAPSHOT
artifacts, enable SNAPSHOTS in the POM of the consuming project or your ~/.m2/settings.xml file.
<repositories>
<repository>
<id>central</id>
<url>https://repo1.maven.org/maven2</url>
</repository>
<repository>
<id>github</id>
<name>GitHub OWNER Apache Maven Packages</name>
<url>https://maven.pkg.github.com/OWNER/REPOSITORY</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
<!-- EACH package should be separately noted due to a limitation on group/organization
level package resolution. This may lead to numerous `repository` definitions that
are different in `REPOSITORY` only.
-->
<!-- <repository>
<id>github</id>
<name>GitHub OWNER Apache Maven Packages</name>
<url>https://maven.pkg.github.com/OWNER/REPOSITORY</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
-->
</repositories>
Additional information
The reusable
needs i18n
/l10n
that I cannot provide. I speak some German, but not enough to be correct in documentation.