Class: Danger::GitHubActions
- Defined in:
- lib/danger/ci_source/github_actions.rb
Overview
### CI Setup
You can use ‘danger/danger` Action in your .github/main.workflow.
```
action “Danger”
uses = "danger/danger"
```
### Token Setup
Set DANGER_GITHUB_API_TOKEN to secrets, or you can also use GITHUB_TOKEN.
“‘ action “Danger”
uses = "danger/danger"
secrets = ["GITHUB_TOKEN"]
“‘
Instance Attribute Summary
Attributes inherited from CI
#pull_request_id, #repo_slug, #repo_url
Class Method Summary collapse
Instance Method Summary collapse
-
#initialize(env) ⇒ GitHubActions
constructor
A new instance of GitHubActions.
- #supported_request_sources ⇒ Object
Methods inherited from CI
available_ci_sources, inherited, #supports?
Constructor Details
#initialize(env) ⇒ GitHubActions
Returns a new instance of GitHubActions.
38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/danger/ci_source/github_actions.rb', line 38 def initialize(env) 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? "GITHUB_ACTION") && (!env.key? 'DANGER_GITHUB_API_TOKEN') env['DANGER_GITHUB_API_TOKEN'] = env['GITHUB_TOKEN'] end end |
Class Method Details
.validates_as_ci?(env) ⇒ Boolean
26 27 28 |
# File 'lib/danger/ci_source/github_actions.rb', line 26 def self.validates_as_ci?(env) env.key? "GITHUB_ACTION" end |
.validates_as_pr?(env) ⇒ Boolean
30 31 32 |
# File 'lib/danger/ci_source/github_actions.rb', line 30 def self.validates_as_pr?(env) env["GITHUB_EVENT_NAME"] == "pull_request" end |
Instance Method Details
#supported_request_sources ⇒ Object
34 35 36 |
# File 'lib/danger/ci_source/github_actions.rb', line 34 def supported_request_sources @supported_request_sources ||= [Danger::RequestSources::GitHub] end |