accesslint-ci 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa3733f759107ca29fd992d26ecd88efcc9684d8
-  data.tar.gz: 63f81acd0c0e944ce91de37eab291db58e4acd9e
+  metadata.gz: 10d05a2f67359d4a5abe5cd8dcf5d53d215852a0
+  data.tar.gz: 8026ee0c69ab49663632d73a177146aaa764a316
 SHA512:
-  metadata.gz: 2320999589fa6632918af2da7e898195120470dffca0f41f5c45ad6b1b3af2069e2744c93a682de7386c734411212e02d53ba5da0233a6191a736073030204e9
-  data.tar.gz: 4d79183eec4607ea405c7fc063bb14f2c4ad9b5f13e49ee0cea8dfb5798b7221fd521408cffc655ee54cdfb5d7be0405f93c9710e5967a006d83dd21ca971e1f
+  metadata.gz: 9e3d2092ae53059c93195afcf71cb855fdd28845fd8ccc854a8209eb47e6c71c350334b6e4bcf9260508dbbb5ee942d8c277105679d6f38834470cd48da4ca6e
+  data.tar.gz: 1f2de2bedd962932463aa08cbb85e449ed72ee4ecac51b53ddb77e7874b4bccaafe9a4c05c196fd86aa301d081663500d9c691a0c67550a4395cc421e2ab49f8

data/README.md

@@ -1,52 +1,43 @@
 # Accesslint::Ci
 
-Run accesslint-cli in CircleCI
+Runs accesslint-cli in CircleCI and comments on GitHub pull requests with new
+accessibility issues.
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'accesslint-ci'
-```
+accesslint-ci will crawl a host site and run accessibility assertions on the
+pages. If there are any new accessibility issues, accesslint-ci will comment on
+the pull request that initiated the build in CircleCI.
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+## Installation
 
-    $ gem install accesslint-ci
+1. Set up your CircleCI environment (API tokens for CircleCI and GitHub, artifacts)
+1. Install dependencies (nodejs, `accesslint-cli`, `accesslint-ci`)
+1. Start a development server
+1. Run `accesslint-ci scan <development server e.g. http://localhost:3000>`
 
-## Usage
+In your `circle.yml` file:
 
+```
 general:
   artifacts:
     - "accesslint.log"
 
 machine:
+  environment:
+    CIRCLE_TOKEN: <CircleCI API token>
+    ACCESSLINT_GITHUB_TOKEN: <GitHub Personal Access Token>
   node:
     version: 6.1.0
 
 dependencies:
   override:
     - npm install -g accesslint-cli
+    - gem install accesslint-ci
 
 test:
   post:
-    - bundle exec puma -d -C./config/puma.rb
+    - bundle exec rails server
     - accesslint-ci scan http://localhost:3000
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/accesslint-ci.rb/accesslint-ci. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
+```
 
 ## License
 

data/accesslint-ci.gemspec

@@ -7,16 +7,16 @@ Gem::Specification.new do |spec|
   spec.name          = "accesslint-ci"
   spec.version       = Accesslint::Ci::VERSION
   spec.authors       = ["Cameron Cundiff"]
-  spec.email         = ["cameron@thoughtbot.com"]
+  spec.email         = ["hello@thoughtbot.com"]
 
-  spec.summary       = %q{Run accesslint accessibility scanner in CI}
-  spec.description   = %q{Run accesslint-cli accessibility assertions against a host url}
+  spec.summary       = %q{Run accessibility tests in CircleCI builds}
+  spec.description   = %q{accesslint-ci runs accessibility tests in CircleCI and comments on corresponding GitHub pull requests}
   spec.homepage      = "https://www.github.com/accesslint/accesslint-ci.rb"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.executables   = %w[accesslint-ci]
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.12"

data/bin/accesslint-ci

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "accesslint/ci"
+
+Accesslint::Ci::Cli.start

data/lib/accesslint/ci/version.rb

@@ -1,5 +1,5 @@
 module Accesslint
   module Ci
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: accesslint-ci
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Cameron Cundiff
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2016-07-31 00:00:00.000000000 Z
 dependencies:
@@ -108,10 +108,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Run accesslint-cli accessibility assertions against a host url
+description: accesslint-ci runs accessibility tests in CircleCI and comments on corresponding
+  GitHub pull requests
 email:
-- cameron@thoughtbot.com
-executables: []
+- hello@thoughtbot.com
+executables:
+- accesslint-ci
 extensions: []
 extra_rdoc_files: []
 files:
@@ -127,6 +129,7 @@ files:
 - README.md
 - Rakefile
 - accesslint-ci.gemspec
+- bin/accesslint-ci
 - bin/console
 - bin/setup
 - circle.yml
@@ -159,5 +162,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Run accesslint accessibility scanner in CI
+summary: Run accessibility tests in CircleCI builds
 test_files: []