accesslint-ci 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: fa3733f759107ca29fd992d26ecd88efcc9684d8
4
- data.tar.gz: 63f81acd0c0e944ce91de37eab291db58e4acd9e
3
+ metadata.gz: 10d05a2f67359d4a5abe5cd8dcf5d53d215852a0
4
+ data.tar.gz: 8026ee0c69ab49663632d73a177146aaa764a316
5
5
  SHA512:
6
- metadata.gz: 2320999589fa6632918af2da7e898195120470dffca0f41f5c45ad6b1b3af2069e2744c93a682de7386c734411212e02d53ba5da0233a6191a736073030204e9
7
- data.tar.gz: 4d79183eec4607ea405c7fc063bb14f2c4ad9b5f13e49ee0cea8dfb5798b7221fd521408cffc655ee54cdfb5d7be0405f93c9710e5967a006d83dd21ca971e1f
6
+ metadata.gz: 9e3d2092ae53059c93195afcf71cb855fdd28845fd8ccc854a8209eb47e6c71c350334b6e4bcf9260508dbbb5ee942d8c277105679d6f38834470cd48da4ca6e
7
+ data.tar.gz: 1f2de2bedd962932463aa08cbb85e449ed72ee4ecac51b53ddb77e7874b4bccaafe9a4c05c196fd86aa301d081663500d9c691a0c67550a4395cc421e2ab49f8
data/README.md CHANGED
@@ -1,52 +1,43 @@
1
1
  # Accesslint::Ci
2
2
 
3
- Run accesslint-cli in CircleCI
3
+ Runs accesslint-cli in CircleCI and comments on GitHub pull requests with new
4
+ accessibility issues.
4
5
 
5
- ## Installation
6
-
7
- Add this line to your application's Gemfile:
8
-
9
- ```ruby
10
- gem 'accesslint-ci'
11
- ```
6
+ accesslint-ci will crawl a host site and run accessibility assertions on the
7
+ pages. If there are any new accessibility issues, accesslint-ci will comment on
8
+ the pull request that initiated the build in CircleCI.
12
9
 
13
- And then execute:
14
-
15
- $ bundle
16
-
17
- Or install it yourself as:
10
+ ## Installation
18
11
 
19
- $ gem install accesslint-ci
12
+ 1. Set up your CircleCI environment (API tokens for CircleCI and GitHub, artifacts)
13
+ 1. Install dependencies (nodejs, `accesslint-cli`, `accesslint-ci`)
14
+ 1. Start a development server
15
+ 1. Run `accesslint-ci scan <development server e.g. http://localhost:3000>`
20
16
 
21
- ## Usage
17
+ In your `circle.yml` file:
22
18
 
19
+ ```
23
20
  general:
24
21
  artifacts:
25
22
  - "accesslint.log"
26
23
 
27
24
  machine:
25
+ environment:
26
+ CIRCLE_TOKEN: <CircleCI API token>
27
+ ACCESSLINT_GITHUB_TOKEN: <GitHub Personal Access Token>
28
28
  node:
29
29
  version: 6.1.0
30
30
 
31
31
  dependencies:
32
32
  override:
33
33
  - npm install -g accesslint-cli
34
+ - gem install accesslint-ci
34
35
 
35
36
  test:
36
37
  post:
37
- - bundle exec puma -d -C./config/puma.rb
38
+ - bundle exec rails server
38
39
  - accesslint-ci scan http://localhost:3000
39
-
40
- ## Development
41
-
42
- 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.
43
-
44
- 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).
45
-
46
- ## Contributing
47
-
48
- 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.
49
-
40
+ ```
50
41
 
51
42
  ## License
52
43
 
@@ -7,16 +7,16 @@ Gem::Specification.new do |spec|
7
7
  spec.name = "accesslint-ci"
8
8
  spec.version = Accesslint::Ci::VERSION
9
9
  spec.authors = ["Cameron Cundiff"]
10
- spec.email = ["cameron@thoughtbot.com"]
10
+ spec.email = ["hello@thoughtbot.com"]
11
11
 
12
- spec.summary = %q{Run accesslint accessibility scanner in CI}
13
- spec.description = %q{Run accesslint-cli accessibility assertions against a host url}
12
+ spec.summary = %q{Run accessibility tests in CircleCI builds}
13
+ spec.description = %q{accesslint-ci runs accessibility tests in CircleCI and comments on corresponding GitHub pull requests}
14
14
  spec.homepage = "https://www.github.com/accesslint/accesslint-ci.rb"
15
15
  spec.license = "MIT"
16
16
 
17
17
  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
- spec.bindir = "exe"
19
- spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
18
+ spec.bindir = "bin"
19
+ spec.executables = %w[accesslint-ci]
20
20
  spec.require_paths = ["lib"]
21
21
 
22
22
  spec.add_development_dependency "bundler", "~> 1.12"
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env ruby
2
+ require "accesslint/ci"
3
+
4
+ Accesslint::Ci::Cli.start
@@ -1,5 +1,5 @@
1
1
  module Accesslint
2
2
  module Ci
3
- VERSION = "0.1.0"
3
+ VERSION = "0.1.1"
4
4
  end
5
5
  end
metadata CHANGED
@@ -1,12 +1,12 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: accesslint-ci
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Cameron Cundiff
8
8
  autorequire:
9
- bindir: exe
9
+ bindir: bin
10
10
  cert_chain: []
11
11
  date: 2016-07-31 00:00:00.000000000 Z
12
12
  dependencies:
@@ -108,10 +108,12 @@ dependencies:
108
108
  - - ">="
109
109
  - !ruby/object:Gem::Version
110
110
  version: '0'
111
- description: Run accesslint-cli accessibility assertions against a host url
111
+ description: accesslint-ci runs accessibility tests in CircleCI and comments on corresponding
112
+ GitHub pull requests
112
113
  email:
113
- - cameron@thoughtbot.com
114
- executables: []
114
+ - hello@thoughtbot.com
115
+ executables:
116
+ - accesslint-ci
115
117
  extensions: []
116
118
  extra_rdoc_files: []
117
119
  files:
@@ -127,6 +129,7 @@ files:
127
129
  - README.md
128
130
  - Rakefile
129
131
  - accesslint-ci.gemspec
132
+ - bin/accesslint-ci
130
133
  - bin/console
131
134
  - bin/setup
132
135
  - circle.yml
@@ -159,5 +162,5 @@ rubyforge_project:
159
162
  rubygems_version: 2.5.1
160
163
  signing_key:
161
164
  specification_version: 4
162
- summary: Run accesslint accessibility scanner in CI
165
+ summary: Run accessibility tests in CircleCI builds
163
166
  test_files: []