Skip to content

Commit 32e82d0

Browse files
committed
Add notes about working with jgitver in IntelliJ
1 parent a761930 commit 32e82d0

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,28 @@ To build a mock server, callers should use a [`MockApnsServerBuilder`](https://p
235235

236236
Callers may also provide a [`MockApnsServerListener`](https://pushy-apns.org/apidocs/0.15/com/eatthepath/pushy/apns/server/MockApnsServerListener.html) when building a mock server; listeners are notified whenever the mock server accepts or rejects a notification from a client.
237237

238+
## Building Pushy
239+
240+
Pushy uses [Maven](https://maven.apache.org/) as its build system. To build Pushy from source:
241+
242+
```shell
243+
./mvnw clean package
244+
```
245+
246+
…or to run tests:
247+
248+
```shell
249+
./mvnw clean test
250+
```
251+
252+
### For IntelliJ IDEA users
253+
254+
Note that IntelliJ IDEA struggles with multi-module projects that set their versions on the fly (like Pushy). Please see [IDEA-187928](https://youtrack.jetbrains.com/issue/IDEA-187928/Jgitver-not-working-at-all-for-a-multimodule-project) for background and discussion, but in short, IntelliJ users are likely to encounter an error something like:
255+
256+
> Could not find artifact com.eatthepath:pushy:jar:tests:0.15.5-SNAPSHOT
257+
258+
To work around the issue, IntelliJ users can navigate to Settings → Build, Execution, Deployment → Build Tools → Maven → Importing and add `-Djgitver.skip=true` to "VM options for importer."
259+
238260
## License and status
239261

240262
Pushy is available under the [MIT License](https://github.com/jchambers/pushy/blob/master/LICENSE.md).

0 commit comments

Comments
 (0)