Skip to content

Commit

Permalink
docs(readme): remove GitHub Packages Maven config note (#345)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewazores committed Feb 6, 2024
1 parent 68aed1e commit aba4702
Showing 1 changed file with 1 addition and 32 deletions.
33 changes: 1 addition & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,35 +15,4 @@ Build:
`./mvnw install` to compile this core library and publish the artifacts to the
local Maven repository for consumption by other projects.

Consumers of this build may pull it from the GitHub Packages registry. This
registry requires authentication.

Add or merge the following configuration into your `$HOME/.m2/settings.xml`,
creating the file if it does not exist:

```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 https://maven.apache.org/xsd/settings-1.0.0.xsd">
<servers>
<server>
<id>github</id>
<username>$MY_GITHUB_USERNAME</username>
<password>$MY_GITHUB_ACCESSTOKEN</password>
</server>
</servers>
</settings>
```

The token must have the `read:packages` permission. It is recommended that this
is the *only* permission the token has.

Then, add the following to your build's `pom.xml`:

```xml
<repositories>
<repository>
<id>github</id>
<url>https://maven.pkg.github.com/cryostatio/cryostat-core</url>
</repository>
</repositories>
```
Consumers of this artifact may also pull it anonymously from Maven Central.

0 comments on commit aba4702

Please sign in to comment.