diff --git a/packages/datadog-ci/src/commands/elf-symbols/renderer.ts b/packages/datadog-ci/src/commands/elf-symbols/renderer.ts index b6d732776..6a3770013 100644 --- a/packages/datadog-ci/src/commands/elf-symbols/renderer.ts +++ b/packages/datadog-ci/src/commands/elf-symbols/renderer.ts @@ -75,7 +75,7 @@ export const renderMissingBuildId = (path: string) => chalk.red(`${ICONS.FAILED} Error: Invalid or missing 'build_id' file. Expected at path ${path}`) export const renderGitWarning = (errorMessage: string) => - chalk.yellow(`${ICONS.WARNING} An error occured while invoking git: ${errorMessage} + chalk.yellow(`${ICONS.WARNING} An error occurred while invoking git: ${errorMessage} Make sure the command is running within your git repository to fully leverage Datadog's git integration. To ignore this warning use the --disable-git flag.\n`) diff --git a/packages/datadog-ci/src/commands/flutter-symbols/renderer.ts b/packages/datadog-ci/src/commands/flutter-symbols/renderer.ts index 83874b23f..7879d6b90 100644 --- a/packages/datadog-ci/src/commands/flutter-symbols/renderer.ts +++ b/packages/datadog-ci/src/commands/flutter-symbols/renderer.ts @@ -84,7 +84,7 @@ export const renderCommandSummary = (statuses: UploadStatus[], duration: number, } export const renderGitWarning = (errorMessage: string) => - chalk.yellow(`${ICONS.WARNING} An error occured while invoking git: ${errorMessage} + chalk.yellow(`${ICONS.WARNING} An error occurred while invoking git: ${errorMessage} Make sure the command is running within your git repository to fully leverage Datadog's git integration. To ignore this warning use the --disable-git flag.\n`) diff --git a/packages/datadog-ci/src/commands/pe-symbols/renderer.ts b/packages/datadog-ci/src/commands/pe-symbols/renderer.ts index 7648fe240..eaaa205da 100644 --- a/packages/datadog-ci/src/commands/pe-symbols/renderer.ts +++ b/packages/datadog-ci/src/commands/pe-symbols/renderer.ts @@ -77,7 +77,7 @@ export const renderMissingPdbFile = (pdbFilename: string, dllPath: string) => chalk.yellow(`${ICONS.WARNING} Error: Missing '${pdbFilename}' file expected for ${dllPath}`) export const renderGitWarning = (errorMessage: string) => - chalk.yellow(`${ICONS.WARNING} An error occured while invoking git: ${errorMessage} + chalk.yellow(`${ICONS.WARNING} An error occurred while invoking git: ${errorMessage} Make sure the command is running within your git repository to fully leverage Datadog's git integration. To ignore this warning use the --disable-git flag.\n`) diff --git a/packages/datadog-ci/src/commands/react-native/renderer.ts b/packages/datadog-ci/src/commands/react-native/renderer.ts index e3c27218a..ac6b8b973 100644 --- a/packages/datadog-ci/src/commands/react-native/renderer.ts +++ b/packages/datadog-ci/src/commands/react-native/renderer.ts @@ -6,7 +6,7 @@ import chalk from 'chalk' import {RNSourcemap} from './interfaces' export const renderGitWarning = (errorMessage: string) => - chalk.yellow(`${ICONS.WARNING} An error occured while invoking git: ${errorMessage} + chalk.yellow(`${ICONS.WARNING} An error occurred while invoking git: ${errorMessage} Make sure the command is running within your git repository to fully leverage Datadog's git integration. To ignore this warning use the --disable-git flag.\n`) @@ -43,12 +43,12 @@ export const renderRemoveSourcesContentWarning = () => )}` export const renderFailedSourcesContentRemovalError = (payload: RNSourcemap, errorMessage: string) => `${chalk.red( - `An error occured while removing the "sourcesContent" part of the sourcemap file ${payload.sourcemapPath}": ${errorMessage}` + `An error occurred while removing the "sourcesContent" part of the sourcemap file ${payload.sourcemapPath}": ${errorMessage}` )}. Trying to upload the full sourcemap with the "sourcesContent".` /** - * As of now, this command takes an array of one signe UploadStatus element since we only support upload + * As of now, this command takes an array of one single UploadStatus element since we only support upload * of a single sourcemap. * We considered it was preferable to leave it this way so it's ready for multiple sourcemaps uploads, * rather than investing into adapting it for this purpose. diff --git a/packages/datadog-ci/src/commands/sourcemaps/README.md b/packages/datadog-ci/src/commands/sourcemaps/README.md index 62e9ccf51..6a7652354 100644 --- a/packages/datadog-ci/src/commands/sourcemaps/README.md +++ b/packages/datadog-ci/src/commands/sourcemaps/README.md @@ -41,7 +41,7 @@ Example: if you're uploading `dist/file.js` to `https://example.com/static/file. In addition, some optional parameters are available: * `--max-concurrency` (default: `20`): number of concurrent upload to the API. -* `--disable-git` (default: false): prevents the command from invoking git in the current working directory and sending repository related data to Datadog (hash, remote URL and the paths within the repository of the sources referenced in the sourcemap). +* `--disable-git` (default: false): prevents the command from invoking git in the current working directory and sending repository-related data to Datadog (such as the hash, remote URL, and paths within the repository of sources referenced in the sourcemap). * `--quiet` (default: false): suppresses individual line output for each upload. Success and error logs are never suppressed. * `--dry-run` (default: `false`): it will run the command without the final step of upload. All other checks are performed. * `--project-path` (default: empty): the path of the project where the sourcemaps were built. This will be stripped off from sources paths referenced in the sourcemap so they can be properly matched against tracked files paths. See details in the [dedicated section](#setting-the-project-path). @@ -49,9 +49,10 @@ In addition, some optional parameters are available: ### Link errors with your source code -Errors in Datadog UI can be enriched with links to GitHub/GitLab/Bitbucket/Azure DevOps if these requirements are met: +Errors in Datadog UI can be enriched with direct links to your repository if these requirements are met: - `git` executable is installed - `datadog-ci` is run within the git repository +- `--disable-git` is not set When these requirements are met, the upload command reports Git information such as: - the current commit hash @@ -120,4 +121,4 @@ Additional helpful documentation, links, and articles: - [Learn about Uploading JavaScript Source Maps][1] -[1]: https://docs.datadoghq.com/real_user_monitoring/guide/upload-javascript-source-maps/ +[1]: https://docs.datadoghq.com/real_user_monitoring/guide/upload-javascript-source-maps/ \ No newline at end of file diff --git a/packages/datadog-ci/src/commands/sourcemaps/renderer.ts b/packages/datadog-ci/src/commands/sourcemaps/renderer.ts index 09aaf1e1f..ed1edf1db 100644 --- a/packages/datadog-ci/src/commands/sourcemaps/renderer.ts +++ b/packages/datadog-ci/src/commands/sourcemaps/renderer.ts @@ -6,7 +6,7 @@ import chalk from 'chalk' import {Sourcemap} from './interfaces' export const renderGitWarning = (errorMessage: string) => - chalk.yellow(`${ICONS.WARNING} An error occured while invoking git: ${errorMessage} + chalk.yellow(`${ICONS.WARNING} An error occurred while invoking git: ${errorMessage} Make sure the command is running within your git repository to fully leverage Datadog's git integration. To ignore this warning use the --disable-git flag.\n`) diff --git a/packages/datadog-ci/src/commands/unity-symbols/renderer.ts b/packages/datadog-ci/src/commands/unity-symbols/renderer.ts index e916a7d49..acf0eae77 100644 --- a/packages/datadog-ci/src/commands/unity-symbols/renderer.ts +++ b/packages/datadog-ci/src/commands/unity-symbols/renderer.ts @@ -81,7 +81,7 @@ export const renderMissingBuildId = (path: string) => chalk.red(`${ICONS.FAILED} Error: Invalid or missing 'build_id' file. Expected at path ${path}\n`) export const renderGitWarning = (errorMessage: string) => - chalk.yellow(`${ICONS.WARNING} An error occured while invoking git: ${errorMessage} + chalk.yellow(`${ICONS.WARNING} An error occurred while invoking git: ${errorMessage} Make sure the command is running within your git repository to fully leverage Datadog's git integration. To ignore this warning use the --disable-git flag.\n`)