Installations
npm install @bufferapp/datadog-ciDeveloper Guide
Typescript
No
Module System
CommonJS
Min. Node Version
>=10.24.1
Node Version
14.16.1
NPM Version
6.14.12
Score
50
Supply Chain
86.9
Quality
76.4
Maintenance
25
Vulnerability
80.7
License
Releases
Contributors
Languages
TypeScript (99.02%)
JavaScript (0.96%)
Shell (0.01%)
Dockerfile (0.01%)
validate.email 🚀
Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.
Developer
Download Statistics
Total Downloads
614
Last Day
1
Last Week
2
Last Month
5
Last Year
102
GitHub Statistics
Apache-2.0 License
135 Stars
4,129 Commits
59 Forks
548 Watchers
101 Branches
370 Contributors
Updated on Mar 12, 2025
Bundle Size
48.83 kB
Minified
16.20 kB
Minified + Gzipped
Maintainers
Package Meta Information
Latest Version
0.13.4
Package Id
@bufferapp/datadog-ci@0.13.4
Unpacked Size
388.22 kB
Size
69.12 kB
File Count
73
NPM Version
6.14.12
Node Version
14.16.1
Total Downloads
Cumulative downloads
Total Downloads
614
Last Day
0%
1
Compared to previous day
Last Week
0%
2
Compared to previous week
Last Month
-66.7%
5
Compared to previous month
Last Year
-39.6%
102
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
18
Dev Dependencies
23
Datadog CI
Execute commands with Datadog from within your Continuous Integration/Continuous Deployment scripts. A good way to perform end to end tests of your application before applying you changes or deploying. It currently features running synthetics tests and waiting for the results.
How to install the CLI
The package is under @datadog/datadog-ci and can be installed through NPM or Yarn:
1# NPM 2npm install --save-dev @datadog/datadog-ci 3 4# Yarn 5yarn add --dev @datadog/datadog-ci
Usage
1Usage: datadog-ci <command> <subcommand> [options] 2 3Available command: 4 - dependencies 5 - lambda 6 - sourcemaps 7 - synthetics
Each command allows interacting with a product of the Datadog platform. The commands are defined in the src/commands folder.
Further documentation for each command can be found in its folder, ie:
Contributing
Pull requests for bug fixes are welcome, but before submitting new features or changes to current functionality open an issue and discuss your ideas or propose the changes you wish to make. After a resolution is reached a PR can be submitted for review.
Running command in development environment
When developing the tool it is possible to run commands using yarn launch. It relies on ts-node so does not need building the project for every new change.
1yarn launch synthetics run-tests --config dev/global.config.json
Framework and libraries used
This tool uses clipanion to handle the different commands.
The tests are written using jest.
The coding style is checked with tslint and the configuration can be found in the tslint.json file.
Repository structure
Commands are stored in the src/commands folder.
The skeleton of a command is composed of a README, an index.ts and a folder for the tests.
1src/ 2└── commands/ 3 └── fakeCommand/ 4 ├── __tests__/ 5 │ └── index.test.ts 6 ├── README.md 7 └── index.ts
Documentation of the command must be placed in the README.md file, the current README must be updated to link to the new command README.
The index.ts file must export classes extending the Command class of clipanion. The commands of all src/commands/*/index.ts files will then be imported and made available in the datadog-ci tool.
A sample index.ts file for a new command would be:
1import {Command} from 'clipanion' 2 3export class HelloWorldCommand extends Command { 4 public async execute() { 5 this.context.stdout.write('Hello world!') 6 } 7} 8 9module.exports = [HelloWorldCommand]
Lastly, test files must be created in the __tests__/ folder. jest is used to run the tests and a CI has been set using Github Actions to ensure all tests are passing when merging a Pull Request.
The tests can then be launched through the yarn test command, it will find all files with a filename ending in .test.ts in the repo and execute them.
Continuous Integration tests
The CI performs tests to avoid regressions by building the project, running unit tests and running one end-to-end test.
The end-to-end test installs the package in a new project, configures it (using files in the .github/workflows/e2e folder) and runs a synthetics run-tests command in a Datadog Org (Synthetics E2E Testing Org) to verify the command is able to perform a test.
The synthetics tests ran are a browser test (id neg-qw9-eut) and an API test (id v5u-56k-hgk), both loading a page which outputs the headers of the request and verifying the X-Fake-Header header is present. This header is configured as an override in the .github/workflows/e2e/test.synthetics.json file. The API and Application keys used by the command are stored in Github Secrets named datadog_api_key and datadog_app_key.
The goal of this test is to verify the command is able to run tests and wait for their results as expected as well as handling configuration overrides.
Workflow
1# Compile and watch 2yarn watch 3 4# Run the tests 5yarn jest 6 7# Build code 8yarn build 9 10# Format code 11yarn format 12 13# Make bin executable 14yarn prepack
Release Process
Releasing a new version of datadog-ci unfolds as follow:
- create a new branch for the version upgrade
- update the version using
yarn version [--patch|--minor|--major]depending on the nature of the changes introduced. You may refer to Semantic Versioning to determine which to increment. - push the branch along with the tag to the upstream (Github), create a Pull Request with the changes introduced detailed in the description and get at least one approval. (sample Pull Request)
- merge the Pull Request
- create a Github Release from the Tags page with the description of changes introduced
- Once the release has been created, a Github Action will publish the package
Pre-Release Process
If you need to create a pre-release or releasing in a different channel here's how it works:
- create a new branch for the channel you want to release to (
alpha,beta, ...). - create a PR for your feature branch with the channel branch as a base.
- pick a version following this format
version-channel, it can be0.10.9-alphaor1-beta... - merge the Pull Request
- create a Github Release:
- target the channel branch
- pick a tag based on your version
version-channel - check the
This is a pre-releasecheckbox
- publish the release and an action will publish it on npm
License
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
all changesets reviewed
Reason
30 commit(s) and 4 issue activity found in the last 90 days -- score normalized to 10
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
2 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6
- Warn: Project is vulnerable to: GHSA-22r3-9w55-cj54
Reason
branch protection is not maximal on development and all release branches
Details
- Info: 'allow deletion' disabled on branch 'master'
- Info: 'force pushes' disabled on branch 'master'
- Warn: 'branch protection settings apply to administrators' is disabled on branch 'master'
- Warn: 'stale review dismissal' is disabled on branch 'master'
- Warn: required approving review count is 1 on branch 'master'
- Info: codeowner review is required on branch 'master'
- Warn: 'last push approval' is disabled on branch 'master'
- Warn: no status checks found to merge onto branch 'master'
- Info: PRs are required in order to make changes on branch 'master'
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Info: topLevel 'contents' permission set to 'read': .github/workflows/issue-labeler.yml:6
- Warn: no topLevel permission defined: .github/workflows/pr-required-labels.yml:1
- Warn: no topLevel permission defined: .github/workflows/publish-prerelease.yml:1
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/publish-release.yml:9
- Info: no jobLevel write permissions found
Reason
binaries present in source code
Details
- Warn: binary detected: src/commands/dsyms/__tests__/fixtures/multiple-archs/DDTest.framework.dSYM/Contents/Resources/DWARF/DDTest:1
- Warn: binary detected: src/commands/dsyms/__tests__/fixtures/single-arch/DDTest.framework.dSYM/Contents/Resources/DWARF/DDTest:1
- Warn: binary detected: src/commands/elf-symbols/__tests__/fixtures/.debug/dyn_aarch64.debug:1
- Warn: binary detected: src/commands/elf-symbols/__tests__/fixtures/dyn_aarch64:1
- Warn: binary detected: src/commands/elf-symbols/__tests__/fixtures/dyn_aarch64_nobuildid:1
- Warn: binary detected: src/commands/elf-symbols/__tests__/fixtures/dyn_x86_64:1
- Warn: binary detected: src/commands/elf-symbols/__tests__/fixtures/exec_aarch64:1
- Warn: binary detected: src/commands/elf-symbols/__tests__/fixtures/exec_arm_big:1
- Warn: binary detected: src/commands/elf-symbols/__tests__/fixtures/exec_arm_little:1
- Warn: binary detected: src/commands/elf-symbols/__tests__/fixtures/go_x86_64_both_gnu_and_go_build_id:1
- Warn: binary detected: src/commands/elf-symbols/__tests__/fixtures/go_x86_64_only_go_build_id:1
- Warn: binary detected: src/commands/elf-symbols/__tests__/fixtures/go_x86_64_only_go_build_id.debug:1
- Warn: binary detected: src/commands/flutter-symbols/__tests__/fixtures/dart-symbols/app.android-arm.symbols:1
- Warn: binary detected: src/commands/flutter-symbols/__tests__/fixtures/dart-symbols/app.android-arm64.symbols:1
- Warn: binary detected: src/commands/flutter-symbols/__tests__/fixtures/dart-symbols/app.android-x64.symbols:1
- Warn: binary detected: src/commands/flutter-symbols/__tests__/fixtures/dart-symbols/app.ios-arm64.symbols:1
- Warn: binary detected: src/commands/unity-symbols/__tests__/fixtures/androidSymbols/arm64-v8a/libmain.so:1
- Warn: binary detected: src/commands/unity-symbols/__tests__/fixtures/androidSymbols/arm64-v8a/libunity.so:1
- Warn: binary detected: src/commands/unity-symbols/__tests__/fixtures/androidSymbols/armeabi-v7a/libmain.so:1
- Warn: binary detected: src/commands/unity-symbols/__tests__/fixtures/androidSymbols/armeabi-v7a/libunity.so:1
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact v3.1.0 not signed: https://api.github.com/repos/DataDog/datadog-ci/releases/204744225
- Warn: release artifact v3.0.2 not signed: https://api.github.com/repos/DataDog/datadog-ci/releases/203815357
- Warn: release artifact v3.0.1 not signed: https://api.github.com/repos/DataDog/datadog-ci/releases/202576393
- Warn: release artifact v3.0.0 not signed: https://api.github.com/repos/DataDog/datadog-ci/releases/202377829
- Warn: release artifact v2.48.0 not signed: https://api.github.com/repos/DataDog/datadog-ci/releases/195654043
- Warn: release artifact v3.1.0 does not have provenance: https://api.github.com/repos/DataDog/datadog-ci/releases/204744225
- Warn: release artifact v3.0.2 does not have provenance: https://api.github.com/repos/DataDog/datadog-ci/releases/203815357
- Warn: release artifact v3.0.1 does not have provenance: https://api.github.com/repos/DataDog/datadog-ci/releases/202576393
- Warn: release artifact v3.0.0 does not have provenance: https://api.github.com/repos/DataDog/datadog-ci/releases/202377829
- Warn: release artifact v2.48.0 does not have provenance: https://api.github.com/repos/DataDog/datadog-ci/releases/195654043
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:136: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:138: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:222: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:224: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:243: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:246: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:277: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:279: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:79: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:158: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:160: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:180: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:182: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:202: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:204: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:260: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:263: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/issue-labeler.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/issue-labeler.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/issue-labeler.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/issue-labeler.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/issue-labeler.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/issue-labeler.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-required-labels.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/pr-required-labels.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-prerelease.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-prerelease.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-prerelease.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-prerelease.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:237: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:238: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:261: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:87: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:107: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:125: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:127: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:143: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:163: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:165: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:181: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:199: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:201: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:217: update your workflow using https://app.stepsecurity.io/secureworkflow/DataDog/datadog-ci/publish-release.yml/master?enable=pin
- Warn: containerImage not pinned by hash: container/Dockerfile:1: pin your Docker image by updating alpine to alpine@sha256:a8560b36e8b8210634f77d9f7f9efd7ffa463e380b75e2e74aff4511df3ef88c
- Warn: npmCommand not pinned by hash: container/Dockerfile:7-8
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:164
- Warn: npmCommand not pinned by hash: .github/workflows/publish-release.yml:93
- Info: 0 out of 43 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 5 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 containerImage dependencies pinned
- Info: 0 out of 3 npmCommand dependencies pinned
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 30 are checked with a SAST tool
Score
4.3
/10
Last Scanned on 2025-03-10
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More