Class: Danger::Jenkins
Overview
### 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.
### 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`.
Instance Attribute Summary
Attributes inherited from CI
#pull_request_id, #repo_slug, #repo_url
Class Method Summary collapse
- .pull_request_id(env) ⇒ Object
- .repo_url(env) ⇒ Object
- .validates_as_ci?(env) ⇒ Boolean
- .validates_as_pr?(env) ⇒ Boolean
Instance Method Summary collapse
-
#initialize(env) ⇒ Jenkins
constructor
A new instance of Jenkins.
- #supported_request_sources ⇒ Object
Methods inherited from CI
available_ci_sources, inherited, #supports?
Constructor Details
#initialize(env) ⇒ Jenkins
Returns a new instance of Jenkins.
61 62 63 64 65 66 67 |
# File 'lib/danger/ci_source/jenkins.rb', line 61 def initialize(env) self.repo_url = self.class.repo_url(env) self.pull_request_id = self.class.pull_request_id(env) repo_matches = self.repo_url.match(%r{([\/:])([^\/]+\/[^\/.]+)(?:.git)?$}) self.repo_slug = repo_matches[2] unless repo_matches.nil? end |
Class Method Details
.pull_request_id(env) ⇒ Object
69 70 71 72 73 74 75 76 77 |
# File 'lib/danger/ci_source/jenkins.rb', line 69 def self.pull_request_id(env) if env["ghprbPullId"] env["ghprbPullId"] elsif env["CHANGE_ID"] env["CHANGE_ID"] else env["gitlabMergeRequestId"] end end |
.repo_url(env) ⇒ Object
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/danger/ci_source/jenkins.rb', line 79 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 |
.validates_as_ci?(env) ⇒ Boolean
41 42 43 |
# File 'lib/danger/ci_source/jenkins.rb', line 41 def self.validates_as_ci?(env) env.key? "JENKINS_URL" end |
.validates_as_pr?(env) ⇒ Boolean
45 46 47 48 |
# File 'lib/danger/ci_source/jenkins.rb', line 45 def self.validates_as_pr?(env) id = pull_request_id(env) !id.nil? && !id.empty? end |
Instance Method Details
#supported_request_sources ⇒ Object
50 51 52 53 54 55 56 57 58 59 |
# File 'lib/danger/ci_source/jenkins.rb', line 50 def supported_request_sources @supported_request_sources ||= begin [ Danger::RequestSources::GitHub, Danger::RequestSources::GitLab, Danger::RequestSources::BitbucketServer, Danger::RequestSources::BitbucketCloud ] end end |