Add Commands for Enhanced Usage Insights (#224)

Author: EyalDelarea

action.yml

@@ -4,7 +4,7 @@ author: "JFrog"
 inputs:
     version:
         description: "JFrog CLI Version"
-        default: "2.68.0"
+        default: "2.71.4"
         required: false
     download-repository:
         description: "Remote repository in Artifactory pointing to 'https://releases.jfrog.io/artifactory/jfrog-cli'. Use this parameter in case you don't have an Internet access."

lib/cleanup.js

@@ -139,6 +139,9 @@ function collectAndPublishBuildInfoIfNeeded() {
         // Publish the build info to Artifactory
         try {
             core.startGroup('Publish the build info to JFrog Artifactory');
+            // Set the environment variable to indicate that the build has been automatically published.
+            // This is used by the usage report to track instances of automatic build publication.
+            core.exportVariable('JFROG_CLI_USAGE_AUTO_BUILD_PUBLISHED', 'TRUE');
             yield utils_1.Utils.runCli(['rt', 'build-publish'], { cwd: workingDirectory });
         }
         catch (error) {

lib/utils.js

@@ -75,7 +75,10 @@ class Utils {
                 throw new Error(`Getting openID Connect JSON web token failed: ${error.message}`);
             }
             try {
-                return yield this.getJfrogAccessTokenThroughOidcProtocol(jfrogCredentials, jsonWebToken, oidcProviderName);
+                jfrogCredentials = yield this.getJfrogAccessTokenThroughOidcProtocol(jfrogCredentials, jsonWebToken, oidcProviderName);
+                // Set environment variable to track OIDC logins in the usage report.
+                core.exportVariable('JFROG_CLI_USAGE_CONFIG_OIDC', 'TRUE');
+                return jfrogCredentials;
             }
             catch (error) {
                 throw new Error(`Exchanging JSON web token with an access token failed: ${error.message}`);

node_modules/.package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@jfrog/setup-jfrog-cli",
-    "version": "4.4.1",
+    "version": "4.4.2",
     "private": true,
     "description": "Setup JFrog CLI in GitHub Actions",
     "main": "lib/main.js",

package-lock.json

@@ -106,6 +106,9 @@ async function collectAndPublishBuildInfoIfNeeded() {
     // Publish the build info to Artifactory
     try {
         core.startGroup('Publish the build info to JFrog Artifactory');
+        // Set the environment variable to indicate that the build has been automatically published.
+        // This is used by the usage report to track instances of automatic build publication.
+        core.exportVariable('JFROG_CLI_USAGE_AUTO_BUILD_PUBLISHED', 'TRUE');
         await Utils.runCli(['rt', 'build-publish'], { cwd: workingDirectory });
     } catch (error) {
         core.warning('Failed while attempting to publish the build info to JFrog Artifactory: ' + error);

package.json

@@ -96,7 +96,10 @@ export class Utils {
         }
 
         try {
-            return await this.getJfrogAccessTokenThroughOidcProtocol(jfrogCredentials, jsonWebToken, oidcProviderName);
+            jfrogCredentials = await this.getJfrogAccessTokenThroughOidcProtocol(jfrogCredentials, jsonWebToken, oidcProviderName);
+            // Set environment variable to track OIDC logins in the usage report.
+            core.exportVariable('JFROG_CLI_USAGE_CONFIG_OIDC', 'TRUE');
+            return jfrogCredentials;
         } catch (error: any) {
             throw new Error(`Exchanging JSON web token with an access token failed: ${error.message}`);
         }