Upload the git commit details to Datadog.
You need to have DATADOG_API_KEY in your environment.
# Environment setup
export DATADOG_API_KEY="<API KEY>"It is possible to configure the tool to use Datadog EU by defining the DATADOG_SITE environment variable to datadoghq.eu. By default the requests are sent to Datadog US.
It is also possible to override the full URL for the intake endpoint by defining the DATADOG_SOURCEMAP_INTAKE_URL environment variable.
This command will upload the current commit details to Datadog in order to create links to your repositories inside DataDog's UI.
This command should be run inside a local git repository and the git program must be available:
datadog-ci git-metadata upload--repository-url(default: empty): overrides the repository remote with a custom URL. For example: https://github.com/my-company/my-project
The git-metadata command only reports commits in the current HEAD's history with a commit date within the last 30 days. The command outputs a maximum of 1,000 commits.
The repository URL is inferred from the remote named origin (or the first remote if none are named origin). The value can be overridden by using the --repository-url flag.
For example: The remote git@github.com:Datadog/example.git will create links that point to https://github.com/Datadog/example.
The only repository URLs supported are the ones whose host contains: github, gitlab, bitbucket, or dev.azure. This allows Datadog to create proper URLs such as:
| Provider | URL |
|---|---|
| GitHub / GitLab | https://<repository-url>/blob/<commit-hash>/<tracked-file-path>#L<line> |
| Bitbucket | https://<repository-url>/src/<commit-hash>/<tracked-file-path>#lines-<line> |
| Azure DevOps | https://<repository-url>?version=GC<commit-hash>&path=<tracked-file-path>&line=<line>&lineEnd=<line + 1>&lineStartColumn=1&lineEndColumn=1 |
To verify this command works as expected, you can trigger a test run and verify it returns 0:
export DATADOG_API_KEY='<API key>'
yarn launch git-metadata uploadSuccessful output should look like this:
Reporting commit fceed94376fc50dea8ba6d6310002dcf1efcc06e from repository git@github.com:DataDog/datadog-ci.git.
180 tracked file paths will be reported.
✅ Uploaded in 0.736 seconds.
✨ Done in 4.27sAdditional helpful documentation, links, and articles: