class Danger::CustomCIWithGithub
### CI
Setup
Custom CI
with GitHub
This CI
source is for custom, most likely internal, CI
systems that are use GitHub as source control. An example could be argo-workflows or tekton hosted in your own Kubernetes cluster.
The following environment variables are required:
-
‘CUSTOM_CI_WITH_GITHUB` - Set to any value to indicate that this is a custom
CI
with GitHub
### Token Setup
#### GitHub As you own the setup, it’s up to you to add the environment variable for the ‘DANGER_GITHUB_API_TOKEN`.
Public Class Methods
new(env)
click to toggle source
Calls superclass method
Danger::CI::new
# File lib/danger/ci_source/custom_ci_with_github.rb, line 35 def initialize(env) super self.repo_slug = env["GITHUB_REPOSITORY"] pull_request_event = JSON.parse(File.read(env["GITHUB_EVENT_PATH"])) self.pull_request_id = pull_request_event["number"] self.repo_url = pull_request_event["repository"]["clone_url"] # if environment variable DANGER_GITHUB_API_TOKEN is not set, use env GITHUB_TOKEN if (env.key? "CUSTOM_CI_WITH_GITHUB") && (!env.key? "DANGER_GITHUB_API_TOKEN") env["DANGER_GITHUB_API_TOKEN"] = env["GITHUB_TOKEN"] end end
validates_as_ci?(env)
click to toggle source
# File lib/danger/ci_source/custom_ci_with_github.rb, line 22 def self.validates_as_ci?(env) env.key? "CUSTOM_CI_WITH_GITHUB" end
validates_as_pr?(env)
click to toggle source
# File lib/danger/ci_source/custom_ci_with_github.rb, line 26 def self.validates_as_pr?(env) value = env["GITHUB_EVENT_NAME"] ["pull_request", "pull_request_target"].include?(value) end
Public Instance Methods
supported_request_sources()
click to toggle source
# File lib/danger/ci_source/custom_ci_with_github.rb, line 31 def supported_request_sources @supported_request_sources ||= [Danger::RequestSources::GitHub] end