Timothy Potter created LUCENE-6398:
--------------------------------------

             Summary: Usability and documentation issues found trying to build 
an RC using dev-tools/scripts/buildAndPushRelease.py
                 Key: LUCENE-6398
                 URL: https://issues.apache.org/jira/browse/LUCENE-6398
             Project: Lucene - Core
          Issue Type: Improvement
          Components: -tools
            Reporter: Timothy Potter


This ticket is to address usability and documentation problems found while 
trying to do the 5.1 RC. Overall, it's a powerful process, but want to make it 
a bit easier for newbies doing it the first time.

Here's the start:

1) dev-tools/scripts/buildAndPushRelease.py

Prompts you for the following:
{code}
Enter GPG keystore password: 
{code}

It's really asking for the passphrase the key you're using to sign the release 
artifacts, so it seems like it should prompt for something like:

{code}
Enter secret passphrase for key:
{code}

2. At the end of a release build, the scripts says:

{code}
Next set the PYTHON_EXEC env var and you can run the smoker tester:
  $PYTHON_EXEC dev-tools/scripts/buildAndPushRelease.py URL
{code}

Running that command verbatim, you get an error:

{code}
usage: buildAndPushRelease.py [-h] [--no-prepare] [--push-remote USERNAME]
                              [--push-local PATH] [--sign KEYID]
                              [--rc-num NUM] [--smoke-test PATH]
                              checkout_path
buildAndPushRelease.py: error: Root path is not a valid lucene-solr checkout
[~/dev/lw/projects/lucene_solr_5_1]$ $PYTHON_EXEC 
dev-tools/scripts/buildAndPushRelease.py --smoke-test 
file:///Users/timpotter/dev/lw/releases/5.1rc1/lucene-solr-5.1.0-RC1-rev1671632
usage: buildAndPushRelease.py [-h] [--no-prepare] [--push-remote USERNAME]
                              [--push-local PATH] [--sign KEYID]
                              [--rc-num NUM] [--smoke-test PATH]
                              checkout_path
buildAndPushRelease.py: error: the following arguments are required: 
checkout_path
{code}

So we need to fix the example to display what is actually needed to run.

Will add more to the docs as I go thru the process, but wanted to get a ticket 
in place for making improvements.




--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to