danger 5.5.13 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86f276d8c5867f3bd9af4a43eeeed767d3da5cb4
-  data.tar.gz: ccd5d8970c95b39c7a9e4c7ff7ce8d5495119907
+  metadata.gz: 9973389d96fb5038948aadcc696a845877b934df
+  data.tar.gz: 23a75796bf999b53a9fb9cd75ab76cb0a22168b9
 SHA512:
-  metadata.gz: 80a6e781e5efc2548051efaeab5abab55986988666164005eba62f1caaa9619f469e2a1f7c9fc1fd11dcdeb06ce37831a4690d59a006771bb08f28492826fbc2
-  data.tar.gz: a669e6fecbe9beebe411036680df637b1be46ad9a52c737bfd58042773f425cd60e6d643fc46aef199769d590dff0879aa885094dfc4fdf6e4edfbe27354ccdd
+  metadata.gz: 6c5986ae5c49a22d58f641e70c28db3705a38aa8c63ce8cf0cbccca87098bce89c2546144ef5431cf356f5ff5054a9cea5c91893c52767b816607e4885f95689
+  data.tar.gz: fe1764de97f55c1cd740bbdac32517795835de5bc19265b2eb18e58c37d215cd133bee754e2aee55afa8e0f0c3dfe6a26e6212d134f40423e4d21f72aff7dc1d

data/lib/danger/ci_source/circle.rb

@@ -6,29 +6,36 @@ require "danger/request_sources/github/github"
 module Danger
   # ### CI Setup
   #
-  # For setting up Circle CI, we recommend turning on "Only Build pull requests." in "Advanced Setting." Without this enabled,
-  # it is _really_ tricky for Danger to know whether you are in a pull request or not, as the environment metadata
-  # isn't reliable.
+  # For setting up CircleCI, we recommend turning on "Only build pull requests" in "Advanced Settings." Without this enabled,
+  # it's trickier for Danger to determine whether you're in a pull request or not, as the environment metadata
+  # isn't as reliable.
   #
-  # With that set up, you can you add `bundle exec danger` to your `circle.yml`. If you override the default
-  # `test:` section, then add it as an extra step. Otherwise add a new `pre` section to the test:
+  # A common scenario is when CircleCI begins building a commit before the commit becomes associated with a PR
+  # (e.g. a developer pushes their branch to the remote repo for the first time. CircleCI spins up and begins building.
+  # Moments later the developer creates a PR on GitHub. Since the build process started before the PR existed,
+  # Danger won't be able to use the Circle-provided environment variables to retrieve PR metadata.)
   #
-  #  ``` ruby
-  #   test:
-  #     override:
-  #        - bundle exec danger
+  # With "Only build pull requests" enabled, you can add `bundle exec danger` to your `config.yml` (Circle 2.0).
+  #
+  # e.g.
+  #
+  #  ``` yaml
+  #  - run: bundle exec danger --verbose
   #  ```
   #
+  # And that should be it!
+  #
   # ### Token Setup
   #
-  # There is no difference here for OSS vs Closed, add your `DANGER_GITHUB_API_TOKEN` to the Environment variable settings page.
+  # If "Only build pull requests" can't be enabled for your project, Danger _can_ still work by relying on CircleCI's API
+  # to retrieve PR metadata, which will require an API token.
+  #
+  # 1. Go to your project > Settings > API Permissions. Create a token with scope "view-builds" and a label like "DANGER_CIRCLE_CI_API_TOKEN".
+  # 2. Settings > Environement Variables. Add the token as a CircleCI environment variable, which exposes it to the Danger process.
   #
-  # ### I still want to run commit builds
+  # There is no difference here for OSS vs Closed, both scenarios will need this environment variable.
   #
-  # OK, alright. So, if you add a `DANGER_CIRCLE_CI_API_TOKEN` then Danger will use the Circle API to look up
-  # the status of whether a commit is inside a PR or not. You can generate a token from inside the project set_trace_func
-  # then go to Permissions > "API Permissions" and generate a token with access to Status. Take that token and add
-  # it to Build Settings > "Environment Variables".
+  # With these pieces in place, Danger should be able to work as expected.
   #
   class CircleCI < CI
     # Side note: CircleCI is complicated. The env vars for PRs are not guaranteed to exist
@@ -45,7 +52,7 @@ module Danger
       return true if env["CIRCLE_PULL_REQUEST"] && !env["CIRCLE_PULL_REQUEST"].empty?
 
       # Real-world talk, it should be worrying if none of these are in the environment
-      return false unless ["CIRCLE_CI_API_TOKEN", "CIRCLE_PROJECT_USERNAME", "CIRCLE_PROJECT_REPONAME", "CIRCLE_BUILD_NUM"].all? { |x| env[x] && !env[x].empty? }
+      return false unless ["DANGER_CIRCLE_CI_API_TOKEN", "CIRCLE_PROJECT_USERNAME", "CIRCLE_PROJECT_REPONAME", "CIRCLE_BUILD_NUM"].all? { |x| env[x] && !env[x].empty? }
 
       # Uses the Circle API to determine if it's a PR otherwise
       api = CircleAPI.new

data/lib/danger/ci_source/circle_api.rb

@@ -16,7 +16,7 @@ module Danger
 
       if url.nil? && !env["CIRCLE_PROJECT_USERNAME"].nil? && !env["CIRCLE_PROJECT_REPONAME"].nil?
         repo_slug = env["CIRCLE_PROJECT_USERNAME"] + "/" + env["CIRCLE_PROJECT_REPONAME"]
