Skip to content

Commit 2346ece

Browse files
committed
Document using GitPack or GitHub Packages as a source
1 parent e73648c commit 2346ece

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,64 @@ A common example is using Wiremock 3.x with Java 1.8.
2323

2424
### Importing the dependency
2525

26+
At the moment the module is published to GitHub Packages only,
27+
see [Issue #56](https://github.com/wiremock/wiremock-testcontainers-java/issues/56)
28+
for publishing to Maven Central.
29+
For the moment, you can use the authenticated GitHub Packages server or
30+
[JitPack](https://jitpack.io/) to add the dependency in your projects.
31+
32+
#### Maven / JitPack
33+
34+
```xml
35+
<dependencies>
36+
<dependency>
37+
<groupId>com.github.wiremock</groupId>
38+
<artifactId>wiremock-testcontainers-java</artifactId>
39+
<version>${wiremock-testcontainers.version}</version>
40+
<scope>test</scope>
41+
</dependency>
42+
<!-- .... Other Dependencies -->
43+
</dependencies>
44+
45+
<repositories>
46+
<repository>
47+
<id>jitpack.io</id>
48+
<url>https://jitpack.io</url>
49+
</repository>
50+
</repositories>
51+
```
52+
53+
<details>
54+
<summary>
55+
Gradle / JitPack
56+
</summary>
57+
58+
#### Gradle / JitPack
59+
60+
```groovy
61+
allprojects {
62+
repositories {
63+
maven { url 'https://jitpack.io' }
64+
}
65+
}
66+
67+
dependencies {
68+
testImplementation 'com.github.wiremock:wiremock-testcontainers-java:${wiremock-testcontainers.version}'
69+
}
70+
71+
```
72+
</details>
73+
74+
<details>
75+
<summary>
76+
Maven / GitHub Packages
77+
</summary>
78+
79+
#### Maven / GitHub Packages
80+
81+
GitHub Packages uses the official Maven coordinates,
82+
but you will need to configure the server and authentication.
83+
2684
```xml
2785
<dependency>
2886
<groupId>org.wiremock.integrations.testcontainers</groupId>
@@ -32,6 +90,8 @@ A common example is using Wiremock 3.x with Java 1.8.
3290
</dependency>
3391
```
3492

93+
</details>
94+
3595
### Using the test container in JUnit 4/5
3696

3797
P.S: Javadoc is coming soon!

0 commit comments

Comments
 (0)