@shopify/oxygen-cli 1.10.4-unstable.20230830.0 → 1.11.1-unstable.20230830.0

package/README.md

@@ -45,11 +45,12 @@ oxygen:deploy [options]
 - -h, --skipHealthCheck: Skip running the health check on the deployment
 - -d, --healthCheckMaxDuration: The maximum duration (in seconds) that the health check is allowed to run before it is considered failed. Accepts values between 10 and 300.
 - --publicDeployment: set the deployment to be publicly accessible.
+- --metadataDescription <metadataDescription>: A brief description of the deployment, typically the commit message associated with the changes being deployed.
 - --metadataUrl <metadataUrl>: URL that links to the deployment.
 - --metadataUser <metadataUser>: User that initiated the deployment.
 - --metadataVersion <metadataVersion>: A version identifier for the deployment.
 
-**Note**: All metadata options (--metadataUrl, --metadataUser, and --metadataVersion) have a maximum character limit of 90.
+**Note**: All metadata options (--metadataDescription, --metadataUrl, --metadataUser, and --metadataVersion) have a maximum character limit of 85.
 
 ### Example:
 
@@ -78,10 +79,12 @@ The following environment variables are relevant, depending on your environment:
 |- | --------- | --------| ------ | ------ |
 | User | BITBUCKET_COMMIT_AUTHOR | CIRCLE_USERNAME | GITHUB_ACTOR | GITLAB_USER_LOGIN |
 | Version | BITBUCKET_COMMIT | CIRCLE_SHA1 | GITHUB_SHA | CI_COMMIT_SHA |
-| URL | BITBUCKET_BUILD_URL | CIRCLE_BUILD_URL | `${GITHUB_SERVER_URL}${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}` | CI_PROJECT_URL |
+| URL | BITBUCKET_BUILD_URL | CIRCLE_BUILD_URL | `${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}` | CI_PROJECT_URL |
 
 These values can be overridden by the command line flags `metadataUser`, `metadataUrl` and `metadataVersion` respectively.
 
+`oxygen-cli` Will also attempt to execute `git log` in your project folder to retrieve commit data. This allows the commit message and date to be saved and displayed in the Shopify Admin. If desired, the commit message can be overridden using the `--metadataDescription` command line flag.
+
 The environment tag to deploy to will be derived from the following variables:
 
 | Service | Branch |

package/dist/commands/oxygen/deploy.d.ts

@@ -16,6 +16,7 @@ declare class Deploy extends Command {
         token: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         workerFolder: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         workerOnly: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
+        metadataDescription: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         metadataUrl: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         metadataUser: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         metadataVersion: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;

package/dist/commands/oxygen/deploy.js

@@ -80,6 +80,11 @@ class Deploy extends Command {
       default: false,
       required: false
     }),
