updated README and set workflow outputs

Signed-off-by: Sachin Panayil <sachinpanayil01@gmail.com>

Author: sachin-panayil

.github/workflows/updateCodeJSON.yml

@@ -17,7 +17,13 @@ jobs:
           fetch-depth: 0
 
       - name: Update code.json
-        uses: DSACMS/automated-codejson-generator@main
+        id: generator
+        uses: DSACMS/automated-codejson-generator@v1.0.0
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH: "main"
+          BRANCH: "main"
+
+      - name: Print outputs
+        run: |
+          echo "Your code.json has been updated: ${{steps.generator.outputs.updated}}"
+          echo "Pull Request Link: ${{steps.generator.outputs.pr_url}}"

README.md

@@ -15,13 +15,23 @@ GITHUB_TOKEN:
   default: ${{ github.token }}
 ```
 
-## Usage
+## Outputs
+
+```yaml
+updated:
+  description: "Boolean indicating whether code.json was updated"
+pr_url:
+  description: "URL of the created pull request if changes were made"
+```
+
+## Workflow Examples
 
 ### Create a PR to add compliant code.json
 
 ```yaml
 name: Update Code.json
 on:
+  schedule: 0 0 1 * * # Example of running first day of every month
   workflow_dispatch:
 
 permissions:
@@ -45,6 +55,29 @@ jobs:
           BRANCH: "main"
 ```
 
+## Generation Context
+The automated code.json generator calculates specific fields by analyzing your repository and using GitHub's API. Here's what gets generated and what your repository needs for successful generation.
+
+**name**: This field pulls directly from your repository's name as configured in GitHub. No configuration needed.
+
+**description**: The generator extracts this from your repository's description field in GitHub settings. *Make sure you've added a description to your repository through GitHub's interface for this field to populate properly.*
+
+**repositoryURL**: This automatically uses your repository's public GitHub URL. No configuration needed.
+
+**repositoryVisibility**: The generator determines whether your repository is private or public. No configuration needed.
+
+**laborHours**: The generator runs SCC against your workspace to analyze your codebase and estimate development time. No configuration needed.
+
+**languages**: This field populates the programming languages in your repository. No configuration needed.
+
+**dateCreated**: The generator pulls your repository's creation date. No configuration needed.
+
+**dateLastModified**: This uses your repository's last update timestamp, reflecting the most recent changes. No configuration needed.
+
+**dateMetaDataLastUpdated**: The generator sets this to the current timestamp each time it runs, providing a record of when the metadata was last refreshed. No configuration needed.
+
+**feedbackMechanisms**: A list of containing your repository's issues URL in the format of {repositoryURL}/issues. If you already have a code.json file with existing feedback mechanisms, the generator preserves those values. No configuration needed.
+
 ## Project Vision
 
 To streamline federal agencies' compliance with open source requirements by automating the maintenance of code.json files, reducing manual effort and improving accuracy of repository metadata.
@@ -100,7 +133,7 @@ To develop locally:
 1. Clone the repository
 2. Install dependencies with `npm install`
 3. Install Go and SCC tool: `go install github.com/boyter/scc/v3@latest`
-4. Build the project with `npm run package`
+4. Build the project with `npm run bundle`
 5. Run tests with `npm test`
 
 ## Coding Style and Linters

action.yml

@@ -7,7 +7,7 @@ inputs:
     description: "GitHub token used for API access"
     required: true
     default: ${{ github.token }}
-  
+
   BRANCH:
     description: "Name of the branch the PR is sent to"
     required: false
@@ -24,5 +24,5 @@ runs:
   image: Dockerfile
 
 branding:
-  icon: 'file-text'
-  color: 'blue'
+  icon: "file-text"
+  color: "blue"

dist/index.js

@@ -144,6 +144,9 @@ export async function sendPR(updatedCodeJSON: CodeJSON) {
 
     if (PR) {
       core.info(`Successfully created PR: ${PR.data.html_url}`);
+
+      core.setOutput("updated", PR);
+      core.setOutput("pr_url", PR.data.html_url);
     } else {
       core.error(`Failed to create PR because of PR object`);
     }