Skip to content

Commit

Permalink
Add info how to authenticate to github packages references #14
Browse files Browse the repository at this point in the history
  • Loading branch information
f11h authored May 11, 2021
2 parents a5a2e01 + be85879 commit afa5555
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,24 @@ Whether you cloned or downloaded the 'zipped' sources you will either find the s

In either case open a terminal pointing to the directory you put the sources in. The local build process is described afterwards depending on the way you choose.

### Prerequisites

- OpenJDK 11 (with installed ```keytool``` CLI)
- Maven
- Authenticate to [Github Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)

#### Authenticating to GitHub Packages

As some of the required libraries (and/or versions are pinned/available only from GitHub Packages) You need to authenticate
to [GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)
The following steps need to be followed

- Create [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) with scopes:
- `read:packages` for downloading packages
- Copy/Augment `~/.m2/settings.xml` with the contents of `settings.xml` present in this repository
- Replace `${app.packages.username}` with your github username
- Replace `${app.packages.password}` with the generated PAT

### Maven based build

Building this project is done with maven.
Expand Down

0 comments on commit afa5555

Please sign in to comment.