Skip to content

Commit 3ae7134

Browse files
committed
Extend README with SNAPSHOT usage
1 parent dffe5fe commit 3ae7134

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

README.md

+68
Original file line numberDiff line numberDiff line change
@@ -320,3 +320,71 @@ Many integrations require specialisation of the FIX Messages, Components and/or
320320
![image info](./src/main/puml/custom_dependencies.png)
321321

322322
![image info](./src/main/puml/custom_dependencies_fixt11_fixlatest.png)
323+
324+
### Using SNAPSHOTs
325+
326+
The nightly SNAPSHOT releases are available on **GitHub Packages**.
327+
GitHub Packages requires authentication - even for public repositories.
328+
You need to use a [Personal Access Token (PAT)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
329+
with `read:packages` permission.
330+
331+
#### Maven Setup:
332+
333+
Add the authentication part to your `settings.xml` file in `servers`:
334+
335+
```xml
336+
<!--settings.xml-->
337+
<servers>
338+
<server>
339+
<id>github-quickfixj</id>
340+
<username>USERNAME</username> <!-- Your GitHub username -->
341+
<password>GITHUB_PAT</password> <!-- Your GitHub PAT -->
342+
</server>
343+
</servers>
344+
```
345+
346+
Add the GitHub Packages repository in `repositories` and the desired `SNAPSHOT` version in `dependencies`:
347+
348+
```xml
349+
<!--pom.xml-->
350+
<repositories>
351+
<repository>
352+
<id>github-quickfixj</id>
353+
<name>GitHub Packages for quickfixj</name>
354+
<url>https://maven.pkg.github.com/quickfixj/quickfixj</url>
355+
<snapshots>
356+
<enabled>true</enabled>
357+
</snapshots>
358+
</repository>
359+
360+
<!-- other repositories-->
361+
</repositories>
362+
363+
364+
<dependencies>
365+
<dependency>
366+
<groupId>org.quickfixj</groupId>
367+
<artifactId>quickfixj-all</artifactId>
368+
<version>3.0.0-SNAPSHOT</version>
369+
</dependency>
370+
371+
<!-- other dependencies-->
372+
</dependencies>
373+
```
374+
375+
#### Gradle Setup (groovy):
376+
377+
Add the following to your `build.gradle` file:
378+
379+
```groovy
380+
//build.gradle
381+
repositories {
382+
maven {
383+
url = uri("https://maven.pkg.github.com/quickfixj/quickfixj")
384+
credentials {
385+
username = "USERNAME" // Your GitHub username
386+
password = "GITHUB_PAT" // Your GitHub PAT
387+
}
388+
}
389+
}
390+
```

0 commit comments

Comments
 (0)