Migrating code.json validation to Zod with tests (#100)

* added archival option

* changed workflow to archive

* reverting archive option

* testing null status key

* added back archive to a null status field

* reverting workflow file

* reverting code.json

* reverting version

* fixed syntax

* added tags logic

* created new test file and restructed directories

Author: sachin-panayil

.github/workflows/updateCodeJSON.yml

@@ -4,7 +4,7 @@ on:
   pull_request:
     types: [opened, synchronize]
     paths:
-      - 'code.json'
+      - "code.json"
 
 permissions:
   contents: write

README.md

@@ -1,4 +1,5 @@
 # Code.json Auto Generator
+
 ###### _⚠️ Please update your action to v1.2.1 if your workflow is failing due to Docker builds within the action ⚠️_
 
 A GitHub Action that automatically generates and maintains code.json files for federal open source repositories, ensuring schema consistency and automating metadata calculations.
@@ -32,19 +33,22 @@ This approach tries to push directly to the branch using a Personal Access Token
 #### Direct Push Mode Limitations
 
 **Important:** Direct push mode (`SKIP_PR: "true"`) will fall back to creating a pull request if:
+
 - Branch protection rules are enabled on the target branch
 - The PAT doesn't have sufficient permissions
 - Any other push restriction exists
 
 This is expected behavior. If you need all updates to go through pull requests, use `SKIP_PR: "false"`.
 
 ##### When Direct Push Works
+
 - No branch protection on target branch
 - PAT has write access
 - No other repository restrictions
 
 ##### When It Falls Back to PR
-- Any branch protection enabled 
+
+- Any branch protection enabled
 - Any push restrictions
 
 **Recommendation:** For repositories with branch protection, use `SKIP_PR: "false"` to always create pull requests.
@@ -181,7 +185,7 @@ To use the direct push functionality, you'll need to create a Personal Access To
 5. **Configure Token**:
    - **Name**: Give it a name like "code.json Generator"
    - **Expiration**: Set appropriate expiration (recommend 90 days or 1 year)
-   - **Scopes**: 
+   - **Scopes**:
      - For classic tokens: Select `repo` (full repository access)
      - For fine-grained tokens: Select `Contents` (write) and `Metadata` (read)
 6. **Copy the generated token**: Copy the token and keep it handy for the next section

__fixtures__/core.ts

@@ -28,19 +28,10 @@
     "forks": 4,
     "clones": 0
   },
-  "platforms": [
-    "web",
-    "linux"
-  ],
-  "categories": [
-    "developer-tools",
-    "automation"
-  ],
+  "platforms": ["web", "linux"],
+  "categories": ["developer-tools", "automation"],
   "softwareType": "standalone/backend",
-  "languages": [
-    "TypeScript",
-    "JavaScript"
-  ],
+  "languages": ["TypeScript", "JavaScript"],
   "maintenance": "internal",
   "contractNumber": [],
   "SBOM": "https://github.com/DSACMS/automated-codejson-generator/network/dependencies",
@@ -72,15 +63,9 @@
   "userInput": false,
   "fismaLevel": "low",
   "group": "CMS/OA/DSAC",
-  "projects": [
-    "share-it-act"
-  ],
+  "projects": ["share-it-act"],
   "systems": [],
-  "subsetInHealthcare": [
-    "operational"
-  ],
-  "userType": [
-    "government"
-  ],
+  "subsetInHealthcare": ["operational"],
+  "userType": ["government"],
   "maturityModelTier": 3
 }

__tests__/main.test.ts

@@ -0,0 +1,56 @@
+{
+  "name": "automated-codejson-generator",
+  "version": "1.0.0",
+  "description": "A GitHub Action that generates code.json files",
+  "longDescription": "This action helps federal agencies maintain code.json files for compliance.",
+  "status": "Production",
+  "permissions": {
+    "licenses": [
+      {
+        "name": "CC0 1.0 Universal",
+        "URL": "https://creativecommons.org/publicdomain/zero/1.0/"
+      }
+    ],
+    "usageType": ["openSource"],
+    "exemptionText": ""
+  },
+  "organization": "DSACMS",
+  "repositoryURL": "https://github.com/DSACMS/automated-codejson-generator",
+  "repositoryHost": "github",
+  "repositoryVisibility": "public",
+  "vcs": "git",
+  "laborHours": 500,
+  "reuseFrequency": {
+    "forks": 10,
+    "clones": 50
+  },
+  "platforms": ["github-actions"],
+  "categories": ["compliance", "automation"],
+  "softwareType": "tool",
+  "languages": ["TypeScript"],
+  "maintenance": "active",
+  "contractNumber": [],
+  "SBOM": "https://github.com/DSACMS/automated-codejson-generator/network/dependencies",
+  "date": {
+    "created": "2024-01-01T00:00:00Z",
+    "lastModified": "2024-06-15T00:00:00Z",
+    "metadataLastUpdated": "2024-06-20T00:00:00Z"
+  },
+  "tags": ["code.json", "federal", "open-source"],
+  "contact": {
+    "email": "opensource@cms.hhs.gov",
+    "name": "CMS Open Source Team"
+  },
+  "feedbackMechanism": "https://github.com/DSACMS/automated-codejson-generator/issues",
+  "AIUseCaseID": "0",
+  "localisation": false,
+  "repositoryType": "source",
+  "userInput": false,
+  "fismaLevel": "low",
+  "group": "DSACMS",
+  "projects": [],
+  "systems": [],
+  "subsetInHealthcare": [],
+  "userType": ["developer"],
+  "maturityModelTier": 1
+}