Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue 1669: Update GitHub Maven docs Super POM and context #1670

Merged
merged 21 commits into from
Mar 4, 2021
Merged

Issue 1669: Update GitHub Maven docs Super POM and context #1670

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
9455624
Update GitHub Maven docs Super POM and context
timothystone Nov 28, 2020
06d41ff
Encode XML comments for display
timothystone Nov 28, 2020
c01d36b
Remove XML code fence language hint
timothystone Nov 28, 2020
f735288
Use pre element to retain comments
timothystone Nov 28, 2020
d463997
Provide example of multiple repositories
timothystone Nov 28, 2020
ae708ae
Merge branch 'main' into maven
timothystone-knsl Dec 22, 2020
615ec6a
Merge branch 'main' into maven
timothystone Dec 24, 2020
5f5455b
Merge branch 'main' into maven
timothystone Jan 2, 2021
9f481dc
Merge branch 'main' into maven
timothystone Jan 10, 2021
ccc8b12
Merge branch 'main' into maven
timothystone Jan 23, 2021
3e759df
Merge branch 'main' into maven
timothystone Jan 26, 2021
3509c01
Remove redundant whitespace
jcansdale Mar 4, 2021
c8f7be4
Remove redundant releases element (enabled is default)
jcansdale Mar 4, 2021
07f05ad
Use single repository element for owner
jcansdale Mar 4, 2021
91c3c10
Remove optional repository name
jcansdale Mar 4, 2021
a03b105
Remove redundant releases (enabled is default)
jcansdale Mar 4, 2021
bb7148b
Fixed spaces
jcansdale Mar 4, 2021
3a4bec2
Make 2nd example consistent
jcansdale Mar 4, 2021
0b2c0b6
Only one repository element is required per owner
jcansdale Mar 4, 2021
86b4f67
Merge branch 'main' into maven
jmarlena Mar 4, 2021
5c9a66e
Apply suggestions from code review
jmarlena Mar 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 60 additions & 29 deletions ...our-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ If you want to interact with multiple repositories, you can add each repository
If your instance has subdomain isolation enabled:
{% endif %}

```
```xml
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
Expand All @@ -50,22 +50,38 @@ If your instance has subdomain isolation enabled:
<profiles>
<profile>
<id>github</id>
<repositories>
<repository>
<id>central</id>
<url>https://repo1.maven.org/maven2</url>
<releases><enabled>true</enabled></releases>
<snapshots><enabled>true</enabled></snapshots>
</repository>
<repository>
<id>github</id>
<name>GitHub OWNER Apache Maven Packages</name>
<url>https://{% if currentVersion == "free-pro-team@latest" %}maven.pkg.github.com{% else %}maven.HOSTNAME{% endif %}/OWNER/REPOSITORY</url>
</repository>
</repositories>
<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://{% if currentVersion == "free-pro-team@latest" %}maven.pkg.github.com{% else %}maven.HOSTNAME{% endif %}/OWNER/REPOSITORY</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
<repository>
<id>github</id>
<name>GitHub OWNER Apache Maven Packages</name>
<url>https://{% if currentVersion == "free-pro-team@latest" %}maven.pkg.github.com{% else %}maven.HOSTNAME{% endif %}/OWNER/REPOSITORY-2</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>

</repositories>
</profile>
</profiles>

<servers>
<server>
<id>github</id>
Expand All @@ -79,7 +95,7 @@ If your instance has subdomain isolation enabled:
{% if enterpriseServerVersions contains currentVersion %}
If your instance has subdomain isolation disabled:

```
```xml
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
Expand All @@ -92,19 +108,34 @@ If your instance has subdomain isolation disabled:
<profiles>
<profile>
<id>github</id>
<repositories>
<repository>
<id>central</id>
<url>https://repo1.maven.org/maven2</url>
<releases><enabled>true</enabled></releases>
<snapshots><enabled>true</enabled></snapshots>
</repository>
<repository>
<id>github</id>
<name>GitHub OWNER Apache Maven Packages</name>
<url>https://HOSTNAME/_registry/maven/OWNER/REPOSITORY</url>
</repository>
</repositories>
<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>
<repository>
<id>github</id>
<name>GitHub OWNER Apache Maven Packages</name>
<url>https://maven.pkg.github.com/OWNER/REPOSITORY-2</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
</profile>
</profiles>

Expand Down
4 changes: 3 additions & 1 deletion data/reusables/package_registry/apache-maven-snapshot-versions-supported.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
{% data variables.product.prodname_registry %} supports `SNAPSHOT` versions of Apache Maven. To use a repository for downloading this type of artifact, you must enable SNAPSHOTS in your *~/.m2/settings.xml* file.
{% data variables.product.prodname_registry %} supports `SNAPSHOT` versions of Apache Maven. To use the GitHub Package repository for downloading `SNAPSHOT` artifacts, enable SNAPSHOTS in the POM of the consuming project or your *~/.m2/settings.xml* file.

EACH package should be in a separate repository due to a limitation on group/organization level package resolution. This may lead to numerous `repository` definitions that are different in `REPOSITORY` only.