circleci-bundle-update-pr 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b17fc21726a6f08a46ee8b2ba9fe1dbb7300e89
-  data.tar.gz: c18fb17e6b0cdef978b26f86df546df11470a02b
+  metadata.gz: ec15a9ea284e113041573a7ee82f8aad3e5ad3dc
+  data.tar.gz: 9058ee5035d097cdb0e534a39072b2c1ef400023
 SHA512:
-  metadata.gz: 739732231816ab278a7423b01552b837e103d5fbb2f644389c0d6b9682cf8aa7ce5d60891679d4898ae0e0b6bc4881461eeb6592a04dc915c7c03e6d6783067d
-  data.tar.gz: 1b1ff33a379e207620b9b3082d473bab23726a69692d74809ea1044ce6c135e054e1327fc02ea3e0a45fc6f048467bd0595ba0210277d5a1846a3de7b26add63
+  metadata.gz: b0aaf83bd78161760d3aef76081e543e5660cd5b417b10e82acb3434ad815d7dadb5f33d09e358f0fad85ca8bd213cb47c76d6aff5432bfb69280d9880b37022
+  data.tar.gz: fa8f7d28460191166be8daa72f3c9966e955b1823d634d1d592fac556dab0470ac1402733ca128e598e107e86dbe979cf532fe04c4651f8e5284702b133e86a4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    circleci-bundle-update-pr (1.4.0)
+    circleci-bundle-update-pr (1.5.0)
       compare_linker
       octokit (~> 3.8)
 
@@ -9,12 +9,12 @@ GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.3.8)
-    compare_linker (1.2.1)
+    compare_linker (1.3.0)
       httpclient
       octokit
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    httpclient (2.7.1)
+    httpclient (2.8.2.4)
     multipart-post (2.0.0)
     octokit (3.8.0)
       sawyer (~> 0.6.0, >= 0.5.3)
@@ -32,4 +32,4 @@ DEPENDENCIES
   rake (~> 10.0)
 
 BUNDLED WITH
-   1.12.5
+   1.13.1

data/README.md

@@ -1,30 +1,95 @@
 # Circleci::Bundle::Update::Pr [![Gem Version][gem-badge]][gem-link]
 
-circleci-bundle-update-pr is a script for continues bundle update. Use in CircleCI
+circleci-bundle-update-pr is an automation script for continuous bundle update and for sending a pull request via CircleCI [Nightly builds](https://circleci.com/docs/nightly-builds/).
+
+By requesting a nightly build to CircleCI with an environment variable configured in `circle.yml` to execute this script, bundle update is invoked, then commit changes and send a pull request to GitHub repository if there some changes exist.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```
+$ gem install circleci-bundle-update-pr
+```
+
+## Prerequisites
+
+The application on which you want to run continuous bundle update must be configured to be built on CircleCI.
+
+## Usage
+
+### Setting GitHub personal access token to CircleCI
+
+GitHub personal access token is required for sending pull requests to your repository.
+
+1. Go to [your account's settings page](https://github.com/settings/tokens) and generate a personal access token with "repo" scope
+2. On CircleCI dashboard, go to your application's "Project Settings" -> "Environment Variables"
+3. Add an environment variable `GITHUB_ACCESS_TOKEN` with your GitHub personal access token
+
+### Getting CircleCI API token
+
+CircleCI API token is required to trigger nightly builds.
+
+1. Go to your application's "Project Settings" -> "API Permissions"
+2. Select "Create Token" and create a new token with "All" scope and any label you like
+
+### Configure circle.yml
+
+Configure your `circle.yml` to run `circleci-bundle-update-pr` if `BUNDLE_UPDATE` environment variable is present, for example:
 
-```ruby
-gem 'circleci-bundle-update-pr'
+```yaml
+deployment:
+  production:
+    branch: master
+    commands:
+      - |
+        if [ "${BUNDLE_UPDATE}" ] ; then
+          gem update bundler --no-document
+          gem install circleci-bundle-update-pr
+          circleci-bundle-update-pr <username> <email>
+        fi
 ```
 
-And then execute:
+NOTE: Please make sure you replace `<username>` and `<email>` with yours.
 
-    $ bundle
+### Trigger nightly build API via curl
 
-Or install it yourself as:
+The easiest way to start a nightly build is using curl. The below is a simple script to trigger a build.
 
-    $ gem install circleci-bundle-update-pr
+```bash
+_project=<username>/<reponame>
+_branch=master
+_circle_token=<ciecleci api token>
 
-## Usage
+trigger_build_url=https://circleci.com/api/v1/project/${_project}/tree/${_branch}?circle-token=${_circle_token}
+
+post_data='{ "build_parameters": { "BUNDLE_UPDATE": "true" } }'
+
+curl \
+  --header "Accept: application/json" \
+  --header "Content-Type: application/json" \
+  --data "${post_data}" \
+  --request POST ${trigger_build_url}
+```
+
+NOTE: Please do not forget to replace `<username>/<reponame>/<circleci api token>` with yours.
+
+
+### Trigger nightly build via ci-bundle-update (recommended)
 
-    $ circleci-bundle-update-pr 'Git username' 'Git email address'
+While you can trigger nightly builds by using whatever you want for sending requests to API, the most recommended way is to use "ci-bundle-update". Please see https://github.com/masutaka/ci-bundle-update for details.
+
+## CLI command references
+
+General usage:
+
+```
+$ circleci-bundle-update-pr <git username> <git email address>
+```
 
 By default, it works only on master branch, but you can also explicitly specify any branches rather than only master branch by adding them to the arguments.
 
-    $ circleci-bundle-update-pr 'Git username' 'Git email address' master develop topic
+```
+$ circleci-bundle-update-pr <git username> <git email address> master develop topic
+```
 
 ## Contributing
 

data/lib/circleci/bundle/update/pr.rb

@@ -55,6 +55,8 @@ module Circleci
           compare_linker.formatter = CompareLinker::Formatter::Markdown.new
 
           comment = <<-EOC
+**Updated RubyGems:**
+
 #{compare_linker.make_compare_links.to_a.join("\n")}
 
 Powered by [compare_linker](https://rubygems.org/gems/compare_linker)

data/lib/circleci/bundle/update/pr/version.rb

@@ -2,7 +2,7 @@ module Circleci
   module Bundle
     module Update
       module Pr
-        VERSION = "1.4.0"
+        VERSION = "1.5.0"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circleci-bundle-update-pr
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Takashi Masuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2016-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit