class Danger::Jenkins
### CI
Setup Ah Jenkins
, so many memories. So, if you’re using Jenkins
, you’re hosting your own environment.
#### GitHub You will want to be using the [GitHub pull request builder plugin](wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin) in order to ensure that you have the build environment set up for PR
integration.
With that set up, you can edit your job to add ‘bundle exec danger` at the build action.
##### Pipeline If your’re using [pipelines](jenkins.io/solutions/pipeline/) you should be using the [GitHub branch source plugin](wiki.jenkins-ci.org/display/JENKINS/GitHub+Branch+Source+Plugin) for easy setup and handling of PRs.
After you’ve set up the plugin, add a ‘sh ’bundle exec danger’‘ line in your pipeline script and make sure that build PRs is enabled.
#### GitLab You will want to be using the [GitLab Plugin](github.com/jenkinsci/gitlab-plugin) in order to ensure that you have the build environment set up for MR integration.
With that set up, you can edit your job to add ‘bundle exec danger` at the build action.
#### General
People occasionally see issues with Danger
not classing your CI
runs as a PR
, to give you visibility the Jenkins
side of Danger
expects to see one of these env vars:
-
ghprbPullId
-
CHANGE_ID
-
gitlabMergeRequestIid
-
gitlabMergeRequestId
### Token Setup
#### GitHub As you own the machine, it’s up to you to add the environment variable for the ‘DANGER_GITHUB_API_TOKEN`.
#### GitLab As you own the machine, it’s up to you to add the environment variable for the ‘DANGER_GITLAB_API_TOKEN`.
Attributes
Public Class Methods
Source
# File lib/danger/ci_source/jenkins.rb, line 76 def initialize(env) raise EnvNotFound.new if env.nil? || env.empty? self.repo_url = self.class.repo_url(env) self.pull_request_id = self.class.pull_request_id(env) self.repo_slug = self.class.repo_slug(self.repo_url) self.project_url = env["CI_MERGE_REQUEST_PROJECT_URL"] || env["CI_PROJECT_URL"] end
Source
# File lib/danger/ci_source/jenkins.rb, line 113 def self.pull_request_id(env) if env["ghprbPullId"] env["ghprbPullId"] elsif env["CHANGE_ID"] env["CHANGE_ID"] elsif env["gitlabMergeRequestIid"] env["gitlabMergeRequestIid"] else env["gitlabMergeRequestId"] end end
Source
# File lib/danger/ci_source/jenkins.rb, line 85 def self.repo_slug(repo_url) slug = self.slug_ssh(repo_url) slug ||= self.slug_http(repo_url) slug ||= self.slug_bitbucket(repo_url) slug ||= self.slug_fallback(repo_url) return slug.gsub(/\.git$/, "") unless slug.nil? end
Source
# File lib/danger/ci_source/jenkins.rb, line 125 def self.repo_url(env) if env["GIT_URL_1"] env["GIT_URL_1"] elsif env["CHANGE_URL"] change_url = env["CHANGE_URL"] case change_url when %r{/pull/} # GitHub matches = change_url.match(%r{(.+)/pull/[0-9]+}) matches[1] unless matches.nil? when %r{/merge_requests/} # GitLab matches = change_url.match(%r{(.+?)(/-)?/merge_requests/[0-9]+}) matches[1] unless matches.nil? when %r{/pull-requests/} # Bitbucket matches = change_url.match(%r{(.+)/pull-requests/[0-9]+}) matches[1] unless matches.nil? else change_url end else env["GIT_URL"] end end
Source
# File lib/danger/ci_source/jenkins.rb, line 93 def self.slug_bitbucket(repo_url) repo_matches = repo_url.match(%r{(?:[/:])projects/([^/.]+)/repos/([^/.]+)}) return "#{repo_matches[1]}/#{repo_matches[2]}" if repo_matches end
Source
# File lib/danger/ci_source/jenkins.rb, line 108 def self.slug_fallback(repo_url) repo_matches = repo_url.match(%r{([/:])([^/]+/[^/]+)$}) return repo_matches[2] end
Source
# File lib/danger/ci_source/jenkins.rb, line 103 def self.slug_http(repo_url) repo_matches = repo_url.match(%r{^https?.+(?>\.\w*\d*/)(.+.git$)}) return repo_matches[1] if repo_matches end
Source
# File lib/danger/ci_source/jenkins.rb, line 98 def self.slug_ssh(repo_url) repo_matches = repo_url.match(/^git@.+:(.+)/) return repo_matches[1] if repo_matches end
Source
# File lib/danger/ci_source/jenkins.rb, line 58 def self.validates_as_ci?(env) env.key? "JENKINS_URL" end
Source
# File lib/danger/ci_source/jenkins.rb, line 62 def self.validates_as_pr?(env) id = pull_request_id(env) !id.nil? && !id.empty? && !!id.match(/^\d+$/) end
Public Instance Methods
Source
# File lib/danger/ci_source/jenkins.rb, line 67 def supported_request_sources @supported_request_sources ||= [ Danger::RequestSources::GitHub, Danger::RequestSources::GitLab, Danger::RequestSources::BitbucketServer, Danger::RequestSources::BitbucketCloud ] end