Class: Fastlane::Actions::GetGithubReleaseAction

Inherits:
Fastlane::Action show all
Defined in:
lib/fastlane/actions/get_github_release.rb

Documentation collapse

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, sh, step_text

Class Method Details

.authors ⇒ Object 



103
104
105
 
# File 'lib/fastlane/actions/get_github_release.rb', line 103

def self.authors
  ["KrauseFx"]
end

.available_options ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/fastlane/actions/get_github_release.rb', line 88

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :url,
                                 env_name: "FL_GET_GITHUB_RELEASE_URL",
                                 description: "The path to your repo, e.g. 'KrauseFx/fastlane'",
                                 verify_block: Proc.new do |value|
                                    raise "Please only pass the path, e.g. 'KrauseFx/fastlane'".red if value.include?"github.com"
                                    raise "Please only pass the path, e.g. 'KrauseFx/fastlane'".red if value.split('/').count != 2
                                 end),
    FastlaneCore::ConfigItem.new(key: :version,
                                 env_name: "FL_GET_GITHUB_RELEASE_VERSION",
                                 description: "The version tag of the release to check")
  ]
end

.description ⇒ Object 



33
34
35
 
# File 'lib/fastlane/actions/get_github_release.rb', line 33

def self.description
  "This will verify if a given release version is avialable on GitHub"
end

.details ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/fastlane/actions/get_github_release.rb', line 37

def self.details
  sample = '
        {"url"=>"https://api.github.com/repos/KrauseFx/fastlane/releases/1537713",
           "assets_url"=>"https://api.github.com/repos/KrauseFx/fastlane/releases/1537713/assets",
           "upload_url"=>"https://uploads.github.com/repos/KrauseFx/fastlane/releases/1537713/assets{?name}",
           "html_url"=>"https://github.com/KrauseFx/fastlane/releases/tag/1.8.0",
           "id"=>1537713,
           "tag_name"=>"1.8.0",
           "target_commitish"=>"master",
           "name"=>"1.8.0 Switch Lanes & Pass Parameters",
           "draft"=>false,
           "author"=>
            {"login"=>"KrauseFx",
             "id"=>869950,
             "avatar_url"=>"https://avatars.githubusercontent.com/u/869950?v=3",
             "gravatar_id"=>"",
             "url"=>"https://api.github.com/users/KrauseFx",
             "html_url"=>"https://github.com/KrauseFx",
             "followers_url"=>"https://api.github.com/users/KrauseFx/followers",
             "following_url"=>"https://api.github.com/users/KrauseFx/following{/other_user}",
             "gists_url"=>"https://api.github.com/users/KrauseFx/gists{/gist_id}",
             "starred_url"=>"https://api.github.com/users/KrauseFx/starred{/owner}{/repo}",
             "subscriptions_url"=>"https://api.github.com/users/KrauseFx/subscriptions",
             "organizations_url"=>"https://api.github.com/users/KrauseFx/orgs",
             "repos_url"=>"https://api.github.com/users/KrauseFx/repos",
             "events_url"=>"https://api.github.com/users/KrauseFx/events{/privacy}",
             "received_events_url"=>"https://api.github.com/users/KrauseFx/received_events",
             "type"=>"User",
             "site_admin"=>false},
           "prerelease"=>false,
           "created_at"=>"2015-07-14T23:33:01Z",
           "published_at"=>"2015-07-14T23:44:10Z",
           "assets"=>[],
           "tarball_url"=>"https://api.github.com/repos/KrauseFx/fastlane/tarball/1.8.0",
           "zipball_url"=>"https://api.github.com/repos/KrauseFx/fastlane/zipball/1.8.0",
           "body"=>
          "This is one of the biggest updates of `fastlane` yet"
        }'

  [
    "This will return all information about a release. For example:",
    sample
  ].join("\n")
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


107
108
109
 
# File 'lib/fastlane/actions/get_github_release.rb', line 107

def self.is_supported?(platform)
  true
end

.output ⇒ Object 



82
83
84
85
86
 
# File 'lib/fastlane/actions/get_github_release.rb', line 82

def self.output
  [
    ['GET_GITHUB_RELEASE_INFO', 'Contains all the information about this release']
  ]
end

.run(params) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/fastlane/actions/get_github_release.rb', line 8

def self.run(params)
  Helper.log.info "Verifying release on GitHub (#{params[:url]}: #{params[:version]})"
  require 'excon'
  result = JSON.parse(Excon.get("https://api.github.com/repos/#{params[:url]}/releases").body)
  result.each do |current|
    if current['tag_name'] == params[:version]
      # Found it
      if current['body'].to_s.length > 0
        Actions.lane_context[SharedValues::GET_GITHUB_RELEASE_INFO] = current
        Helper.log.info "Version is already live on GitHub.com 🚁"
        return current
      else
        raise "No release notes found for #{params[:version]}"
      end
    end 
  end

  Helper.log.error "Couldn't find GitHub release #{params[:version]}".yellow
  return nil
end