Skip to content

Commit 7084d9f

Browse files
committed
Improve get_latest_github_release
1 parent 4ce7dbc commit 7084d9f

25 files changed

+27
-25
lines changed

docs/scraper-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ To make life easier, there are a few utility methods that you can use in `get_la
212212
Example: [lib/docs/scrapers/bower.rb](../lib/docs/scrapers/bower.rb)
213213
* `get_latest_github_release(owner, repo, opts)`
214214

215-
Returns the latest GitHub release of the given repository ([format](https://developer.github.com/v3/repos/releases/#get-the-latest-release)).
215+
Returns the tag name of the latest GitHub release of the given repository. If the tag name is preceeded by a "v", the "v" will be removed.
216216

217217
Example: [lib/docs/scrapers/jsdoc.rb](../lib/docs/scrapers/jsdoc.rb)
218218
* `get_github_tags(owner, repo, opts)`

lib/docs/core/doc.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,9 @@ def get_npm_version(package, opts)
249249
end
250250

251251
def get_latest_github_release(owner, repo, opts)
252-
fetch_json("https://api.github.com/repos/#{owner}/#{repo}/releases/latest", opts)
252+
release = fetch_json("https://api.github.com/repos/#{owner}/#{repo}/releases/latest", opts)
253+
tag_name = release['tag_name']
254+
tag_name.start_with?('v') ? tag_name[1..-1] : tag_name
253255
end
254256

255257
def get_github_tags(owner, repo, opts)

lib/docs/scrapers/homebrew.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class Homebrew < UrlScraper
2121
HTML
2222

2323
def get_latest_version(opts)
24-
get_latest_github_release('Homebrew', 'brew', opts)['name']
24+
get_latest_github_release('Homebrew', 'brew', opts)
2525
end
2626
end
2727
end

lib/docs/scrapers/jasmine.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class Jasmine < UrlScraper
1919
HTML
2020

2121
def get_latest_version(opts)
22-
get_latest_github_release('jasmine', 'jasmine', opts)['name']
22+
get_latest_github_release('jasmine', 'jasmine', opts)
2323
end
2424
end
2525
end

lib/docs/scrapers/jsdoc.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class Jsdoc < UrlScraper
2323
HTML
2424

2525
def get_latest_version(opts)
26-
get_latest_github_release('jsdoc3', 'jsdoc', opts)['tag_name']
26+
get_latest_github_release('jsdoc3', 'jsdoc', opts)
2727
end
2828
end
2929
end

lib/docs/scrapers/julia.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ class Julia < UrlScraper
5151
end
5252

5353
def get_latest_version(opts)
54-
get_latest_github_release('JuliaLang', 'julia', opts)['tag_name'][1..-1]
54+
get_latest_github_release('JuliaLang', 'julia', opts)
5555
end
5656
end
5757
end

lib/docs/scrapers/knockout.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ class Knockout < UrlScraper
3535
HTML
3636

3737
def get_latest_version(opts)
38-
get_latest_github_release('knockout', 'knockout', opts)['tag_name'][1..-1]
38+
get_latest_github_release('knockout', 'knockout', opts)
3939
end
4040
end
4141
end

lib/docs/scrapers/kotlin.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class Kotlin < UrlScraper
3030
HTML
3131

3232
def get_latest_version(opts)
33-
get_latest_github_release('JetBrains', 'kotlin', opts)['tag_name'][1..-1]
33+
get_latest_github_release('JetBrains', 'kotlin', opts)
3434
end
3535
end
3636
end

lib/docs/scrapers/laravel.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ class Laravel < UrlScraper
135135
end
136136

137137
def get_latest_version(opts)
138-
get_latest_github_release('laravel', 'laravel', opts)['tag_name'][1..-1]
138+
get_latest_github_release('laravel', 'laravel', opts)
139139
end
140140
end
141141
end

lib/docs/scrapers/matplotlib.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ class Matplotlib < UrlScraper
6666
end
6767

6868
def get_latest_version(opts)
69-
get_latest_github_release('matplotlib', 'matplotlib', opts)['tag_name'][1..-1]
69+
get_latest_github_release('matplotlib', 'matplotlib', opts)
7070
end
7171
end
7272
end

0 commit comments

Comments
 (0)