Skip to content

Commit 98c0924

Browse files
committed
updated installation details with github package details
1 parent c575bc7 commit 98c0924

1 file changed

Lines changed: 41 additions & 1 deletion

File tree

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,47 @@ This provider will work with Java 11 and above.
1818

1919
The Octopus OpenFeature provider for Java is currently published to [GitHub Packages](https://github.com/OctopusDeploy/openfeature-provider-java/packages/2528379). It will be published to the Maven Central repository soon.
2020

21-
To add Maven package dependencies from GitHub Packages, you must configure an [authentication token](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-to-github-packages).
21+
To add Maven package dependencies from GitHub Packages, you will need to add a Maven repository (in either your `settings.xml` or `pom.xml`), and create a GitHub Personal Access Token (classic) with `read:packages` scope, and configure this to be used to authenticate. An example `settings.xml` is shown below:
22+
23+
```xml
24+
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
25+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
26+
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
27+
http://maven.apache.org/xsd/settings-1.0.0.xsd">
28+
29+
<activeProfiles>
30+
<activeProfile>github</activeProfile>
31+
</activeProfiles>
32+
33+
<profiles>
34+
<profile>
35+
<id>github</id>
36+
<repositories>
37+
<repository>
38+
<id>central</id>
39+
<url>https://repo1.maven.org/maven2</url>
40+
</repository>
41+
<repository>
42+
<id>github</id>
43+
<url>https://maven.pkg.github.com/OctopusDeploy/openfeature-provider-java</url>
44+
<snapshots>
45+
<enabled>true</enabled>
46+
</snapshots>
47+
</repository>
48+
</repositories>
49+
</profile>
50+
</profiles>
51+
52+
<servers>
53+
<server>
54+
<id>github</id>
55+
<username>USERNAME</username>
56+
<password>TOKEN</password>
57+
</server>
58+
</servers>
59+
</settings>
60+
```
61+
Read the GitHub docs for more information on [working with GitHub Packages as a Maven registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-to-github-packages).
2262

2363
Once this is configured, you can add the Octopus OpenFeature provider as a dependency. The Maven example is shown below.
2464

0 commit comments

Comments
 (0)