Update documentation on how to develop and document a JVM tool used by Pants

Review Request #2318 - Created June 3, 2015 and submitted

Information
Eric Ayers
pants
zundel/doc-tool-edit
1635
a7b774a...
Reviewers
pants-reviews
jsirois, lahosken

Update documentation on how to develop and document a JVM tool used by Pants

Published to staging dir with ./build-support/bin/publish_docs.sh -d zundel -p

http://pantsbuild.github.io/staging/zundel/howto_develop.html

John Sirois
Eric Ayers
Larry Hosken
Eric Ayers
Review request changed

Status: Closed (submitted)

Change Summary:

Commit 811716e. Published updated docs to http://pantsbuild.github.io

Stu Hood

   
src/python/pants/docs/howto_develop.md (Diff revision 2)
 
 
 
 

As John said, this comes about due to reusing version numbers: rather than ever reusing a version number, it can be helpful to use named snapshots with random stuff appended.

We now tell folks internally to use something like:
--publish-jar-named-snapshot="${USER}-date +%s"

... for all test publishes.

  1. I haven't published anything. Are you saying I need to rename the .jar file and edit BUILD.tools everytime I want to test a new edit to my source code? I'm pretty sure that's what mutable= and a local url= is for.

  2. Are you saying I need to rename the .jar file and edit BUILD.tools everytime I want to test a new edit to my source code?

    Essentially, yes... but rather than "renaming", it's just "republishing." It avoids all other edits and workarounds.

  3. Since we have no local fs m2 repo defined, local publishing is also unwieldy - you'd need to invent an ivysettings.xml and edit pants.ini.  Eric's docs do explain the most reasonable steps today, but as I said fixing mutable=True will reduce all this to just running ./pants binary to iterate as well as fixing mutable=True for all pants users, which is needed if we are to keep it.
Loading...