Skip to content
This repository was archived by the owner on Nov 13, 2019. It is now read-only.

Commit b0ab87a

Browse files
committed
Adding release information to the README.
1 parent 17048a2 commit b0ab87a

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,25 @@
1-
#### develop-wip Fork
2-
This branch (`develop-wip`) contains features not yet merged into the [upstream develop branch](https://github.com/jasminb/jsonapi-converter). Specifically it contains bug fixes for:
1+
#### Custom Fork
2+
3+
This fork contains features not yet merged into the [upstream develop branch](https://github.com/jasminb/jsonapi-converter). Specifically it contains bug fixes for:
34

45
* detecting and preventing recursions while resolving relationships ([#28](https://github.com/jasminb/jsonapi-converter/issues/28))
56
* correctly parsing `to-many` and `to-one` responses while resolving relationships ([#30](https://github.com/jasminb/jsonapi-converter/issues/30))
67
* supports storing relationship urls as string references ([#31](https://github.com/jasminb/jsonapi-converter/issues/31))
78

9+
It is released under the Maven groupId:artifactId `org.dataconservancy:jsonapi-converter`
10+
11+
#### Custom Release Process
12+
13+
To make a release, have a clean working copy. Run (substituting the proper versions in):
14+
15+
* `mvn release:prepare -DpushChanges=false -Dtag=dataconservancy-local-release-0.3 -DreleaseVersion=0.3 -DdevelopmentVersion=0.4-SNAPSHOT -Dresume=false`
16+
* `mvn -e release:perform -Dgoals=deploy -DlocalCheckout=true`
17+
18+
If the git logs look good after performing the release, push the changes to `origin`.
19+
20+
21+
### Examples
22+
823
<pre>
924
@Types("node")
1025
class Node {

0 commit comments

Comments
 (0)