Class: Datadog::CI::Ext::Environment::Providers::GithubActions

Inherits:
Base
  • Object
show all
Defined in:
lib/datadog/ci/ext/environment/providers/github_actions.rb

Overview

Github Actions: github.com/features/actions Environment variables docs: docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables

Instance Attribute Summary

Attributes inherited from Base

#env

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#git_branch, #git_commit_author_date, #git_commit_author_email, #git_commit_author_name, #git_commit_committer_date, #git_commit_committer_email, #git_commit_committer_name, #git_commit_message, #git_tag, #initialize, #node_labels, #node_name, #stage_name

Constructor Details

This class inherits a constructor from Datadog::CI::Ext::Environment::Providers::Base

Class Method Details

.handles?(env) ⇒ Boolean

Returns:

  • (Boolean) 

18
19
20
 
# File 'lib/datadog/ci/ext/environment/providers/github_actions.rb', line 18

def self.handles?(env)
  env.key?("GITHUB_SHA")
end

Instance Method Details

#additional_tags ⇒ Object 


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/datadog/ci/ext/environment/providers/github_actions.rb', line 79

def additional_tags
  base_ref = env["GITHUB_BASE_REF"]
  return {} if base_ref.nil? || base_ref.empty?

  # @type var result: Hash[String, String]
  result = {
    Git::TAG_PULL_REQUEST_BASE_BRANCH => base_ref
  }

  event_path = env["GITHUB_EVENT_PATH"]
  event_json = JSON.parse(File.read(event_path))

  head_sha = event_json.dig("pull_request", "head", "sha")
  result[Git::TAG_COMMIT_HEAD_SHA] = head_sha if head_sha

  base_sha = event_json.dig("pull_request", "base", "sha")
  result[Git::TAG_PULL_REQUEST_BASE_BRANCH_SHA] = base_sha if base_sha

  result
rescue => e
  Datadog.logger.error("Failed to extract additional tags from GitHub Actions: #{e}")
  Core::Telemetry::Logger.report(e, description: "Failed to extract additional tags from GitHub Actions")

  {}
end

#ci_env_vars ⇒ Object 


70
71
72
73
74
75
76
77
 
# File 'lib/datadog/ci/ext/environment/providers/github_actions.rb', line 70

def ci_env_vars
  {
    "GITHUB_SERVER_URL" => github_server_url,
    "GITHUB_REPOSITORY" => env["GITHUB_REPOSITORY"],
    "GITHUB_RUN_ID" => env["GITHUB_RUN_ID"],
    "GITHUB_RUN_ATTEMPT" => env["GITHUB_RUN_ATTEMPT"]
  }.reject { |_, v| v.nil? }.to_json
end

#git_branch_or_tag ⇒ Object 


64
65
66
67
68
 
# File 'lib/datadog/ci/ext/environment/providers/github_actions.rb', line 64

def git_branch_or_tag
  ref = env["GITHUB_HEAD_REF"]
  ref = env["GITHUB_REF"] if ref.nil? || ref.empty?
  ref
end

#git_commit_sha ⇒ Object 


60
61
62
 
# File 'lib/datadog/ci/ext/environment/providers/github_actions.rb', line 60

def git_commit_sha
  env["GITHUB_SHA"]
end

#git_repository_url ⇒ Object 


56
57
58
 
# File 'lib/datadog/ci/ext/environment/providers/github_actions.rb', line 56

def git_repository_url
  "#{github_server_url}/#{env["GITHUB_REPOSITORY"]}.git"
end

#job_name ⇒ Object 


26
27
28
 
# File 'lib/datadog/ci/ext/environment/providers/github_actions.rb', line 26

def job_name
  env["GITHUB_JOB"]
end

#job_url ⇒ Object 


30
31
32
 
# File 'lib/datadog/ci/ext/environment/providers/github_actions.rb', line 30

def job_url
  "#{github_server_url}/#{env["GITHUB_REPOSITORY"]}/commit/#{env["GITHUB_SHA"]}/checks"
end

#pipeline_id ⇒ Object 


34
35
36
 
# File 'lib/datadog/ci/ext/environment/providers/github_actions.rb', line 34

def pipeline_id
  env["GITHUB_RUN_ID"]
end

#pipeline_name ⇒ Object 


38
39
40
 
# File 'lib/datadog/ci/ext/environment/providers/github_actions.rb', line 38

def pipeline_name
  env["GITHUB_WORKFLOW"]
end

#pipeline_number ⇒ Object 


42
43
44
 
# File 'lib/datadog/ci/ext/environment/providers/github_actions.rb', line 42

def pipeline_number
  env["GITHUB_RUN_NUMBER"]
end

#pipeline_url ⇒ Object 


46
47
48
49
50
 
# File 'lib/datadog/ci/ext/environment/providers/github_actions.rb', line 46

def pipeline_url
  res = "#{github_server_url}/#{env["GITHUB_REPOSITORY"]}/actions/runs/#{env["GITHUB_RUN_ID"]}"
  res = "#{res}/attempts/#{env["GITHUB_RUN_ATTEMPT"]}" if env["GITHUB_RUN_ATTEMPT"]
  res
end

#provider_name ⇒ Object 


22
23
24
 
# File 'lib/datadog/ci/ext/environment/providers/github_actions.rb', line 22

def provider_name
  Provider::GITHUB
end

#workspace_path ⇒ Object 


52
53
54
 
# File 'lib/datadog/ci/ext/environment/providers/github_actions.rb', line 52

def workspace_path
  env["GITHUB_WORKSPACE"]
end