awesome_bot 1.19.1 → 1.20.0

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.
Files changed (12) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +5 -0
  3. data/Gemfile +1 -1
  4. data/README.md +40 -8
  5. data/awesome_bot.gemspec +1 -1
  6. data/bin/assets/test-errors +1 -3
  7. data/bin/assets/test-timeout +1 -1
  8. data/lib/awesome_bot/cli.rb +1 -1
  9. data/lib/awesome_bot/version.rb +1 -1
  10. data/status/list-travis-ci +4 -0
  11. data/status/status.md +7 -3
  12. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA256:
3
- metadata.gz: f4853766800037717bd572948579007955772f431af5ced43bccf24b8ce70d2f
4
- data.tar.gz: f798d126cbe029c9218030b0056a68ee115ecb6c3a3803ae919fe9ccc654498f
2
+ SHA1:
3
+ metadata.gz: a3d4e16495337ecdb24033c9d20ebcf92d6079c6
4
+ data.tar.gz: dd8ccc69f014fc37dcffb1df137c218aa94f3698
5
5
  SHA512:
6
- metadata.gz: 65a1fe285c944fa67d8737efb2b328267c6d7d60dbc46dbbb02191369cb7fed0cee0fb416d9476707d7d035dbdee49a0ceddeab51b4ba1ab7499740ba2d7a3a3
7
- data.tar.gz: 3f41cbf4d255c8d3e5d30882ab95301fb14f58d30a24105f4ed4ca4f324d075e40bc73ba222ec3d647584d439f0b62df0a7d8a13c1bcbd6e26914d2a56d1d664
6
+ metadata.gz: 1c2e95b89a2a3ab9df7dba8a8796e4f908ecbc308be6fceda5876cf10ca1d50e10c096b168f89d41cbbc2934c8c64a652bf1bf351b03307605e2351213bf436f
7
+ data.tar.gz: ae5d7bf39bb7967bbc759bd99a074f28e142bf09a18effd423540b125adca60f0fce64c6f3ac65375c7ab487a3e4cfdb088b0e30ceaa9929b01ccd324ace9985
data/CHANGELOG.md CHANGED
@@ -2,6 +2,11 @@
2
2
 
3
3
  Changes by [Daniel Khamsing][] unless otherwise noted.
4
4
 
