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.

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

docs(readme): remove GitHub Packages Maven config note #345

Merged
merged 3 commits into from
Feb 6, 2024
Merged
Changes from all commits
Commits
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
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.
Loading