[ci-app] Add User Provided Git Metadata #1662
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AdrianLC
approved these changes
Aug 27, 2021
Co-authored-by: Adrián López Calvo <adrian.lopezcalvo@datadoghq.com>
delner
requested changes
Aug 30, 2021
lib/datadog/ci/ext/environment.rb
Outdated
| Datadog::Ext::Git::TAG_COMMIT_COMMITTER_NAME => env['DD_GIT_COMMIT_COMMITTER_NAME'], | ||
| Datadog::Ext::Git::TAG_COMMIT_COMMITTER_EMAIL => env['DD_GIT_COMMIT_COMMITTER_EMAIL'], | ||
| Datadog::Ext::Git::TAG_COMMIT_COMMITTER_DATE => env['DD_GIT_COMMIT_COMMITTER_DATE'] | ||
| }.reject { |_, v| v.nil? || v.empty? } |
There was a problem hiding this comment.
I would recommend using strip on the values first, as sometimes users will introduce whitespace characters that will make the string "not empty", e.g.:
2.5.1 :002 > ' '.empty?
=> false
lib/datadog/ci/ext/environment.rb
Outdated
| @@ -324,6 +327,22 @@ def extract_bitrise(env) | |||
| } | |||
| end | |||
|
|
|||
| def extract_user_defined_git(env) | |||
| { | |||
| Datadog::Ext::Git::TAG_REPOSITORY_URL => env['DD_GIT_REPOSITORY_URL'], | |||
There was a problem hiding this comment.
All these strings should be frozen, migrated to Datadog::Ext::Git and prefixed with ENV_
e.g. 'DD_GIT_REPOSITORY_URL' => Datadog::Ext::Git::ENV_REPOSITORY_URL = 'DD_GIT_REPOSITORY_URL'.freeze
| is_expected.to eq( | ||
| { | ||
| 'ci.workspace_path' => "#{Dir.pwd}/spec/datadog/ci/ext/fixtures/git", | ||
| 'git.branch' => 'my-branch', |
There was a problem hiding this comment.
Minor suggestion, but you could derive these values from the env above e.g. 'git.branch' => env['DD_GIT_BRANCH']
marcotc
approved these changes
Sep 8, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Provide a way for users to provide
gitmetadata when other methods fail.How
gitmetadata.Note: I don't understand what's happening with
sorbet's job. If I run the typecheck in master the same errors show, so I'm not sure if they're related to my changes. Also, the files with errors seem not to be the ones I changed?