5
+ # 1.20.0
6
+
7
+ - [cli] delay: change to use float by [Jonathan Lai](https://github.com/agsdot)
8
+ - [gem] update `parallel`, `rspec` to latest
9
+
5
10
  # 1.19.1
6
11
 
7
12
  - [gem] update `parallel`, `rspec`, `rspec_junit_formatter` to latest
data/Gemfile CHANGED
@@ -2,4 +2,4 @@ source 'https://rubygems.org'
2
2
 
3
3
  gemspec
4
4
  gem 'rspec_junit_formatter', '0.4.1' # test meta data / ci
5
- gem 'rspec', '3.8.0' # tests'
5
+ gem 'rspec', '3.10.0' # tests'
data/README.md CHANGED
@@ -75,7 +75,7 @@ $ awesome_bot README.md,README-zh.md
75
75
  # check links in 2 files
76
76
 
77
77
  $ awesome_bot docs/*.md
78
- # check all markdown files in docs/ directory
78
+ # check all Markdown files in the docs/ directory
79
79
 
80
80
  $ awesome_bot README.md --allow-timeout -t 5
81
81
  # speed up validation by setting a timeout of 5 seconds per link request and allowing timeouts
@@ -85,7 +85,7 @@ $ awesome_bot README.md --allow 403,429
85
85
  # --allow 301 would be similar to --allow-redirect
86
86
 
87
87
  $ awesome_bot README.md --base-url https://github.com/IDR/idr-notebooks/blob/master/
88
- # will check relative links using the base url provided
88
+ # check relative links using the base URL provided
89
89
  ```
90
90
 
91
91
  ```shell
@@ -110,20 +110,20 @@ Wrote results to ab-results-new-readme.md.json
110
110
  ```
111
111
 
112
112
  ### Docker Examples
113
- If you do not want to install Ruby or it's dependencies you can simply use Docker and Docker image.
113
+ If you do not want to install Ruby or its dependencies you can simply use Docker and Docker image.
114
114
 
115
- Here is the example how you can check the links in your current directory+subdirectories markdown files:
115
+ Here is an example for checking the links in the Markdown files in your current directory/subdirectories:
116
116
  ```shell
117
117
  docker run -ti --rm -v $PWD:/mnt:ro dkhamsing/awesome_bot --white-list "test.com" --allow-dupe --allow-redirect --skip-save-results `find . -name "*.md"`
118
118
  ```
119
119
 
120
- or check links in just in a single file located in `./templates/ubuntu.md`:
120
+ or just check the links in a single file located at `./templates/ubuntu.md`:
121
121
 
122
122
  ```shell
123
123
  docker run -ti --rm -v $PWD:/mnt:ro dkhamsing/awesome_bot --allow-dupe --allow-redirect --skip-save-results ./templates/ubuntu.md
124
124
  ```
125
125
 
126
- You always need to specify the path to the file so you can not use simply `*.md` but `ls *.md"`:
126
+ You always need to specify the path to the file so you cannot simply use `*.md`; instead use `ls *.md"`:
127
127
  ```shell
128
128
  docker run -ti --rm -v $PWD:/mnt:ro dkhamsing/awesome_bot --white-list "test.com" --allow-dupe --allow-redirect --skip-save-results `ls *.md`
129
129
  ```
@@ -159,9 +159,41 @@ and [more](status/status.md).
159
159
 
160
160
  Tips
161
161
 
162
- - Use the keyword `[ci skip]` in your commit title/message to skip verification.
162
+ - Use the keyword [`[ci skip]`](https://docs.travis-ci.com/user/customizing-the-build/) in your commit title/message to skip verification.
163
163
  - Use [Danger](#danger).
164
164
 
165
+ ### GitHub Actions
166
+
167
+ To use `awesome_bot` with GitHub Actions (workflows), here is an [example](https://github.com/dkhamsing/open-source-ios-apps/blob/master/.github/workflows/ruby.yml):
168
+
169
+ ```yml
170
+ name: Ruby
171
+
172
+ on:
173
+ push:
174
+ branches: [ '*' ]
175
+ pull_request:
176
+ branches: [ '*' ]
177
+
178
+ jobs:
179
+ build:
180
+
181
+ runs-on: ubuntu-latest
182
+
183
+ steps:
184
+ - uses: actions/checkout@v2
185
+ - name: Set up Ruby 2.6
186
+ uses: actions/setup-ruby@v1
187
+ with:
188
+ ruby-version: 2.6.x
189
+ - name: Checks
190
+ run: |
191
+ ruby .github/osia_convert.rb
192
+ gem install awesome_bot
193
+ ruby .github/osia_get_links.rb
194
+ awesome_bot check-unique.txt --allow-ssl -a 302,429 -w xbmc/xbmc
195
+ ```
196
+
165
197
  ### Travis CI
166
198
 
167
199
  To use `awesome_bot` with Travis CI, [connect your repo](https://travis-ci.org/) and create a [`.travis.yml` file](https://github.com/ziadoz/awesome-php/blob/master/.travis.yml).
@@ -230,7 +262,7 @@ i.e.
230
262
  [![Build Status](https://travis-ci.org/dkhamsing/awesome_bot.svg?branch=master)](https://travis-ci.org/dkhamsing/awesome_bot)
231
263
  ```
232
264
 
233
- As it happens, the default code snippet provided contain a redirect so adding a badge could fail your status :sob:.. one way to fix this is to white list `travis-ci`, i.e.
265
+ As it happens, the default code snippet provided contains a redirect so adding a badge could fail your status :sob:.. one way to fix this is to white list `travis-ci`, i.e.
234
266
 
235
267
  ```
236
268
  - awesome_bot README.md --white-list travis-ci
data/awesome_bot.gemspec CHANGED
@@ -21,5 +21,5 @@ Gem::Specification.new do |spec|
21
21
 
22
22
  spec.required_ruby_version = '>= 2.0.0'
23
23
 
24
- spec.add_runtime_dependency 'parallel', '1.17.0' # threading
24
+ spec.add_runtime_dependency 'parallel', '1.20.1' # threading
25
25
  end
data/bin/assets/test-errors CHANGED
@@ -1,6 +1,4 @@
1
-
2
- 3. [L056] 405 https://www.google.com/events/io
3
- 5. [L130] 500 http://decentralizecamp.com/
1
+ 500 http://decentralizecamp.com/
4
2
  02. [L0138] 401 https://developer.apple.com/library/ios/referencelibrary/GettingStarted/DevelopiOSAppsSwift/
5
3
  03. [L0145] 401 https://developer.apple.com/library/ios/documentation/Cocoa/Conceptual/ProgrammingWithObjectiveC/Introduction/Introduction.html
6
4
  04. [L0146] 401 https://developer.apple.com/library/ios/documentation/Cocoa/Conceptual/OOP_ObjC/Introduction/Introduction.html
data/bin/assets/test-timeout CHANGED
@@ -1,2 +1,2 @@
1
- http://1.2.3.4
1
+ https://httpbin.org/delay/10
2
2
  https://github.com
data/lib/awesome_bot/cli.rb CHANGED
@@ -24,7 +24,7 @@ module AwesomeBot
24
24
  opts.on('--allow-redirect', TrueClass, 'Redirected URLs are allowed') { |val| options['allow_redirect'] = val }
25
25
  opts.on('--allow-timeout', TrueClass, 'URLs that time out are allowed') { |val| options['allow_timeout'] = val }
26
26
  opts.on('--base-url [base url]', String, 'Base URL to use for relative links') { |val| options['base_url'] = val }
27
- opts.on('-d', '--request-delay [seconds]', Integer, 'Set request delay') { |val| options['delay'] = val }
27
+ opts.on('-d', '--request-delay [seconds]', Float, 'Set request delay') { |val| options['delay'] = val }
28
28
  opts.on('-t', '--set-timeout [seconds]', Integer, 'Set connection timeout (default: 30)') { |val| options['timeout'] = val }
29
29
  opts.on('--skip-save-results', TrueClass, 'Skip saving results') { |val| options['no_results'] = val }
30
30
  opts.on('-w', '--white-list [urls]', Array, 'Comma separated URLs to white list') { |val| options['white_list'] = val }
data/lib/awesome_bot/version.rb CHANGED
@@ -5,5 +5,5 @@ module AwesomeBot
5
5
  'Great for "awesome" projects.'
6
6
  PROJECT_URL = 'https://github.com/dkhamsing/awesome_bot'
7
7
 
8
- VERSION = '1.19.1'
8
+ VERSION = '1.20.0'
9
9
  end
data/status/list-travis-ci CHANGED
@@ -7,6 +7,8 @@ herrbischoff/awesome-macos-command-line
7
7
  ziadoz/awesome-php
8
8
  matteocrippa/awesome-swift
9
9
  wsargent/docker-cheat-sheet
10
+ jaywcjlove/awesome-mac
11
+ Kickball/awesome-selfhosted
10
12
  alebcay/awesome-shell
11
13
  cjwirth/awesome-ios-ui
12
14
  n0shake/Public-APIs
@@ -131,3 +133,5 @@ BubuAnabelas/awesome-markdown
131
133
  serhii-londar/open-source-mac-os-apps
132
134
  frenck/awesome-home-assistant
133
135
  duyetdev/awesome-web-scraper
136
+ tapaswenipathak/Women-GitHubers
137
+ emacs-tw/awesome-emacs
data/status/status.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Awesome Status
2
2
 
3
- Build status for **132** projects using https://github.com/dkhamsing/awesome_bot
3
+ Build status for **138** projects using https://github.com/dkhamsing/awesome_bot
4
4
 
5
5
  Status | Config | Repo
6
6
  --- | --- | ---
@@ -13,6 +13,8 @@ Status | Config | Repo
13
13
  [![Build Status](https://travis-ci.org/ziadoz/awesome-php.svg)](https://travis-ci.org/ziadoz/awesome-php) | [`config`](https://github.com/ziadoz/awesome-php/blob/master/.travis.yml) | [ziadoz/awesome-php](https://github.com/ziadoz/awesome-php)
14
14
  [![Build Status](https://travis-ci.org/matteocrippa/awesome-swift.svg)](https://travis-ci.org/matteocrippa/awesome-swift) | [`config`](https://github.com/matteocrippa/awesome-swift/blob/master/.travis.yml) | [matteocrippa/awesome-swift](https://github.com/matteocrippa/awesome-swift)
15
15
  [![Build Status](https://travis-ci.org/wsargent/docker-cheat-sheet.svg)](https://travis-ci.org/wsargent/docker-cheat-sheet) | [`config`](https://github.com/wsargent/docker-cheat-sheet/blob/master/.travis.yml) | [wsargent/docker-cheat-sheet](https://github.com/wsargent/docker-cheat-sheet)
16
+ [![Build Status](https://travis-ci.org/jaywcjlove/awesome-mac.svg)](https://travis-ci.org/jaywcjlove/awesome-mac) | [`config`](https://github.com/jaywcjlove/awesome-mac/blob/master/.travis.yml) | [jaywcjlove/awesome-mac](https://github.com/jaywcjlove/awesome-mac)
17
+ [![Build Status](https://travis-ci.org/Kickball/awesome-selfhosted.svg)](https://travis-ci.org/Kickball/awesome-selfhosted) | [`config`](https://github.com/Kickball/awesome-selfhosted/blob/master/.travis.yml) | [Kickball/awesome-selfhosted](https://github.com/Kickball/awesome-selfhosted)
16
18
  [![Build Status](https://travis-ci.org/alebcay/awesome-shell.svg)](https://travis-ci.org/alebcay/awesome-shell) | [`config`](https://github.com/alebcay/awesome-shell/blob/master/.travis.yml) | [alebcay/awesome-shell](https://github.com/alebcay/awesome-shell)
17
19
  [![Build Status](https://travis-ci.org/cjwirth/awesome-ios-ui.svg)](https://travis-ci.org/cjwirth/awesome-ios-ui) | [`config`](https://github.com/cjwirth/awesome-ios-ui/blob/master/.travis.yml) | [cjwirth/awesome-ios-ui](https://github.com/cjwirth/awesome-ios-ui)
18
20
  [![Build Status](https://travis-ci.org/n0shake/Public-APIs.svg)](https://travis-ci.org/n0shake/Public-APIs) | [`config`](https://github.com/n0shake/Public-APIs/blob/master/.travis.yml) | [n0shake/Public-APIs](https://github.com/n0shake/Public-APIs)
@@ -135,6 +137,8 @@ Status | Config | Repo
135
137
  [![Build Status](https://travis-ci.org/IQDevs/Awesome-IQDevs.svg)](https://travis-ci.org/IQDevs/Awesome-IQDevs) | [`config`](https://github.com/IQDevs/Awesome-IQDevs/blob/master/.travis.yml) | [IQDevs/Awesome-IQDevs](https://github.com/IQDevs/Awesome-IQDevs)
136
138
  [![Build Status](https://travis-ci.org/BubuAnabelas/awesome-markdown.svg)](https://travis-ci.org/BubuAnabelas/awesome-markdown) | [`config`](https://github.com/BubuAnabelas/awesome-markdown/blob/master/.travis.yml) | [BubuAnabelas/awesome-markdown](https://github.com/BubuAnabelas/awesome-markdown)
137
139
  [![Build Status](https://travis-ci.org/serhii-londar/open-source-mac-os-apps.svg)](https://travis-ci.org/serhii-londar/open-source-mac-os-apps) | [`config`](https://github.com/serhii-londar/open-source-mac-os-apps/blob/master/.travis.yml) | [serhii-londar/open-source-mac-os-apps](https://github.com/serhii-londar/open-source-mac-os-apps)
140
+ [![Build Status](https://travis-ci.org/frenck/awesome-home-assistant.svg)](https://travis-ci.org/frenck/awesome-home-assistant) | [`config`](https://github.com/frenck/awesome-home-assistant/blob/master/.travis.yml) | [frenck/awesome-home-assistant](https://github.com/frenck/awesome-home-assistant)
141
+ [![Build Status](https://travis-ci.org/duyetdev/awesome-web-scraper.svg)](https://travis-ci.org/duyetdev/awesome-web-scraper) | [`config`](https://github.com/duyetdev/awesome-web-scraper/blob/master/.travis.yml) | [duyetdev/awesome-web-scraper](https://github.com/duyetdev/awesome-web-scraper)
142
+ [![Build Status](https://travis-ci.org/tapaswenipathak/Women-GitHubers.svg)](https://travis-ci.org/tapaswenipathak/Women-GitHubers) | [`config`](https://github.com/tapaswenipathak/Women-GitHubers/blob/master/.travis.yml) | [tapaswenipathak/Women-GitHubers](https://github.com/tapaswenipathak/Women-GitHubers)
143
+ [![Build Status](https://travis-ci.org/emacs-tw/awesome-emacs.svg)](https://travis-ci.org/emacs-tw/awesome-emacs) | [`config`](https://github.com/emacs-tw/awesome-emacs/blob/master/.travis.yml) | [emacs-tw/awesome-emacs](https://github.com/emacs-tw/awesome-emacs)
138
144
  [![Circle CI](https://img.shields.io/circleci/project/tmcw/awesome-geojson.svg)](https://circleci.com/gh/tmcw/awesome-geojson) | [`config`](https://github.com/tmcw/awesome-geojson/blob/master/circle.yml) | [tmcw/awesome-geojson](https://github.com/tmcw/awesome-geojson)
139
- [![Build Status](https://travis-ci.org/frenck/awesome-home-assistant.svg)](https://travis-ci.org/frenck/awesome-home-assistant) | [`config`](https://github.com/frenck/awesome-home-assistant/blob/master/.travis.yml) | [frenck/awesome-home-assistant](https://github.com/frenck/awesome-home-assistant)
140
- [![Build Status](https://travis-ci.org/duyetdev/awesome-web-scraper.svg)](https://travis-ci.org/duyetdev/awesome-web-scraper) | [`config`](https://github.com/duyetdev/awesome-web-scraper/blob/master/.travis.yml) | [duyetdev/awesome-web-scraper](https://github.com/duyetdev/awesome-web-scraper)
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: awesome_bot
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.19.1
4
+ version: 1.20.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Daniel Khamsing
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-08-16 00:00:00.000000000 Z
11
+ date: 2021-03-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: parallel
@@ -16,14 +16,14 @@ dependencies:
16
16
  requirements:
17
17
  - - '='
18
18
  - !ruby/object:Gem::Version
19
- version: 1.17.0
19
+ version: 1.20.1
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - '='
25
25
  - !ruby/object:Gem::Version
26
- version: 1.17.0
26
+ version: 1.20.1
27
27
  description: Check for valid and duplicate URLs in a file. Great for "awesome" projects.
28
28
  email:
29
29
  - dkhamsing8@gmail.com
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
94
94
  version: '0'
95
95
  requirements: []
96
96
  rubyforge_project:
97
- rubygems_version: 2.7.4
97
+ rubygems_version: 2.6.8
98
98
  signing_key:
99
99
  specification_version: 4
100
100
  summary: Check for valid and duplicate URLs in a file. Great for "awesome" projects.