@datadog/datadog-ci 2.18.1 → 2.19.1

package/README.md

@@ -144,16 +144,22 @@ yarn prepack
 To release a new version of `datadog-ci`:
 
 1. Create a new branch for the version upgrade.
-2. Update the `package.json` version, commit the change `vX.X.X` and tag it with `git tag vX.X.X`, based on the version you are upgrading to. You may refer to [Semantic Versioning](https://semver.org/#summary) to determine what level to increment.
-3. Push the branch along with the tag to the upstream (GitHub) with `git push --tags origin name-of-the-branch`, create a Pull Request with the changes introduced in the description details, and get at least one approval. For example, see this [sample pull request](https://github.com/DataDog/datadog-ci/pull/78).
-4. Once you've received at least one approval, merge the Pull Request **with the "Create a merge commit" strategy**.
-5. Create a GitHub Release from the [Tags page](https://github.com/DataDog/datadog-ci/tags) with the description of changes introduced.
-6. Once the release has been created, a GitHub Action publishes the package. Make sure the job succeeds.
-7. When the package has been published, go to the [Datadog GitLab pipelines](https://gitlab.ddbuild.io/DataDog/datadog-ci/-/pipelines), find the pipeline for your tag, and start the `build` stage to run the Docker image build jobs. Once the jobs pass, the `release` stage automatically triggers. Make sure all the jobs succeed.
-8. If the release introduced any **changes in the** `synthetics` **command**, you have to upgrade `datadog-ci` in the following projects:
-   - [GitHub Action](https://github.com/DataDog/synthetics-ci-github-action)
-   - [CircleCI Orb](https://github.com/DataDog/synthetics-test-automation-circleci-orb)
-   - [Azure DevOps Extension](https://github.com/DataDog/datadog-ci-azure-devops)
+2. Update the `package.json` version to `X.X.X`, commit the change `vX.X.X` and tag it with `git tag vX.X.X`.
+   - You may refer to [Semantic Versioning](https://semver.org/#summary) to determine what level to increment.
+4. Push the branch **along with the tag** with `git push --tags origin name-of-the-branch`, create a PR, and get at least one approval.
+   - [Create a draft GitHub Release (prefilled link)](https://github.com/DataDog/datadog-ci/releases/new?title=%3Csame-as-tag%3E&body=%3C!--%20Use%20the%20%22Generate%20release%20notes%22%20button%20at%20the%20top%20right,%20then%20categorize%20the%20changes%20--%3E) and **save it as a draft**.
+   - Please categorize the changes by product or "Documentation" / "Dependencies" / "Chores". You can find commands grouped by product in the [`.github/CODEOWNERS`](https://github.com/DataDog/datadog-ci/blob/master/.github/CODEOWNERS) file.
+   - Copy the categorized release notes, and paste them in the description of your PR. This ensures the feature PRs have a link to your release PR.
+   - See this [example PR](https://github.com/DataDog/datadog-ci/pull/1047).
+5. Once you've received at least one approval, merge the PR **with the "Create a merge commit" strategy**.
+   - You may notice that some **_GitLab_** jobs are pending, this is expected (see **step 7**). You can merge the PR when *only those jobs* are left.
+   - The "Create a merge commit" strategy is required for **step 7**, and for the GitHub Release to point to an existing commit once the PR is merged.
+6. Go back to your draft GitHub Release, and publish it.
+7. Once the release is published, [this GitHub Workflow](https://github.com/DataDog/datadog-ci/actions/workflows/release.yml) publishes the NPM package and adds binaries to the release's assets. Wait for it to succeed.
+8. When the NPM package is published, go to the [_GitLab_ pipelines](https://gitlab.ddbuild.io/DataDog/datadog-ci/-/pipelines?scope=tags&status=manual), find the pipeline for your tag, and start the `build` stage to run the Docker image build jobs.
+   - Make sure all the jobs and downstream jobs succeed.
+
+Thanks for creating a release! 🎉
 
 </details>
 

package/dist/cli.d.ts

@@ -1 +1,3 @@
-export {};
+import { Cli } from 'clipanion';
+declare const cli: Cli<import("clipanion").BaseContext>;
+export { cli };

package/dist/cli.js

@@ -4,9 +4,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.cli = void 0;
 const fs_1 = __importDefault(require("fs"));
 const clipanion_1 = require("clipanion");
-const BETA_COMMANDS = ['gate'];
+const version_1 = require("./helpers/version");
+const BETA_COMMANDS = ['gate', 'sbom'];
 const onError = (err) => {
     console.log(err);
     process.exitCode = 1;
@@ -16,8 +18,11 @@ process.on('unhandledRejection', onError);
 const cli = new clipanion_1.Cli({
     binaryLabel: 'Datadog CI',
     binaryName: 'datadog-ci',
-    binaryVersion: require('../package.json').version,
+    binaryVersion: version_1.version,
 });
+exports.cli = cli;
+cli.register(clipanion_1.Builtins.HelpCommand);
+cli.register(clipanion_1.Builtins.VersionCommand);
 const commandsPath = `${__dirname}/commands`;
 for (const commandFolder of fs_1.default.readdirSync(commandsPath)) {
     const betaCommandsEnabled = process.env.DD_BETA_COMMANDS_ENABLED === '1' || process.env.DD_BETA_COMMANDS_ENABLED === 'true';
@@ -26,6 +31,8 @@ for (const commandFolder of fs_1.default.readdirSync(commandsPath)) {
     }
     const commandPath = `${commandsPath}/${commandFolder}`;
     if (fs_1.default.statSync(commandPath).isDirectory()) {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        ;
         require(`${commandPath}/cli`).forEach((command) => cli.register(command));
     }
 }

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;AAAA,4CAAmB;AAEnB,yCAA6B;AAG7B,MAAM,aAAa,GAAG,CAAC,MAAM,CAAC,CAAA;AAE9B,MAAM,OAAO,GAAG,CAAC,GAAQ,EAAE,EAAE;IAC3B,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAChB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAA;AACtB,CAAC,CAAA;AAED,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAA;AACxC,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAA;AAEzC,MAAM,GAAG,GAAG,IAAI,eAAG,CAAC;IAClB,WAAW,EAAE,YAAY;IACzB,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC,OAAO;CAClD,CAAC,CAAA;AAEF,MAAM,YAAY,GAAG,GAAG,SAAS,WAAW,CAAA;AAC5C,KAAK,MAAM,aAAa,IAAI,YAAE,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE;IACxD,MAAM,mBAAmB,GACvB,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,MAAM,CAAA;IACjG,IAAI,aAAa,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,mBAAmB,EAAE;QACjE,SAAQ;KACT;IACD,MAAM,WAAW,GAAG,GAAG,YAAY,IAAI,aAAa,EAAE,CAAA;IACtD,IAAI,YAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,EAAE;QAC1C,OAAO,CAAC,GAAG,WAAW,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,OAAqB,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAA;KACxF;CACF;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,KAAK,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;QACtC,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAA;CACH"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAmB;AAEnB,yCAAuC;AAGvC,+CAAyC;AAEzC,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAEtC,MAAM,OAAO,GAAG,CAAC,GAAQ,EAAE,EAAE;IAC3B,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAChB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAA;AACtB,CAAC,CAAA;AAED,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAA;AACxC,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAA;AAEzC,MAAM,GAAG,GAAG,IAAI,eAAG,CAAC;IAClB,WAAW,EAAE,YAAY;IACzB,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,iBAAO;CACvB,CAAC,CAAA;AA2BM,kBAAG;AAzBX,GAAG,CAAC,QAAQ,CAAC,oBAAQ,CAAC,WAAW,CAAC,CAAA;AAClC,GAAG,CAAC,QAAQ,CAAC,oBAAQ,CAAC,cAAc,CAAC,CAAA;AAErC,MAAM,YAAY,GAAG,GAAG,SAAS,WAAW,CAAA;AAC5C,KAAK,MAAM,aAAa,IAAI,YAAE,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE;IACxD,MAAM,mBAAmB,GACvB,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,MAAM,CAAA;IACjG,IAAI,aAAa,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,mBAAmB,EAAE;QACjE,SAAQ;KACT;IACD,MAAM,WAAW,GAAG,GAAG,YAAY,IAAI,aAAa,EAAE,CAAA;IACtD,IAAI,YAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,EAAE;QAC1C,8DAA8D;QAC9D,CAAC;QAAC,OAAO,CAAC,GAAG,WAAW,MAAM,CAAoB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAA;KAC/F;CACF;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,KAAK,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;QACtC,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAA;CACH"}

package/dist/commands/cloud-run/flare.d.ts

@@ -6,20 +6,24 @@ import { Command } from 'clipanion';
 import { CloudRunLog } from './interfaces';
 export declare const MAX_LOGS = 1000;
 export declare class CloudRunFlareCommand extends Command {
+    static paths: string[][];
+    static usage: import("clipanion").Usage;
     private isDryRun;
     private withLogs;
-    private service?;
-    private project?;
-    private region?;
-    private caseId?;
-    private email?;
+    private service;
+    private project;
+    private region;
+    private caseId;
+    private email;
+    private start;
+    private end;
     private apiKey?;
     /**
      * Entry point for the `cloud-run flare` command.
      * Gathers Cloud Run service configuration and sends it to Datadog.
      * @returns 0 if the command ran successfully, 1 otherwise.
      */
-    execute(): Promise<1 | 0>;
+    execute(): Promise<0 | 1>;
 }
 /**
  * Check if the user is authenticated with GCP.
@@ -43,18 +47,45 @@ export declare const getCloudRunServiceConfig: (runClient: ServicesClient, servi
  * @returns masked config
  */
 export declare const maskConfig: (config: any) => IService;
+/**
+ * Summarizes the Cloud Run config as to not flood the terminal
+ * @param config
+ * @returns a summarized config
+ */
+export declare const summarizeConfig: (config: IService) => any;
 /**
  * Gets recent logs
  * @param logClient Logging client
  * @param serviceId
  * @param location
+ * @param startMillis start time in milliseconds or undefined if no start time is specified
+ * @param endMillis end time in milliseconds or undefined if no end time is specified
  * @param severityFilter if included, adds the string to the filter
  * @returns array of logs as CloudRunLog interfaces
  */
-export declare const getLogs: (logClient: Logging, serviceId: string, location: string, severityFilter?: string | undefined) => Promise<CloudRunLog[]>;
+export declare const getLogs: (logClient: Logging, serviceId: string, location: string, startMillis?: number, endMillis?: number, severityFilter?: string) => Promise<CloudRunLog[]>;
 /**
  * Save logs in a CSV format
  * @param logs array of logs stored as CloudRunLog interfaces
  * @param filePath path to save the CSV file
  */
 export declare const saveLogsFile: (logs: CloudRunLog[], filePath: string) => void;
+/**
+ * Gets recent revisions for a cloud-run service
+ * @param service
+ * @param location
+ * @param project
+ * @returns a string array of recent revisions and their deployment timestamp
+ */
+export declare const getRecentRevisions: (service: string, location: string, project: string) => Promise<string[]>;
+/**
+ * Generate the insights file
+ * @param insightsFilePath path to the insights file
+ * @param isDryRun whether or not this is a dry run
+ * @param config Cloud run service configuration
+ * @param service
+ * @param location
+ * @param project
+ * @param revisions a string array of recent revisions
+ */
+export declare const generateInsightsFile: (insightsFilePath: string, isDryRun: boolean, config: IService, service: string, location: string, project: string, revisions: string[]) => void;