search

symphonyoss / symphony-java-sample-bots

A set of simple Bots for Symphony, implemented in Java.
Apache License 2.0
20 stars 14 forks source link

Simplify command line execution of the sample bots #17

Open pmonks opened 7 years ago

pmonks commented 7 years ago

Currently the sample bots are invoked via a confusing mix of 3 scripts:

  1. run-bot.sh
  2. env.sh
  3. target/symphony-java-sample-bots-0.9.0-SNAPSHOT/bin/RunBot

There's also a run-it.sh script that further confuses newcomers (it has nothing to do with starting the bots, but newcomers don't know that and so go digging around in it to try to figure out what it's for).

Given that the primary goal of the sample bots is to provide a short and shallow on-ramp to Symphony bot development in Java, it's critical that all elements of these samples be distilled down to their absolute simplest, even where that would not be considered production-grade best practice.

These startup scripts (like the RunBot class itself - see issue #7) are nowhere near suitable for a newcomer to approach and digest without assistance, and therefore to meet this repository's overarching goal.

pmonks commented 7 years ago

Proposed Solution

  1. Ditch target/symphony-java-sample-bots-0.9.0-SNAPSHOT/bin/RunBot - while "production grade" it's vastly overengineered for the need at hand
  2. Bring a plain and simple java -jar target/symphony-java-sample-bots-0.9.0-SNAPSHOT.jar ... command back into run-bot.sh
  3. Move run-it.sh "out of the way" - perhaps into .travis.yml, or at the very least into a subdirectory to hide it from view
maoo commented 6 years ago

Ready for review on develop. TY for raising this @pmonks !