Skip to content

Document using JitPack or GitHub Packages as a source #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oleg-nenashev merged 1 commit into from
Jul 6, 2023
Merged

Document using JitPack or GitHub Packages as a source #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,64 @@ A common example is using Wiremock 3.x with Java 1.8.

### Importing the dependency

At the moment the module is published to GitHub Packages only,
see [Issue #56](https://github.com/wiremock/wiremock-testcontainers-java/issues/56)
for publishing to Maven Central.
For the moment, you can use the authenticated GitHub Packages server or
[JitPack](https://jitpack.io/) to add the dependency in your projects.

#### Maven / JitPack

```xml
<dependencies>
<dependency>
<groupId>com.github.wiremock</groupId>
<artifactId>wiremock-testcontainers-java</artifactId>
<version>${wiremock-testcontainers.version}</version>
<scope>test</scope>
</dependency>
<!-- .... Other Dependencies -->
</dependencies>

<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
```

<details>
<summary>
Gradle / JitPack
</summary>

#### Gradle / JitPack

```groovy
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}

dependencies {
testImplementation 'com.github.wiremock:wiremock-testcontainers-java:${wiremock-testcontainers.version}'
}

```
</details>

<details>
<summary>
Maven / GitHub Packages
</summary>

#### Maven / GitHub Packages

GitHub Packages uses the official Maven coordinates,
but you will need to configure the server and authentication.

```xml
<dependency>
<groupId>org.wiremock.integrations.testcontainers</groupId>
Expand All @@ -32,6 +90,8 @@ A common example is using Wiremock 3.x with Java 1.8.
</dependency>
```

</details>

### Using the test container in JUnit 4/5

P.S: Javadoc is coming soon!
Expand Down