├── .gitignore
├── README.md
├── pom.xml
└── src
    └── main
        └── java
            └── de
                └── tfr
                    └── test
                        └── UseLibTest.java


/.gitignore:
--------------------------------------------------------------------------------
1 | # IntelliJ project files
2 | .idea
3 | *.iml
4 | target
5 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # GitHub Package Registry + Maven Example
 2 | 
 3 | This project shows how add a maven dependency stored in the brand new  [GitHub Package Registry](https://github.com/features/package-registry).  
 4 | For now this feature is in beta. To use it, you have to [sign up for the beta](https://github.com/features/package-registry/signup).
 5 | 
 6 | The package is released [here](https://github.com/TobseF/HelloMaven/packages).  
 7 | 
 8 | To deploy a package by your own and setup a [GitHub Actions](https://github.com/features/actions) CI, check the [HalloMaven](https://github.com/TobseF/HelloMaven/) project.   
 9 | 
10 | You can find more info for Package Registry in the official GitHub doc:  
11 | 📚 [Configuring Apache Maven for use with GitHub Package Registry](https://help.github.com/en/articles/configuring-apache-maven-for-use-with-github-package-registry)
12 | 
13 | ## Add dependency
14 | The dependency is added like every other in maven in the `pom.xml`:
15 | 
16 | ```xml
17 | <dependency>
18 |     <groupId>github.tobsef</groupId>
19 |     <artifactId>hello-maven</artifactId>
20 |     <version>1.2.1</version>
21 | </dependency>
22 | ```
23 | To point maven to the repo, we also have to specify the `repositoriy` in the `pom.xml`.
24 | ```xml
25 | <repositories>
26 |     <repository>
27 |         <id>github</id>
28 |         <name>GitHub TobseF Apache Maven Packages</name>
29 |         <url>https://maven.pkg.github.com/TobseF/HelloMaven</url>
30 |         <releases><enabled>true</enabled></releases>
31 |         <snapshots><enabled>true</enabled></snapshots>
32 |     </repository>
33 | </repositories>
34 | ```
35 | ## Enable authentication
36 | The registry access is available through the GitHub api which is protected by an authorisation.
37 | So you have ro add the credentials to the Package Registry to your global `settings.xml`:  
38 | `USER_HOME\.m2\settings.xml`
39 | 
40 | ``` xml
41 | <servers>
42 |     <server>
43 |         <id>github</id>
44 |         <username>YOUR_USERNAME</username>
45 |         <password>YOUR_AUTH_TOKEN</password>
46 |     </server>
47 | </servers>
48 | ```
49 | Replace the `YOUR_USERNAME` with your GitHub login name.  
50 | Replace the `YOUR_AUTH_TOKEN` with a generated GitHub personal access token:  
51 | _GitHub_ > _Settings_ > _Developer Settings_ > _Personal access tokens_ > _Generate new token_:   
52 | The token needs at least the `read:packages` scope.
53 | Otherwise you will get a `Not authorized` exception.
54 | 
55 | 
56 | ### Setup your own
57 | If you want to use the Package Registry in your own project, make sure its activated.
58 | Therefore check your project package site:  
59 | https://github.com/YOUR_NAME/YOUR_PROJECT/packages
60 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <project xmlns="http://maven.apache.org/POM/4.0.0"
 3 |          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4 |          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 5 |     <modelVersion>4.0.0</modelVersion>
 6 | 
 7 | <groupId>de.tfr.test</groupId>
 8 | <artifactId>maven-repo-test</artifactId>
 9 | <version>1.0-SNAPSHOT</version>
10 | 
11 |     <repositories>
12 |         <repository>
13 |             <id>github</id>
14 |             <name>GitHub TobseF Apache Maven Packages</name>
15 |             <url>https://maven.pkg.github.com/TobseF/HelloMaven</url>
16 |             <releases>
17 |                 <enabled>true</enabled>
18 |             </releases>
19 |             <snapshots>
20 |                 <enabled>true</enabled>
21 |             </snapshots>
22 |         </repository>
23 |     </repositories>
24 | 
25 |     <dependencies>
26 |         <dependency>
27 |             <groupId>github.tobsef</groupId>
28 |             <artifactId>hello-maven</artifactId>
29 |             <version>1.2.3</version>
30 |         </dependency>
31 |     </dependencies>
32 | 
33 | 
34 | 
35 | </project>


--------------------------------------------------------------------------------
/src/main/java/de/tfr/test/UseLibTest.java:
--------------------------------------------------------------------------------
 1 | package de.tfr.test;
 2 | 
 3 | import github.tobsef.demo.HelloMaven;
 4 | 
 5 | public class UseLibTest {
 6 | 
 7 |     public static void main(String[] args) {
 8 |         HelloMaven.run();
 9 |     }
10 | 
11 | }
12 | 


--------------------------------------------------------------------------------