conformance wip

.github/actions/specs-report/action.yml

@@ -7,10 +7,10 @@ inputs:
     description:
       'Glob Path with the JUnit test vectors report, can be a single path or a
       list of paths in an array'
-    required: true
+    required: true # required if release-mode is "none"
   spec-path:
     description: 'The relative path to the tbd spec submodule folder'
-    required: true
+    required: true # required if release-mode is "none"
   suite-name-regex:
     description: 'The regex to filter the suite name'
     required: false
@@ -33,6 +33,13 @@ inputs:
   fail-on-failed-test-cases:
     description: 'Whether to fail the job if failed test cases are found'
     required: false
+  release-mode:
+    description: 'Set to "spec" or "sdk" to handle release updates'
+    required: false
+    default: 'none'
+  spec-release-tag:
+    description: 'The tag of the spec release'
+    required: false # required if release-mode is "spec"
 
 # Define your outputs here.
 outputs:

.github/actions/specs-report/package.json

@@ -80,6 +80,7 @@
     "prettier": "^3.3.3",
     "prettier-eslint": "^16.3.0",
     "ts-jest": "^29.2.4",
+    "ts-node": "^10.9.2",
     "typescript": "^5.5.4"
   }
 }

.github/actions/specs-report/src/action-inputs.ts

@@ -19,36 +19,72 @@ export interface ActionInputs {
   failOnMissingVectors: boolean
   /** Whether to fail the job if failed test cases are found */
   failOnFailedTestCases: boolean
+  /** The release mode to handle conformance dashboard */
+  releaseMode: string
+  /** The release repo, eg: TBD54566975/web5-spec for spec releases, TBD54566975/web5-rs */
+  releaseRepo: string
+  /** The tag of the release */
+  releaseTag: string
+  /** The name of the spec, eg: web5-spec */
+  specName: string
+  /** The tag of the spec, eg: v2.0 */
+  specTag: string
 }
 
 /**
  * Reads the inputs for the action.
  * @returns {ActionInputs} The inputs for the action.
  */
 export const readActionInputs = (): ActionInputs => {
+  const releaseMode = core.getInput('release-mode') || 'none'
+  const isDefaultReport = releaseMode === 'none'
+  const isReleaseMode = releaseMode === 'spec' || releaseMode === 'sdk'
+
   const junitReportPaths = core.getInput('junit-report-paths', {
-    required: true
+    required: isDefaultReport
   })
-  const specPath = core.getInput('spec-path', { required: true })
+  const specPath = core.getInput('spec-path', { required: isDefaultReport })
+
   // Fallback to the default tbdex-js regex filters if not provided
   const suiteRegexStrFilters = {
     suiteName: core.getInput('suite-name-regex') || 'TbdexTestVector',
     feature: core.getInput('feature-regex') || 'TbdexTestVectors(\\w+)',
     vector: core.getInput('vector-regex') || 'TbdexTestVectors(\\w+) (\\w+)'
   }
+
   const gitToken = core.getInput('git-token')
   const commentOnPr = core.getInput('comment-on-pr') === 'true'
   const failOnMissingVectors =
     core.getInput('fail-on-missing-vectors') === 'true'
   const failOnFailedTestCases =
     core.getInput('fail-on-failed-test-cases') === 'true'
+
+  const releaseRepo = core.getInput('release-repo', {
+    required: isReleaseMode
+  })
+  const releaseTag = core.getInput('release-tag', {
+    required: releaseMode === 'sdk'
+  })
+
+  const specName = core.getInput('spec-name', {
+    required: isReleaseMode
+  })
+  const specTag = core.getInput('spec-tag', {
+    required: isReleaseMode
+  })
+
   return {
     junitReportPaths,
     specPath,
     suiteRegexStrFilters,
     gitToken,
     commentOnPr,
     failOnMissingVectors,
-    failOnFailedTestCases
+    failOnFailedTestCases,
+    releaseMode,
+    releaseRepo,
+    releaseTag,
+    specName,
+    specTag
   }
 }