ministryofjustice-danger 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8df765a9d38c80e4cfabbc90cf6422fd255d42b3
-  data.tar.gz: 8af4a140e56b48372b4dc4856807ac7585618ed8
+  metadata.gz: 08483394e0c5044b4e9ffb9b5730c957ff22cd33
+  data.tar.gz: ed92bf24458017e8314dc6e9441ce6e2cfc3e02b
 SHA512:
-  metadata.gz: ce47c23cce74c427bcb89bd971fc318e2c8445b354443c8aaa0595441da9c7f983dfd31af34dcb566ff6315537a5e477714ed92cb597ba0fd26b37045762b1bf
-  data.tar.gz: c914bcaeb26202b022336bf4682975ba00448a86e931b016fb35c558a8ed1662c736345ba7f1340945a38b8c6fdfdbab92bd2d02808d0ff898da95010a50a7e8
+  metadata.gz: e53601cd70ec4d17d4c596854f2b8e632756d69360c1467cd97ae3606b9a23fcee16a79af0dcbecf04fb58b22df049c40fb71eb6add0a5fd57773d554a2e6210
+  data.tar.gz: 58a6065eece9cf1a2a00938e51e61a870a25d286575cb6d733d25da3f3a00ccf13ecc121d6f58f941ef43c61669845bab4627a446661bbeb62f0132cd244c476

data/README.md

@@ -4,33 +4,38 @@
 ensure our commits, pull requests, and more meet a minimum level
 of quality.
 
-## Setup
+[![Gem Version](https://badge.fury.io/rb/ministryofjustice-danger.svg)](https://badge.fury.io/rb/ministryofjustice-danger)
 
-Enable Danger for a project within the [ministryofjustice
-organization](https://github.com/ministryofjustice).
+# Setup
 
-### Configure Danger to use this repo's Dangerfile
+## Add Danger to your [Ministry of Justice](https://github.com/ministryofjustice) Ruby project
 
-Commit a `Dangerfile` containing linking to this repo:
+1. Add the following to your Gemfile;
 
-```ruby
-danger.import_dangerfile(github: 'ministryofjustice/danger')
+```
+group :development do
+  gem 'ministryofjustice-danger'
+end
 ```
 
-### If you're running Ruby
+2. `bundle install`
 
-Add `danger` to your `Gemfile`.
+3. Create a Dangerfile that imports the central MoJ Dangerfile
 
-```ruby
-gem 'danger'
+```bash
+echo "danger.import_dangerfile(github: 'ministryofjustice/danger')" > Dangerfile
 ```
 
-#### Run Danger in Travis
+Commit and push your changes.
+
+## Run Danger via [Travis CI](https://travis-ci.org)
 
-Add Danger to `.travis.yml`:
+1. Add Danger to your `.travis.yml` (use whatever ruby version (>= 2.3.0) is appropriate)
 
 ```yaml
-before_script:
+rvm: 2.3.3
+
+script:
   - bundle exec danger
 ```
 
@@ -39,31 +44,69 @@ before_script:
 ```yaml
 matrix:
   include:
-    - rvm: 2.3.1
+    - rvm: 2.3.3
       script:
         - bundle exec danger
 ```
 
-And add the `DANGER_GITHUB_API_TOKEN` as an environment variable in
-Travis's repo settings, which are at a URL like
-`https://travis-ci.org/ministryofjustice/[repo]/settings`. The API token
-itself is in Rattic (search for `Danger`).
+Commit and push the changes.
+
+2. Add the MoJ Dangerbot API token to Travis;
+
+This assumes your project has already been added to Travis.
 
-#### Run Danger in CircleCI
+    https://travis-ci.org/ministryofjustice/[your project]/settings
+
+[Add the environment variable](https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings)
+`DANGER_GITHUB_API_TOKEN`, with the value
+from the password field of the `MOJ Danger bot Github API token` entry
+in Rattic.
+
+Danger will now run against every PR which is raised, and will create comments
+about any errors that it finds (the comments will be removed once the issues
+are fixed).
+
+## Run Danger via [CircleCI](https://circleci.com)
 
 Just add `bundle exec danger` to your `circle.yml`, either as an extra
 step in your `test` overrides, or in a new `pre` section. You'll need
-to add the `DANGER_GITHUB_API_TOKEN` to the environment variables like
-with Travis, and [Danger
-recommend](http://danger.systems/guides/getting_started.html#setting-up-danger-to-run-on-your-ci)
+to add the `DANGER_GITHUB_API_TOKEN` to the environment variables,
+like with Travis, and
+[Danger recommend](http://danger.systems/guides/getting_started.html#setting-up-danger-to-run-on-your-ci)
 setting “only build pull requests” in the advanced settings.
 
-### If you're not running Ruby
+## If you're not running Ruby
 
 If Danger is your only Ruby dependency, you probably don't want to have
 a Gemfile cluttering up your repo. In that case, you can (probably) use
 this command in the Travis config above:
 
 ```bash
-rbenv global 2.3.1 && gem install danger --version '~> 5.0' && danger
+rbenv global 2.3.1 && gem install ministryofjustice-danger --version '~> 0.1' && danger
+```
+
+## Updating the gem
+
+e.g. to add new runtime dependencies
+
+1. Make your changes to `ministryofjustice-danger.gemspec`
+
+2. Update the version in  `ministryofjustice-danger.gemspec`
+
+3. Build the gem
+```
+gem build ministryofjustice-danger.gemspec
 ```
+
+4. Publish to [Rubygems](https://rubygems.org)
+```
+gem push ministryofjustice-danger-[VERSION].gem
+```
+
+## Fixing your commits
+
+To keep Danger happy, you will need to amend commits that you have already pushed.
+
+This [Github article](https://help.github.com/articles/changing-a-commit-message/)
+describes a process for doing this. But, please use [--force-with-lease](https://developer.atlassian.com/blog/2015/04/force-with-lease/)
+instead of `--force` when pushing your amendments.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ministryofjustice-danger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ministry of Justice
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-12 00:00:00.000000000 Z
+date: 2017-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: danger-commit_lint
   requirement: !ruby/object:Gem::Requirement