https://github.com/axel-op/maven-packages
https://github.com/axel-op/maven-packages
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/axel-op/maven-packages
- Owner: axel-op
- Created: 2021-03-31T17:38:06.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-18T17:28:11.000Z (about 3 years ago)
- Last Synced: 2025-02-08T10:26:22.864Z (8 months ago)
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# maven-packages
This repository contains the Maven libraries that I created. They're hosted on GitHub Packages. [Here's the full list](https://github.com/axel-op/maven-packages/packages).
Below are the instructions to use them in your Java project.
## Authenticating to GitHub Packages
This is a **one-time setup to use any Maven artifact from GitHub Packages**.
You must [create a Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token), with at least the [`read:packages` scope](https://docs.github.com/en/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries).
It is required to install any library from GitHub Packages, [even if it's public](https://docs.github.com/en/packages/learn-github-packages/introduction-to-github-packages#authenticating-to-github-packages).
### On your local computer
Add your credentials to GitHub Packages in your [`settings.xml`](https://maven.apache.org/settings.html) file:
```xml
github-packages
${YOUR_GITHUB_USERNAME}
${YOUR_GITHUB_PAT}
```
### In a GitHub Actions workflow
```yml
jobs:
your-job:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Maven Central Repository
uses: actions/setup-java@v3
with:
java-version: '11'
server-id: github-packages # you'll use the same ID in your pom.xml
server-username: MAVEN_USERNAME
server-password: MAVEN_PASSWORD
- run: mvn test # or whatever command you want to run
env:
MAVEN_USERNAME: ${{ secrets.GITHUB_USERNAME }}
MAVEN_PASSWORD: ${{ secrets.GITHUB_PAT }}
```
[Create secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) to encrypt your username and your PAT.
For more complex workflows, use the [maven-settings-action](https://github.com/s4u/maven-settings-action).
## Adding a dependency in your `pom.xml`
Add a reference to this repository in your [`pom.xml`](https://maven.apache.org/pom.html#Repositories):
```xml
github-packages
axel-op Maven libraries
https://maven.pkg.github.com/axel-op/maven-packages
```
You can now add a dependency to [any Maven artifact in this repository](https://github.com/axel-op/maven-packages/packages)! For example:
```xml
fr.axelop.agnosticserverlessfunctions
agnostic-serverless-functions-interfaces
0.0.1-SNAPSHOT
```