Class: Danger::Init
- Defined in:
- lib/danger/commands/init.rb
Instance Attribute Summary collapse
-
#ui ⇒ Object
Returns the value of attribute ui.
Attributes inherited from Runner
Class Method Summary collapse
Instance Method Summary collapse
- #circle_token ⇒ Object
- #considered_an_oss_repo? ⇒ Boolean
- #current_repo_slug ⇒ Object
- #darwin? ⇒ Boolean
- #info ⇒ Object
-
#initialize(argv) ⇒ Init
constructor
A new instance of Init.
- #note_about_clicking_links ⇒ Object
- #run ⇒ Object
- #setup_access_token ⇒ Object
- #setup_danger_ci ⇒ Object
- #setup_dangerfile ⇒ Object
- #setup_github_account ⇒ Object
- #show_todo_state ⇒ Object
- #thanks ⇒ Object
- #travis_token ⇒ Object
- #unsure_ci ⇒ Object
- #unsure_token ⇒ Object
- #uses_circle ⇒ Object
- #uses_travis ⇒ Object
Methods inherited from Runner
Constructor Details
#initialize(argv) ⇒ Init
Returns a new instance of Init.
19 20 21 22 23 24 25 |
# File 'lib/danger/commands/init.rb', line 19 def initialize(argv) @bot_name = File.basename(Dir.getwd).split(".").first.capitalize + "Bot" super @ui = Interviewer.new(cork) ui.no_delay = argv.flag?("impatient", false) ui.no_waiting = argv.flag?("mousey", false) end |
Instance Attribute Details
#ui ⇒ Object
Returns the value of attribute ui.
10 11 12 |
# File 'lib/danger/commands/init.rb', line 10 def ui @ui end |
Class Method Details
.options ⇒ Object
12 13 14 15 16 17 |
# File 'lib/danger/commands/init.rb', line 12 def self. [ ["--impatient", "'I've not got all day here. Don't add any thematic delays please.'"], ["--mousey", "'Don't make me press return to continue the adventure.'"] ].concat(super) end |
Instance Method Details
#circle_token ⇒ Object
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/danger/commands/init.rb', line 218 def circle_token # https://circleci.com/gh/artsy/eigen/edit#env-vars if considered_an_oss_repo? ui.say "Before we start, it's important to be up-front. CircleCI only really has one option to support running Danger" ui.say "for forks on OSS repos. It is quite a drastic option, and I want to let you know the best place to understand" ui.say "the ramifications of turning on a setting I'm about to advise.\n" ui.link "https://circleci.com/docs/fork-pr-builds" ui.say "TLDR: If you have anything other than Danger config settings in CircleCI, then you should not turn on the setting." ui.say "I'll give you a minute to read it..." ui.wait_for_return ui.say "On Danger/Danger we turn on " + "Permissive building of fork pull requests".yellow + " this exposes the token to Danger" ui.say "You can find this setting at:" ui.link "https://circleci.com/gh/#{current_repo_slug}/edit#advanced-settings\n" ui.say "I'll hold..." ui.wait_for_return end ui.say "In order to expose an environment variable, go to:" ui.link "https://circleci.com/gh/#{current_repo_slug}/edit#env-vars" ui.say "The name is " + "DANGER_GITHUB_API_TOKEN".yellow + " and the value is the GitHub Personal Acess Token." end |
#considered_an_oss_repo? ⇒ Boolean
133 134 135 |
# File 'lib/danger/commands/init.rb', line 133 def considered_an_oss_repo? @is_open_source == "open" end |
#current_repo_slug ⇒ Object
137 138 139 140 141 |
# File 'lib/danger/commands/init.rb', line 137 def current_repo_slug @git = GitRepo.new repo_matches = @git.origins.match(%r{([\/:])([^\/]+\/[^\/.]+)(?:.git)?$}) repo_matches[2] || "[Your/Repo]" end |
#darwin? ⇒ Boolean
278 279 280 |
# File 'lib/danger/commands/init.rb', line 278 def darwin? Gem::Platform.local.os == "darwin" end |
#info ⇒ Object
256 257 258 259 260 261 262 263 264 265 266 267 |
# File 'lib/danger/commands/init.rb', line 256 def info ui.header "Useful info" ui.say "- One of the best ways to test out new rules locally is via " + "bundle exec danger local".yellow + "." ui.pause 0.6 ui.say "- You can have Danger output all of its variables to the console via the " + "--verbose".yellow + " option." ui.pause 0.6 ui.say "- You can look at the following Dangerfiles to get some more ideas:" ui.pause 0.6 ui.link "https://github.com/danger/danger/blob/master/Dangerfile" ui.link "https://github.com/artsy/eigen/blob/master/Dangerfile" ui.pause 1 end |
#note_about_clicking_links ⇒ Object
246 247 248 249 250 251 252 253 254 |
# File 'lib/danger/commands/init.rb', line 246 def note_about_clicking_links modifier_key = "ctrl" clicks = "clicking" modifier_key = "cmd ( ā )" if darwin? clicks = "double clicking" if darwin? && !ENV["ITERM_SESSION_ID"] ui.say "Note: Holding #{modifier_key} and #{clicks} a link will open it in your browser." end |
#run ⇒ Object
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
# File 'lib/danger/commands/init.rb', line 27 def run ui.say "\nOK, thanks #{ENV['LOGNAME']}, have a seat and we'll get you started.\n".yellow ui.pause 1 show_todo_state ui.pause 1.4 setup_dangerfile setup_github_account setup_access_token setup_danger_ci info thanks end |
#setup_access_token ⇒ Object
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 |
# File 'lib/danger/commands/init.rb', line 101 def setup_access_token ui.header "Step 3: Configuring a GitHub Personal Access Token" ui.say "Here's the link, you should open this in the private session where you just created the new GitHub account" ui.link "https://github.com/settings/tokens/new" ui.pause 1 @is_open_source = ui.ask_with_answers("For token access rights, I need to know if this is for an Open Source or Closed Source project\n", ["Open", "Closed"]) if considered_an_oss_repo? ui.say "For Open Source projects, I'd recommend giving the token the smallest scope possible." ui.say "This means only providing access to " + "public_repo".yellow + " in the token.\n\n" ui.pause 1 ui.say "This token limits Danger's abilities to just writing comments on OSS projects. I recommend" ui.say "this because the token can quite easily be extracted from the environment via pull requests." ui.say "#{@bot_name} does not need admin access to your repo. So its ability to cause chaos is minimalized.\n" ui.say "\nIt is important that you do not store this token in your repository, as GitHub will automatically revoke it when pushed.\n" elsif @is_open_source == "closed" ui.say "For Closed Source projects, I'd recommend giving the token access to the whole repo scope." ui.say "This means only providing access to " + "repo".yellow + ", and its children in the token.\n\n" ui.pause 1 ui.say "It's worth noting that you " + "should not".bold.white + " re-use this token for OSS repos." ui.say "Make a new one for those repos with just " + "public_repo".yellow + "." ui.pause 1 ui.say "Additionally, don't forget to add your new GitHub account as a collaborator to your Closed Source project." end ui.say "\nš, please press return when you have your token set up..." ui.wait_for_return end |
#setup_danger_ci ⇒ Object
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/danger/commands/init.rb', line 143 def setup_danger_ci ui.header "Step 4: Add Danger for your CI" uses_travis if File.exist? ".travis.yml" uses_circle if File.exist? "circle.yml" unsure_ci unless File.exist?(".travis.yml") || File.exist?(".circle.yml") ui.say "\nOK, I'll give you a moment to do this..." ui.wait_for_return ui.header "Final step: exposing the GitHub token as an environment build variable." ui.pause 0.4 if considered_an_oss_repo? ui.say "As you have an Open Source repo, this token should be considered public, otherwise you cannot" ui.say "run Danger on pull requests from forks, limiting its use.\n" ui.pause 1 end travis_token if File.exist? ".travis.yml" circle_token if File.exist? "circle.yml" unsure_token unless File.exist?(".travis.yml") || File.exist?(".circle.yml") ui.pause 0.6 ui.say "This is the last step, I can give you a second..." ui.wait_for_return end |
#setup_dangerfile ⇒ Object
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/danger/commands/init.rb', line 55 def setup_dangerfile dir = Danger.gem_path content = File.read(File.join(dir, "lib", "assets", "DangerfileTemplate")) File.write("Dangerfile", content) ui.header "Step 1: Creating a starter Dangerfile" ui.say "I've set up an example Dangerfile for you in this folder.\n" ui.pause 1 ui.say "cat #{Dir.pwd}/Dangerfile\n".blue content.lines.each do |l| ui.say " " + l.chomp.green end ui.say "" ui.pause 2 ui.say "There's a collection of small, simple ideas in here, but Danger is about being able to easily" ui.say "iterate. The power comes from you having the ability to codify fixes for some of the problems" ui.say "that come up in day to day programming. It can be difficult to try and see those from day 1." ui.say "\nIf you'd like to investigate the file, and make some changes - I'll wait here," ui.say "press return when you're ready to move on..." ui.wait_for_return end |
#setup_github_account ⇒ Object
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/danger/commands/init.rb', line 80 def setup_github_account ui.header "Step 2: Creating a GitHub account" ui.say "In order to get the most out of Danger, I'd recommend giving her the ability to post in" ui.say "the code-review comment section.\n\n" ui.pause 1 ui.say "IMO, it's best to do this by using the private mode of your browser. Create an account like" ui.say "#{@bot_name}, and don't forget a cool robot avatar.\n\n" ui.pause 1 ui.say "Here are great resources for creative commons images of robots:" ui.link "https://www.flickr.com/search/?text=robot&license=2%2C3%2C4%2C5%2C6%2C9" ui.link "https://www.google.com/search?q=robot&tbs=sur:fmc&tbm=isch&tbo=u&source=univ&sa=X&ved=0ahUKEwjgy8-f95jLAhWI7hoKHV_UD00QsAQIMQ&biw=1265&bih=1359" ui.say "" note_about_clicking_links ui.pause 1 ui.say "\nCool, please press return when you have your account ready (and you've verified the email...)" ui.wait_for_return end |
#show_todo_state ⇒ Object
43 44 45 46 47 48 49 50 51 52 53 |
# File 'lib/danger/commands/init.rb', line 43 def show_todo_state ui.say "We need to do the following:\n" ui.pause 0.6 ui.say " - [ ] Create a Dangerfile and add a few simple rules." ui.pause 0.6 ui.say " - [#{@account_created ? 'x' : ' '}] Create a GitHub account for Danger to use, for messaging." ui.pause 0.6 ui.say " - [ ] Set up an access token for Danger." ui.pause 0.6 ui.say " - [ ] Set up Danger to run on your CI.\n\n" end |
#thanks ⇒ Object
269 270 271 272 273 274 275 276 |
# File 'lib/danger/commands/init.rb', line 269 def thanks ui.say "\n\nš" ui.pause 0.6 ui.say "And you're good to go. Danger is a collaboration between Orta Therox, Gem 'Danger' McShane and Felix Krause." ui.say "If you like it, let others know. If you want to know more, follow " + "@orta".yellow + " and " + "@KrauseFx".yellow + " on Twitter." ui.say "If you don't like it, help us improve it! xxx" end |
#travis_token ⇒ Object
208 209 210 211 212 213 214 215 216 |
# File 'lib/danger/commands/init.rb', line 208 def travis_token # https://travis-ci.org/artsy/eigen/settings ui.say "In order to add an environment variable, go to:" ui.link "https://travis-ci.org/#{current_repo_slug}/settings" ui.say "\nThe name is " + "DANGER_GITHUB_API_TOKEN".yellow + " and the value is the GitHub Personal Access Token." if @is_open_source ui.say 'Make sure to have "Display value in build log" enabled.' end end |
#unsure_ci ⇒ Object
201 202 203 204 205 206 |
# File 'lib/danger/commands/init.rb', line 201 def unsure_ci danger = "bundle exec danger".yellow ui.say "As I'm not sure what CI you want to run Danger on based on the files in your repo, I'll just offer some generic" ui.say "advice. You want to run " + danger + " after your tests have finished running, it should still be during the testing" ui.say "process so the build can fail." end |
#unsure_token ⇒ Object
241 242 243 244 |
# File 'lib/danger/commands/init.rb', line 241 def unsure_token ui.say "You need to expose a token called " + "DANGER_GITHUB_API_TOKEN".yellow + " and the value is the GitHub Personal Acess Token." ui.say "Depending on the CI system, this may need to be done on the machine ( in the " + "~/.bashprofile".yellow + ") or in a web UI somewhere." end |
#uses_circle ⇒ Object
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/danger/commands/init.rb', line 183 def uses_circle danger = "- bundle exec danger".yellow config = YAML.load(File.read("circle.yml")) if config["test"] if config["test"]["post"] ui.say "Add " + danger + " as a new step in the " + "test:post:".yellow + " section of your circle.yml file." else ui.say "Add " + danger + " as a new step in the " + "test:override:".yellow + " section of your circle.yml file." end else ui.say "Add this to the bottom of your circle.yml file:" ui.say "test:".green ui.say " post:".green ui.say " #{danger}".green end end |
#uses_travis ⇒ Object
170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/danger/commands/init.rb', line 170 def uses_travis danger = "bundle exec danger".yellow config = YAML.load(File.read(".travis.yml")) if config["script"] ui.say "Add " + "- ".yellow + danger + " as a new step in the " + "script".yellow + " section of your .travis.yml file." else ui.say "I'd recommend adding " + "script: ".yellow + danger + " to the script section of your .travis.yml file." end ui.pause 1 ui.say "You shouldn't use " + "after_success, after_failure, after_script".red + " as they cannot fail your builds." end |