Class: Fastlane::Actions::CommitGithubFileAction
- Inherits:
-
Fastlane::Action
- Object
- Fastlane::Action
- Fastlane::Actions::CommitGithubFileAction
- Defined in:
- fastlane/lib/fastlane/actions/commit_github_file.rb
Constant Summary
Constants inherited from Fastlane::Action
Fastlane::Action::AVAILABLE_CATEGORIES, Fastlane::Action::RETURN_TYPES
Documentation collapse
- .authors ⇒ Object
- .available_options ⇒ Object
- .category ⇒ Object
- .description ⇒ Object
- .details ⇒ Object
- .example_code ⇒ Object
- .is_supported?(platform) ⇒ Boolean
- .output ⇒ Object
- .return_type ⇒ Object
- .return_value ⇒ Object
Class Method Summary collapse
Methods inherited from Fastlane::Action
action_name, author, deprecated_notes, lane_context, method_missing, other_action, sample_return_value, shell_out_should_use_bundle_exec?, step_text
Class Method Details
.authors ⇒ Object
160 161 162 |
# File 'fastlane/lib/fastlane/actions/commit_github_file.rb', line 160 def self. ["tommeier"] end |
.available_options ⇒ Object
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
# File 'fastlane/lib/fastlane/actions/commit_github_file.rb', line 87 def self. [ FastlaneCore::ConfigItem.new(key: :repository_name, env_name: "FL_COMMIT_GITHUB_FILE_REPOSITORY_NAME", description: "The path to your repo, e.g. 'fastlane/fastlane'", verify_block: proc do |value| UI.user_error!("Please only pass the path, e.g. 'fastlane/fastlane'") if value.include?("github.com") UI.user_error!("Please only pass the path, e.g. 'fastlane/fastlane'") if value.split('/').count != 2 end), FastlaneCore::ConfigItem.new(key: :server_url, env_name: "FL_COMMIT_GITHUB_FILE_SERVER_URL", description: "The server url. e.g. 'https://your.internal.github.host/api/v3' (Default: 'https://api.github.com')", default_value: "https://api.github.com", optional: true, verify_block: proc do |value| UI.user_error!("Please include the protocol in the server url, e.g. https://your.github.server/api/v3") unless value.include?("//") end), FastlaneCore::ConfigItem.new(key: :api_token, env_name: "FL_COMMIT_GITHUB_FILE_API_TOKEN", description: "Personal API Token for GitHub - generate one at https://github.com/settings/tokens", sensitive: true, is_string: true, code_gen_sensitive: true, default_value: ENV["GITHUB_API_TOKEN"], default_value_dynamic: true, optional: false), FastlaneCore::ConfigItem.new(key: :branch, env_name: "FL_COMMIT_GITHUB_FILE_BRANCH", description: "The branch that the file should be committed on (default: master)", default_value: 'master', optional: true), FastlaneCore::ConfigItem.new(key: :path, env_name: 'FL_COMMIT_GITHUB_FILE_PATH', description: 'The relative path to your file from project root e.g. assets/my_app.xcarchive', optional: false, is_string: true, verify_block: proc do |value| value = File.(value) UI.user_error!("File not found at path '#{value}'") unless File.exist?(value) end), FastlaneCore::ConfigItem.new(key: :message, env_name: "FL_COMMIT_GITHUB_FILE_MESSAGE", description: "The commit message. Defaults to the file name", default_value_dynamic: true, optional: true), FastlaneCore::ConfigItem.new(key: :secure, env_name: "FL_COMMIT_GITHUB_FILE_SECURE", description: "Optionally disable secure requests (ssl_verify_peer)", is_string: false, default_value: true, optional: true) ] end |
.category ⇒ Object
181 182 183 |
# File 'fastlane/lib/fastlane/actions/commit_github_file.rb', line 181 def self.category :source_control end |
.description ⇒ Object
75 76 77 |
# File 'fastlane/lib/fastlane/actions/commit_github_file.rb', line 75 def self.description "This will commit a file directly on GitHub via the API" end |
.details ⇒ Object
79 80 81 82 83 84 85 |
# File 'fastlane/lib/fastlane/actions/commit_github_file.rb', line 79 def self.details [ "Commits a file directly to GitHub. You must provide your GitHub Personal token (get one from [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new)), the repository name and the relative file path from the root git project.", "Out parameters provide the commit sha created, which can be used for later usage for examples such as releases, the direct download link and the full response JSON.", "Documentation: [https://developer.github.com/v3/repos/contents/#create-a-file](https://developer.github.com/v3/repos/contents/#create-a-file)." ].join("\n") end |
.example_code ⇒ Object
164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'fastlane/lib/fastlane/actions/commit_github_file.rb', line 164 def self.example_code [ 'response = commit_github_file( repository_name: "fastlane/fastlane", server_url: "https://api.github.com", api_token: ENV["GITHUB_TOKEN"], message: "Add my new file", branch: "master", path: "assets/my_new_file.xcarchive" )' ] end |
.is_supported?(platform) ⇒ Boolean
177 178 179 |
# File 'fastlane/lib/fastlane/actions/commit_github_file.rb', line 177 def self.is_supported?(platform) true end |
.output ⇒ Object
141 142 143 144 145 146 147 |
# File 'fastlane/lib/fastlane/actions/commit_github_file.rb', line 141 def self.output [ ['COMMIT_GITHUB_FILE_HTML_LINK', 'Link to your committed file'], ['COMMIT_GITHUB_FILE_SHA', 'Commit SHA generated'], ['COMMIT_GITHUB_FILE_JSON', 'The whole commit JSON object response'] ] end |
.return_type ⇒ Object
149 150 151 |
# File 'fastlane/lib/fastlane/actions/commit_github_file.rb', line 149 def self.return_type :hash_of_strings end |
.return_value ⇒ Object
153 154 155 156 157 158 |
# File 'fastlane/lib/fastlane/actions/commit_github_file.rb', line 153 def self.return_value [ "A hash containing all relevant information for this commit", "Access things like 'html_url', 'sha', 'message'" ].join("\n") end |
.run(params) ⇒ Object
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 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 |
# File 'fastlane/lib/fastlane/actions/commit_github_file.rb', line 10 def self.run(params) repo_name = params[:repository_name] branch = params[:branch] ||= 'master' = params[:message] file_path = params[:path] file_name = File.basename(file_path) = File.(file_path) UI.important("Creating commit on #{repo_name} on branch \"#{branch}\" for file \"#{file_path}\"") api_file_path = file_path api_file_path = "/#{api_file_path}" unless api_file_path.start_with?('/') api_file_path = api_file_path[0..-2] if api_file_path.end_with?('/') payload = { path: api_file_path, message: || "Updated : #{file_name}", content: Base64.encode64(File.open().read), branch: branch } UI.("Committing #{api_file_path}") GithubApiAction.run({ server_url: params[:server_url], api_token: params[:api_token], secure: params[:secure], http_method: "PUT", path: File.join("repos", params[:repository_name], "contents", api_file_path), body: payload, error_handlers: { 422 => proc do |result| json = result[:json] UI.error(json || result[:body]) error = if json['message'] == "Invalid request.\n\n\"sha\" wasn't supplied." "File already exists - please remove from repo before uploading or rename this upload" else "Uprocessable error" end UI.user_error!(error) end } }) do |result| UI.success("Successfully commited file to GitHub") json = result[:json] html_url = json['commit']['html_url'] download_url = json['content']['download_url'] commit_sha = json['commit']['sha'] UI.important("Commit: \"#{html_url}\"") UI.important("SHA: \"#{commit_sha}\"") UI.important("Download at: \"#{download_url}\"") Actions.lane_context[SharedValues::COMMIT_GITHUB_FILE_HTML_LINK] = html_url Actions.lane_context[SharedValues::COMMIT_GITHUB_FILE_SHA] = commit_sha Actions.lane_context[SharedValues::COMMIT_GITHUB_FILE_JSON] = json end Actions.lane_context[SharedValues::COMMIT_GITHUB_FILE_JSON] end |