-        token = env["DANGER_CIRCLE_CI_API_TOKEN"] || env["CIRCLE_CI_API_TOKEN"]
+        token = env["DANGER_CIRCLE_CI_API_TOKEN"]
         url = fetch_pull_request_url(repo_slug, env["CIRCLE_BUILD_NUM"], token)
       end
       url
@@ -29,7 +29,9 @@ module Danger
     # Ask the API if the commit is inside a PR
     def fetch_pull_request_url(repo_slug, build_number, token)
       build_json = fetch_build(repo_slug, build_number, token)
-      build_json[:pull_request_urls].first
+      pull_requests = build_json[:pull_requests]
+      return nil unless pull_requests.first
+      pull_requests.first[:url]
     end
 
     # Make the API call, and parse the JSON

data/lib/danger/ci_source/screwdriver.rb

@@ -0,0 +1,47 @@
+# http://screwdriver.cd
+# https://docs.screwdriver.cd/user-guide/environment-variables
+require "danger/request_sources/github/github"
+
+module Danger
+  # ### CI Setup
+  #
+  # Install dependencies and add a danger step to your screwdriver.yaml:
+  # ``` yml
+  # jobs:
+  #   danger:
+  #     requires: [~pr, ~commit]
+  #     steps:
+  #       - setup: bundle install --path vendor
+  #       - danger: bundle exec danger
+  #     secrets:
+  #       - DANGER_GITHUB_API_TOKEN
+  # ```
+  #
+  # ### Token Setup
+  #
+  # Add the `DANGER_GITHUB_API_TOKEN` to your pipeline env as a
+  # [build secret](https://docs.screwdriver.cd/user-guide/configuration/secrets)
+  #
+  class Screwdriver < CI
+    def self.validates_as_ci?(env)
+      env.key? "SCREWDRIVER"
+    end
+
+    def self.validates_as_pr?(env)
+      exists = ["SD_PULL_REQUEST", "SCM_URL"].all? { |x| env[x] && !env[x].empty? }
+      exists && env["SD_PULL_REQUEST"].to_i > 0
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::GitHub]
+    end
+
+    def initialize(env)
+      self.repo_slug = env["SCM_URL"].split(":").last.gsub(".git", "")
+      self.repo_url = env["SCM_URL"]
+      if env["SD_PULL_REQUEST"].to_i > 0
+        self.pull_request_id = env["SD_PULL_REQUEST"]
+      end
+    end
+  end
+end

data/lib/danger/danger_core/plugins/dangerfile_messaging_plugin.rb

@@ -107,7 +107,7 @@ module Danger
     # @!group Core
     # Print out a generate message on the PR
     #
-    # @param    [String, Array<String> message
+    # @param    [String, Array<String>] message
     #           The message to present to the user
     # @param    [Boolean] sticky
     #           Whether the message should be kept after it was fixed,
@@ -124,14 +124,14 @@ module Danger
       line = options.fetch(:line, nil)
 
       messages.flatten.each do |message|
-        @messages << Violation.new(message, sticky, file, line)
+        @messages << Violation.new(message, sticky, file, line) if message
       end
     end
 
     # @!group Core
     # Specifies a problem, but not critical
     #
-    # @param    [String, Array<String> message
+    # @param    [String, Array<String>] message
     #           The message to present to the user
     # @param    [Boolean] sticky
     #           Whether the message should be kept after it was fixed,
@@ -149,14 +149,14 @@ module Danger
 
       warnings.flatten.each do |warning|
         next if should_ignore_violation(warning)
-        @warnings << Violation.new(warning, sticky, file, line)
+        @warnings << Violation.new(warning, sticky, file, line) if warning
       end
     end
 
     # @!group Core
     # Declares a CI blocking error
     #
-    # @param    [String, Array<String> message
+    # @param    [String, Array<String>] message
     #           The message to present to the user
     # @param    [Boolean] sticky
     #           Whether the message should be kept after it was fixed,
@@ -174,7 +174,7 @@ module Danger
 
       failures.flatten.each do |failure|
         next if should_ignore_violation(failure)
-        @errors << Violation.new(failure, sticky, file, line)
+        @errors << Violation.new(failure, sticky, file, line) if failure
       end
     end
 

data/lib/danger/version.rb

@@ -1,4 +1,4 @@
 module Danger
-  VERSION = "5.5.13".freeze
+  VERSION = "5.6.0".freeze
   DESCRIPTION = "Like Unit Tests, but for your Team Culture.".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger
 version: !ruby/object:Gem::Version
-  version: 5.5.13
+  version: 5.6.0
 platform: ruby
 authors:
 - Orta Therox
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-29 00:00:00.000000000 Z
+date: 2018-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: claide
@@ -191,6 +191,7 @@ files:
 - lib/danger/ci_source/gitlab_ci.rb
 - lib/danger/ci_source/jenkins.rb
 - lib/danger/ci_source/local_git_repo.rb
+- lib/danger/ci_source/screwdriver.rb
 - lib/danger/ci_source/semaphore.rb
 - lib/danger/ci_source/support/commits.rb
 - lib/danger/ci_source/support/find_repo_info_from_logs.rb
@@ -291,7 +292,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Like Unit Tests, but for your Team Culture.