Skip to content

Commit b080b34

Browse files
committed
Update docs
1 parent 244649f commit b080b34

3 files changed

Lines changed: 19 additions & 18 deletions

File tree

.github/workflows/build.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ jobs:
3434
- name: Build with Gradle
3535
run: ./gradlew build
3636
deploy:
37-
38-
# if: github.event_name == 'push' && github.ref == 'refs/heads/master'
37+
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
3938
name: Deploy SNAPSHOT
4039
runs-on: ubuntu-latest
4140
steps:

.github/workflows/release.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,3 @@ jobs:
5757
with:
5858
body: ${{steps.github_release.outputs.changelog}}
5959
tag_name: ${{ steps.tag_version.outputs.tag }}
60-
files: java-snapshot-testing-*/build/libs/*.jar

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[![Build Status](https://github.com/codedabble-dev/java-snapshot-testing/workflows/build/badge.svg)](https://github.com/codedabble-dev/java-snapshot-testing/actions)
2+
[![Maven Central](https://img.shields.io/maven-central/v/io.github.codedabble-dev/java-snapshot-testing-core.svg)](https://central.sonatype.com/artifact/io.github.codedabble-dev/java-snapshot-testing-core)
23
[![JitPack](https://jitpack.io/v/codedabble-dev/java-snapshot-testing.svg)](https://jitpack.io/#codedabble-dev/java-snapshot-testing)
34

45
# Java Snapshot Testing
@@ -26,22 +27,22 @@ Then java-snapshot-testing might just be what you are looking for!
2627

2728
```groovy
2829
repositories {
29-
maven { url 'https://jitpack.io' }
30+
mavenCentral()
3031
}
3132
3233
// In this case we are using the JUnit5 testing framework
33-
testImplementation 'io.github.codedabble-dev.java-snapshot-testing:java-snapshot-testing-junit5:4.+'
34+
testImplementation 'io.github.codedabble-dev:java-snapshot-testing-junit5:4.+'
3435
3536
// slf4j logging implementation if you don't already have one
3637
testImplementation("org.slf4j:slf4j-simple:2.0.0-alpha0")
3738
3839
// Optional: Many will want to serialize into JSON. In this case you should also add the Jackson plugin
39-
testImplementation 'io.github.codedabble-dev.java-snapshot-testing:java-snapshot-testing-plugin-jackson3:4.+'
40+
testImplementation 'io.github.codedabble-dev:java-snapshot-testing-plugin-jackson3:4.+'
4041
testImplementation 'tools.jackson.core:jackson-core:3.1.0'
4142
testImplementation 'tools.jackson.core:jackson-databind:3.1.0'
4243
4344
// For Jackson 2 use the dedicated plugin and serializer classes instead
44-
testImplementation 'io.github.codedabble-dev.java-snapshot-testing:java-snapshot-testing-plugin-jackson:4.+'
45+
testImplementation 'io.github.codedabble-dev:java-snapshot-testing-plugin-jackson:4.+'
4546
testImplementation 'com.fasterxml.jackson.core:jackson-core:2.11.3'
4647
testImplementation 'com.fasterxml.jackson.core:jackson-databind:2.11.3'
4748
@@ -146,13 +147,13 @@ data.
146147
- Does not give great insight to why the snapshot failed
147148
- Can be difficult to troll though large snapshot changes where you might only be interested in a small set of fields
148149

149-
## Installation [JitPack](https://jitpack.io/#codedabble-dev/java-snapshot-testing)
150+
## Installation [Maven Central](https://central.sonatype.com/search?q=io.github.codedabble-dev)
150151

151-
Add JitPack to your build repositories:
152+
Add Maven Central to your build repositories:
152153

153154
```groovy
154155
repositories {
155-
maven { url 'https://jitpack.io' }
156+
mavenCentral()
156157
}
157158
```
158159

@@ -161,30 +162,32 @@ Then add the module for your test framework. The `4.+` version uses the latest a
161162
Only if you want to integrate with an unsupported framework. [Show me how!](#using-an-unsupported-framework)
162163

163164
```groovy
164-
testImplementation 'io.github.codedabble-dev.java-snapshot-testing:java-snapshot-testing-core:4.+'
165+
testImplementation 'io.github.codedabble-dev:java-snapshot-testing-core:4.+'
165166
```
166167

167168
We currently support:
168169

169170
```groovy
170-
testImplementation 'io.github.codedabble-dev.java-snapshot-testing:java-snapshot-testing-junit4:4.+'
171-
testImplementation 'io.github.codedabble-dev.java-snapshot-testing:java-snapshot-testing-junit5:4.+'
172-
testImplementation 'io.github.codedabble-dev.java-snapshot-testing:java-snapshot-testing-spock:4.+'
171+
testImplementation 'io.github.codedabble-dev:java-snapshot-testing-junit4:4.+'
172+
testImplementation 'io.github.codedabble-dev:java-snapshot-testing-junit5:4.+'
173+
testImplementation 'io.github.codedabble-dev:java-snapshot-testing-spock:4.+'
173174
```
174175

176+
JitPack remains available as an alternative install route at [jitpack.io/#codedabble-dev/java-snapshot-testing](https://jitpack.io/#codedabble-dev/java-snapshot-testing).
177+
175178
Plugins
176179

177-
- Jackson for JSON serialization
178-
- Jackson 3 for JSON serialization
180+
- [Jackson for JSON serialization](https://central.sonatype.com/artifact/io.github.codedabble-dev/java-snapshot-testing-plugin-jackson)
181+
- [Jackson 3 for JSON serialization](https://central.sonatype.com/artifact/io.github.codedabble-dev/java-snapshot-testing-plugin-jackson3)
179182
- You need jackson on your classpath (Gradle example)
180183
```groovy
181184
// Jackson 2 plugin
182-
testImplementation 'io.github.codedabble-dev.java-snapshot-testing:java-snapshot-testing-plugin-jackson:4.+'
185+
testImplementation 'io.github.codedabble-dev:java-snapshot-testing-plugin-jackson:4.+'
183186
testImplementation 'com.fasterxml.jackson.core:jackson-core:2.11.3'
184187
testImplementation 'com.fasterxml.jackson.core:jackson-databind:2.11.3'
185188
186189
// Jackson 3 plugin
187-
testImplementation 'io.github.codedabble-dev.java-snapshot-testing:java-snapshot-testing-plugin-jackson3:4.+'
190+
testImplementation 'io.github.codedabble-dev:java-snapshot-testing-plugin-jackson3:4.+'
188191
testImplementation 'tools.jackson.core:jackson-core:3.1.0'
189192
testImplementation 'tools.jackson.core:jackson-databind:3.1.0'
190193
```

0 commit comments

Comments
 (0)