travis_github_deployer 0.1.1 → 0.1.2

data/README.md

@@ -20,23 +20,25 @@ You can set up these environment variables in a secure way using the travis gem,
 {% highlight bash %}
 $ gem install travis
 $ cd <name of your repository>
-$ curl -u <your username> -d '{"scopes":["public_repo"],"note":"Travis CI deployer"}' https://api.github.com/authorizations
-$ travis encrypt 'GIT_NAME="<your name>" GIT_EMAIL=<your email> GH_TOKEN=<your token>' --add
+$ curl -u <your username> -d '{"scopes":["public_repo"],"note":"Travis CI deployer"}' \
+	https://api.github.com/authorizations
+$ travis encrypt 'GIT_NAME="<your name>" GIT_EMAIL=<your email> \
+	GH_TOKEN=<your token>' --add
 {% endhighlight %}
 
 ### How does this work?
 
 The following command:
 
-{% highlight bash %}
+```bash
 $ curl -u <your username> -d '{"scopes":["public_repo"],"note":"Travis CI deployer"}' https://api.github.com/authorizations
-{% endhighlight %}
+```
 
 This will get an authentication token. With it, Travis CI can commit under your name. So be careful with it. Then with the following command:
 
-{% highlight bash %}
+```bash
 $ travis encrypt 'GIT_NAME="<your name>" GIT_EMAIL=<your email> GH_TOKEN=<your token>' --add
-{% endhighlight %}
+```
 
 This will take the taken and add it to a 'secure' section in your travis.yml. The Travis Github Deployer will grab it from that section and use it to push up the changes to your repository
 
@@ -46,22 +48,38 @@ The Travis Github Deployer uses one config file: ".travis_github_deployer"
 
 A typical file looks like this:
 
-{% highlight yaml %}
-
+```yml
 destination_repository: https://github.com/basvodde/travis_github_deployer.git
 
 files_to_deploy:
   source_dir/source_file: destination_dir/destination_file
   another_file: another_dir/new_name
 
-{% endhighlight %}
+```
 
 This yaml file configures the repository to push to to be travis_github_deployer.git and it will copy 2 files from the build into the repository: source_dir/source_file and another_file. It will copy them to destination: destination_dir/destination_file and another_dir/new_name.
 
 ## Running Travis Github Deployer
 
+Then... running the travis_github_deployer is all you need to do, that is, after installing the gem:
+
+```bash
+$ gem install travis_github_deployer
+$ travis_github_deployer
+```
+
+By default, the deployer will check whether there is a pull request or not and skip deploying on a pull request
 
+# Contributions
 
+At the time I write this README, the project is at a very initial stage and just written to get something of myself to work. However, I've thought about more improvements...
 
+* Support for putting configuration inside the .travis.yml instead
+* Support for passing the configuration to the script as parameter
+* Support for committing in the same repository as was checked out by travis CI (no need to clone)
+* Support for wildcards on files
+* Some integration tests
+* More
 
+Contributions are more than welcome, please send your pull requests. Do remember, code is test-driven and no code will be accepted without tests...
 

data/lib/travis_github_deployer/travis_github_deployer.rb

@@ -25,6 +25,11 @@ class TravisGithubDeployer
   ## Deployment 
     
   def deploy
+    if (environment_variable_value('TRAVIS_PULL_REQUEST') != "false")
+      puts "In pull request and won't be deploying"
+      return
+    end
+    
     load_configuration
     clone_destination_repository
     change_current_directory_to_cloned_repository
@@ -77,7 +82,7 @@ class TravisGithubDeployer
     value
   end
     
-  def copy_files_to_deployment_repository
+  def copy_files_in_destination_repository
     
     files_to_deploy.each { |source_location, destination_location|
       source = Pathname.new(source_location)

data/lib/travis_github_deployer/version.rb

@@ -1,4 +1,4 @@
 
 module TravisGithubDeployerVersion
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/travis_github_deployer_spec.rb

@@ -11,6 +11,7 @@ describe "travis github deployer" do
   end
   
   it "can deploy to an destination repository" do
+    ENV['TRAVIS_PULL_REQUEST']="false"
     subject.should_receive(:load_configuration)
     subject.should_receive(:clone_destination_repository)
     subject.should_receive(:change_current_directory_to_cloned_repository)
@@ -20,6 +21,13 @@ describe "travis github deployer" do
     subject.deploy
   end
   
+  it "will not deploy on a pull request" do
+    ENV['TRAVIS_PULL_REQUEST']="10"
+    subject.should_not_receive(:load_configuration)
+    subject.should_receive(:puts).with("In pull request and won't be deploying")
+    subject.deploy
+  end
+  
   context "Prepare repository for being able to commit" do
     
     it "can clone the destination repository" do
@@ -77,14 +85,14 @@ describe "travis github deployer" do
     it "should be able to copy a file from the root of the source repository to the root of the destination reportistory" do
       subject.should_receive(:files_to_deploy).and_return( { "sourcefile" => ""})
       FileUtils.should_receive(:copy).with(Pathname.new("sourcefile"), Pathname.new("github_pages/sourcefile"))
-      subject.copy_files_to_deployment_repository
+      subject.copy_files_in_destination_repository
     end
     
     it "Should be able to copy multiple files" do
       subject.should_receive(:files_to_deploy).and_return({ "dir/onefile" => "destonefile", "twofile" => "dir/desttwofile"})
       FileUtils.should_receive(:copy).with(Pathname.new("dir/onefile"), Pathname.new("github_pages/destonefile"))
       FileUtils.should_receive(:copy).with(Pathname.new("twofile"), Pathname.new("github_pages/dir/desttwofile"))
-      subject.copy_files_to_deployment_repository      
+      subject.copy_files_in_destination_repository      
     end
   end
   

metadata

@@ -2,7 +2,7 @@
 name: travis_github_deployer
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Bas Vodde