feat: add optional commit ID to reporter configuration (#31)

Author: adimoldovan

README.md

@@ -122,6 +122,7 @@ reporter: [
         repositoryName: "ctrf-json",    // Optional: Specify the repository name.
         repositoryUrl: "https://gh.io", // Optional: Specify the repository url.
         branchName: "main",             // Optional: Specify the branch name.
+        commit: "abc123",               // Optional: Specify the commit id.
         testEnvironment: "staging"      // Optional: Specify the test environment (e.g. staging, production).
     }]
   ],

src/generate-report.ts

@@ -38,6 +38,7 @@ interface ReporterConfigOptions {
   repositoryName?: string | undefined
   repositoryUrl?: string | undefined
   branchName?: string | undefined
+  commit?: string | undefined
   testEnvironment?: string | undefined
 }
 
@@ -70,6 +71,7 @@ class GenerateCtrfReport implements Reporter {
       repositoryName: config?.repositoryName ?? undefined,
       repositoryUrl: config?.repositoryUrl ?? undefined,
       branchName: config?.branchName ?? undefined,
+      commit: config?.commit ?? undefined,
       testEnvironment: config?.testEnvironment ?? undefined,
     }
 
@@ -320,6 +322,9 @@ class GenerateCtrfReport implements Reporter {
     if (reporterConfigOptions.branchName !== undefined) {
       this.ctrfEnvironment.branchName = reporterConfigOptions.branchName
     }
+    if (reporterConfigOptions.commit !== undefined) {
+      this.ctrfEnvironment.commit = reporterConfigOptions.commit
+    }
     if (reporterConfigOptions.testEnvironment !== undefined) {
       this.ctrfEnvironment.testEnvironment =
         reporterConfigOptions.testEnvironment

types/ctrf.d.ts

@@ -76,6 +76,7 @@ export interface CtrfEnvironment {
   repositoryName?: string
   repositoryUrl?: string
   branchName?: string
+  commit?: string
   testEnvironment?: string
   extra?: Record<string, any>
 }