+    metadataDescription: Flags.string({
+      description: "Description of the deployment. Will be saved and displayed in the Shopify admin",
+      required: false,
+      env: "OXYGEN_METADATA_DESCRIPTION"
+    }),
     metadataUrl: Flags.string({
       description: "URL that links to the deployment. Will be saved and displayed in the Shopify admin",
       required: false,
@@ -112,6 +117,7 @@ class Deploy extends Command {
         deploymentUrl,
         healthCheckMaxDuration: flags.healthCheckMaxDuration,
         metadata: {
+          description: flags.metadataDescription,
           url: flags.metadataUrl,
           user: flags.metadataUser,
           version: flags.metadataVersion

package/dist/deploy/metadata.d.ts

@@ -3,7 +3,8 @@ import { Logger } from '@shopify/cli-kit/node/output';
 import { DeploymentConfig, EnvironmentInput } from './types.js';
 
 type Metadata = CIMetadata & {
-    name: string;
+    commitDate?: string;
+    name?: string;
 };
 declare function getMetadata(config: DeploymentConfig, logger: Logger): Promise<Metadata>;
 declare function getEnvironmentInput(config: DeploymentConfig, metadata: CIMetadata): EnvironmentInput | undefined;

package/dist/deploy/metadata.js

@@ -6,26 +6,33 @@ import { maxLabelLength } from '../utils/utils.js';
 async function getMetadata(config, logger) {
   const ciInfo = ciPlatform();
   let metadata = {};
+  try {
+    const gitCommit = await getLatestGitCommit(config.rootPath);
+    const branch = gitCommit.refs.split(" ");
+    metadata = {
+      actor: gitCommit.author_name,
+      branch: branch[branch.length - 1],
+      commitDate: gitCommit.date,
+      commitSha: gitCommit.hash,
+      commitMessage: gitCommit.message.substring(0, maxLabelLength)
+    };
+  } catch (error) {
+    outputWarn(
+      "Could not retrieve Git history, commit message will be unavailable.",
+      logger
+    );
+  }
   if (ciInfo.isCI && ciInfo.name !== "unknown") {
-    metadata = ciInfo.metadata;
-  } else {
-    try {
-      const gitCommit = await getLatestGitCommit(config.rootPath);
-      const branch = gitCommit.refs.split(" ");
-      metadata = {
-        actor: gitCommit.author_name,
-        branch: branch[branch.length - 1],
-        commitSha: gitCommit.hash,
-        commitMessage: gitCommit.message
-      };
-    } catch (error) {
-      outputWarn("No CI metadata loaded from environment", logger);
-    }
+    metadata = {
+      ...metadata,
+      ...ciInfo.metadata
+    };
   }
   return {
     name: ciInfo.isCI ? ciInfo.name : "none",
     ...metadata,
     actor: config.metadata.user ?? metadata.actor,
+    commitMessage: config.metadata.description ?? metadata.commitMessage,
     commitSha: config.metadata.version ?? metadata.commitSha,
     url: config.metadata.url ?? metadata.url
   };
@@ -62,6 +69,8 @@ function createLabels(metadata) {
   const keyMapping = {
     actor: "user",
     branch: "branch",
+    commitDate: "commit-date",
+    commitMessage: "description",
     commitSha: "version",
     url: "url"
   };

package/dist/deploy/metadata.test.js

@@ -64,6 +64,8 @@ describe("getMetadata", () => {
     const metadataResult = await getMetadata(testConfig, stderrLogger);
     expect(metadataResult.actor).toBe("gh_author");
     expect(metadataResult.commitSha).toBe("gh_hash");
+    expect(metadataResult.commitDate).toBe("gh_date");
+    expect(metadataResult.commitMessage).toBe("gh_message");
     expect(metadataResult.name).toBe("none");
     expect(metadataResult.url).toBe(void 0);
   });

package/dist/deploy/types.d.ts

@@ -22,6 +22,7 @@ interface DeploymentConfig {
     environmentTag?: string;
     healthCheckMaxDuration: number;
     metadata: {
+        description?: string;
         user?: string;
         version?: string;
         url?: string;

package/dist/utils/utils.d.ts

@@ -10,7 +10,7 @@ declare enum Header {
 }
 declare function isClientError(error: unknown): error is ClientError;
 declare function stderrLogger(log: string): void;
-declare const maxLabelLength = 90;
+declare const maxLabelLength = 85;
 declare function parseToken(inputToken: string): DeploymentToken;
 interface VerifyConfigParams {
     config: DeploymentConfig;

package/dist/utils/utils.js

@@ -71,7 +71,7 @@ function stderrLogger(log) {
   process.stderr.write(`${log}
 `);
 }
-const maxLabelLength = 90;
+const maxLabelLength = 85;
 function parseToken(inputToken) {
   try {
     const decodedToken = Buffer.from(inputToken, "base64").toString("utf-8");

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.10.4-unstable.20230830.0",
+  "version": "1.11.1-unstable.20230830.0",
   "commands": {
     "oxygen:deploy": {
       "id": "oxygen:deploy",
@@ -103,6 +103,13 @@
           "required": false,
           "allowNo": false
         },
+        "metadataDescription": {
+          "name": "metadataDescription",
+          "type": "option",
+          "description": "Description of the deployment. Will be saved and displayed in the Shopify admin",
+          "required": false,
+          "multiple": false
+        },
         "metadataUrl": {
           "name": "metadataUrl",
           "type": "option",

package/package.json

@@ -5,7 +5,7 @@
     "@shopify:registry": "https://registry.npmjs.org"
   },
   "license": "MIT",
-  "version": "1.10.4-unstable.20230830.0",
+  "version": "1.11.1-unstable.20230830.0",
   "type": "module",
   "scripts": {
     "build": "tsup --clean --config ./tsup.config.ts && oclif manifest",