Page MenuHomeSoftware Heritage

Add swh-graph server side README
ClosedPublic

Authored by haltode on Jul 11 2019, 1:29 PM.

Diff Detail

Repository
rDGRPH Graph service
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

haltode created this revision.Jul 11 2019, 1:29 PM
haltode edited the summary of this revision. (Show Details)Jul 11 2019, 1:33 PM
zack added a comment.Jul 11 2019, 1:49 PM

In addition to the note above, if you want the commit to automatically close the relevant task, you should use "Closes Txxx" explicitly instead of "See Txxx".

api/server/README.md
17–19

Is the .jar supposed to be built by the mvn compile command above? Because currently it isn't (the directory target/ is there, but it doesn't contain the .jar). So either the build should be fixed, or an explanation linking the previous section with this one is needed.

31–33

Alternative version (meant to highlight that there is nothing to be done by default to just run tests):

Unit tests rely on test data that are already available in the Git repository (under src/test/dataset/), so you generally only need to run them using Maven, as shown above. In case you want to regenerated the test data, you can do as as follows:

... or something along these lines.

44–47

as per above, this doesn't work as the .jar is not available under target/

zack requested changes to this revision.Jul 11 2019, 1:49 PM
This revision now requires changes to proceed.Jul 11 2019, 1:49 PM
haltode updated this revision to Diff 5790.Jul 11 2019, 3:39 PM
  • Fix full .jar name in commands
  • Add suggested style improvements
  • Use 'swh-graph' in pom.xml
haltode added inline comments.Jul 11 2019, 3:39 PM
api/server/README.md
17–19

I forgot the assembly:single part here, it is indeed a mistake. However the default name of generated .jar file is swh-graph-1.0-jar-with-dependencies.jar and I was trying to search for ways to rename it to simply swh-graph-1.0.jar but solutions are not great and this is default behavior in maven so I will update the naming too.

zack accepted this revision.Jul 11 2019, 3:58 PM
This revision is now accepted and ready to land.Jul 11 2019, 3:58 PM
haltode updated this revision to Diff 5799.Jul 11 2019, 3:59 PM

Rebasing on master

This revision was automatically updated to reflect the committed changes.