atlassian-stash 0.1.1 → 0.1.2

data/README.md

@@ -1,17 +1,42 @@
-Atlassian Stash CLI
-===================
+# Atlassian Stash Command Line Tools
 
+## Installing this tool
+This command line helper for Stash is written in Ruby and is deployed as a [Ruby Gem](https://rubygems.org/gems/atlassian-stash/). Installation is easy, simply run the following command
 
-Build instructions
-------------------
-1. gem install bundler
-2. bundle install
+    $> gem install atlassian-stash
 
-Configuration
--------------
-1. run `stash setup`
-2. Setup a Git alias! ``git config --global alias.create-pull-request "stash pull-request \"\$0\""``
-3. From your git repository, run `git create-pull-request master` to create a pull request from your current branch to master
+(Protip: you might need to `sudo`)
+
+Once the gem is installed, the command `stash` will be in your `$PATH`
+
+## Configuration and usage
+Run `stash configure`. This will prompt for details about your Stash instance.
+
+### Creating a pull request
+Use the `pull-request` command to create a pull request in Stash. E.g:
+
+    $> stash pull-request topicBranch master @michael
+    Create a pull request from branch 'topicBranch' into 'master' with 'michael' added as a reviewer
+
+See the usage for command details 
 
-See the usage help for more information by running
     stash help
+
+## Troubleshooting
+Q: I installed the gem, but the `stash` command doesn't work.  
+A: Do you have another command called `stash` or do you have an alias? Have a look where the command maps to
+
+    $> which -a stash
+
+Then check the value of your $PATH
+
+## I want to contribute
+Thanks! Please [fork this project](https://bitbucket.org/atlassian/atlassian-stash-rubygem/fork) and create a pull request to submit changes back to the original project.
+
+### Build instructions
+Building this gem is easy. To get started, run the following commands:
+
+    $> gem install bundler
+    $> bundler install
+
+Now start hacking, and run the stash command by invoking `./bin/stash command`

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/bin/stash

@@ -22,10 +22,8 @@ def load_config
   config
 end
 
-program :help_formatter, :compact
-
-command 'setup' do |c|
-  c.syntax = 'setup'
+command 'configure' do |c|
+  c.syntax = 'configure'
   c.description = 'Setup configuration details to your Stash instance'
   c.example 'stash setup --username sebr --password s3cre7 --stash_url http://stash.mycompany.com', 'Setup Stash CLI with credentials to the Stash server'
   c.option '--username user', String, 'Writes your Stash username to the configuration file'
@@ -47,6 +45,8 @@ command 'setup' do |c|
     end
 
     File.chmod 0600, $configFile
+
+    create_git_alias if agree "Create a git alias 'git create-pull-request'? "
   end
 end
 
@@ -57,12 +57,13 @@ command 'pull-request' do |c|
     }.compact
   end
 
-  c.syntax = 'pull-request source target'
+  c.syntax = 'pull-request [sourceBranch] targetBranch [@reviewer1 @reviewer2]'
   c.description = 'Create a pull request in Stash'
-  c.example 'stash pull-request topicBranch master', "Creates a pull request from branch 'topicBranch' into 'master'"
+  c.example 'stash pull-request topicBranch master @michael', "Create a pull request from branch 'topicBranch' into 'master' with 'michael' added as a reviewer"
+  c.example 'stash pull-request master', "Create a pull request from the current git branch into 'master'"
   c.action do |args, options|
     if args.length == 0
-      command(:help).run(*args)
+      command(:help).run('pull-request')
       Process.exit
     end
 
@@ -84,5 +85,9 @@ command 'pull-request' do |c|
 end
 
 default_command :help
+program :help_formatter, :compact
+program :help, 'Authors', 'Seb Ruiz <sruiz@atlassian.com> with others'
+program :help, 'Website', 'https://bitbucket.org/atlassian/atlassian-stash-rubygem'
+
 
 # vim set ft=ruby

data/lib/atlassian/stash/git.rb

@@ -22,6 +22,10 @@ module Atlassian
           raise "fatal: Not a git repository"
         end
       end
+
+      def create_git_alias
+        %x(git config --global alias.create-pull-request "\!sh -c 'stash pull-request \\$0'")
+      end
     end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Seb Ruiz
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-26 00:00:00 +11:00
+date: 2012-10-27 00:00:00 +11:00
 default_executable: stash
 dependencies: 
 - !ruby/object:Gem::Dependency