GitHub Package Registry + Maven Example

This project shows how add a maven dependency stored in the brand new GitHub Package Registry.
For now this feature is in beta. To use it, you have to # for the beta.

The package is released here.

To deploy a package by your own and setup a GitHub Actions CI, check the HalloMaven project.

You can find more info for Package Registry in the official GitHub doc:
📚 Configuring Apache Maven for use with GitHub Package Registry

Add dependency

The dependency is added like every other in maven in the pom.xml:

<dependency>
    <groupId>github.tobsef</groupId>
    <artifactId>hello-maven</artifactId>
    <version>1.2.1</version>
</dependency>

To point maven to the repo, we also have to specify the repositoriy in the pom.xml.

<repositories>
    <repository>
        <id>github</id>
        <name>GitHub TobseF Apache Maven Packages</name>
        <url>https://maven.pkg.github.com/TobseF/HelloMaven</url>
        <releases><enabled>true</enabled></releases>
        <snapshots><enabled>true</enabled></snapshots>
    </repository>
</repositories>

Enable authentication

The registry access is available through the GitHub api which is protected by an authorisation. So you have ro add the credentials to the Package Registry to your global settings.xml:
USER_HOME\.m2\settings.xml

<servers>
    <server>
        <id>github</id>
        <username>YOUR_USERNAME</username>
        <password>YOUR_AUTH_TOKEN</password>
    </server>
</servers>

Replace the YOUR_USERNAME with your GitHub login name.
Replace the YOUR_AUTH_TOKEN with a generated GitHub personal access token:
GitHub > Settings > Developer Settings > Personal access tokens > Generate new token:
The token needs at least the read:packages scope. Otherwise you will get a Not authorized exception.

Setup your own

If you want to use the Package Registry in your own project, make sure its activated. Therefore check your project package site:
https://github.com/YOUR_NAME/YOUR_PROJECT/packages