Merge pull request #210 from austenstone/rewrite

Enhance job summary metrics and reporting

Author: austenstone

.github/workflows/ci.yml

@@ -19,6 +19,7 @@ jobs:
       - uses: actions/setup-node@v4
       - run: npm ci
       - run: npm run lint
+        continue-on-error: true
       - run: npm run build
       - run: npm test
         env:

.github/workflows/codeql.yml

@@ -4,6 +4,10 @@ on:
     branches: [ main ]
     paths-ignore:
       - "**.md"
+  pull_request:
+    branches: [ main ]
+    paths-ignore:
+      - "**.md"
   workflow_dispatch:
 permissions:
   contents: read

.github/workflows/usage.yml

@@ -39,15 +39,16 @@ jobs:
     name: Run Action
     runs-on: ubuntu-latest
     steps:
-      - uses: austenstone/copilot-usage@v5.0
+      - uses: austenstone/copilot-usage@v5.1
         with:
           github-token: ${{ secrets.TOKEN }}
           time-zone: 'EST'
 ```
+
 #### Example get team usage
 
 ```yml
-      - uses: austenstone/copilot-usage@v5.0
+      - uses: austenstone/copilot-usage@v5.1
         with:
           github-token: ${{ secrets.TOKEN }}
           organization: 'org-slug'
@@ -57,7 +58,7 @@ jobs:
 #### Example get CSV
 
 ```yml
-      - uses: austenstone/copilot-usage@v5.0
+      - uses: austenstone/copilot-usage@v5.1
         with:
           github-token: ${{ secrets.TOKEN }}
           csv: true
@@ -72,7 +73,7 @@ jobs:
           - 'team-slug2'
     steps:
       - uses: actions/checkout@v4
-      - uses: austenstone/copilot-usage@v5.0
+      - uses: austenstone/copilot-usage@v5.1
         with:
           github-token: ${{ secrets.TOKEN }}
           organization: 'org-slug'
@@ -85,7 +86,7 @@ You probably want to specify the timezone to get the usage in your local time. T
 EX: `EST`, `PST`, `CST`, [etc](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
 
 ```yml
-      - uses: austenstone/copilot-usage@v5.0
+      - uses: austenstone/copilot-usage@v5.1
         with:
           github-token: ${{ secrets.TOKEN }}
           organization: 'org-slug'
@@ -108,7 +109,7 @@ jobs:
   run:
     runs-on: ubuntu-latest
     steps:
-      - uses: austenstone/copilot-usage@v5.0
+      - uses: austenstone/copilot-usage@v5.1
         with:
           github-token: ${{ secrets.TOKEN }}
       - uses: austenstone/[email protected]

README.md

@@ -1,7 +1,7 @@
 import { test, beforeAll, beforeEach, expect } from 'vitest';
 import dotenv from 'dotenv'
 dotenv.config({ override: true })
-import { createJobSummaryUsage } from '../src/job-summary';
+import { createJobSummaryCopilotDetails, createJobSummarySeatAssignments, createJobSummaryUsage } from '../src/job-summary';
 import { sumNestedValue } from '../src/job-summary'; // Import sumNestedValue function
 import { summary } from '@actions/core/lib/summary';
 import { read, readFileSync, writeFileSync } from 'fs';
@@ -23,14 +23,30 @@ beforeEach(() => {
 
 const sample = readFileSync('./__tests__/mock/sample.json', 'utf-8');
 const exampleResponseEnterprise = JSON.parse(sample);
+const sampleCopilotDetails = readFileSync('./__tests__/mock/sample-copilot-details.json', 'utf-8');
+const exampleResponseCopilotDetails = JSON.parse(sampleCopilotDetails);
+const sampleCopilotSeats = readFileSync('./__tests__/mock/sample-copilot-seats.json', 'utf-8');
+const exampleResponseCopilotSeats = JSON.parse(sampleCopilotSeats);
 
 test('createJobSummaryUsage(enterpriseUsage)', async () => {
   const summary = await createJobSummaryUsage(exampleResponseEnterprise, 'enterprise');
   writeFileSync('./__tests__/mock/sample-output.md', summary.stringify());
-  console.log('Summary:', summary.stringify());
   expect(summary).toBeDefined();
 });
 
+test('createJobSummaryCopilotDetails(enterpriseUsage)', async () => {
+  const summary = await createJobSummaryCopilotDetails(exampleResponseCopilotDetails);
+  writeFileSync('./__tests__/mock/sample-copilot-details-output.md', summary.stringify());
+  expect(summary).toBeDefined();
+});
+
+test('createJobSummaryCopilotSeats(enterpriseUsage)', async () => {
+  const summary = await createJobSummarySeatAssignments(exampleResponseCopilotSeats.seats);
+  writeFileSync('./__tests__/mock/sample-copilot-seats-output.md', summary.stringify());
+  expect(summary).toBeDefined();
+});
+
+
 // Tests for sumNestedValue function
 test('sumNestedValue with simple objects', () => {
   const data = [

__tests__/main.test.ts

@@ -0,0 +1,7 @@
+<h1>Seat Info</h1>
+<h3>Organization Copilot Details</h3>
+<table><tr><td>Plan Type</td><td>ENTERPRISE</td></tr><tr><td>Seat Management Setting</td><td>Assign All</td></tr></table>
+<h3>Seat Breakdown</h3>
+<table><tr><td>Total Seats</td><td>867</td></tr><tr><td>Added this cycle</td><td>1</td></tr><tr><td>Pending invites</td><td>0</td></tr><tr><td>Pending cancellations</td><td>0</td></tr><tr><td>Active this cycle</td><td>94</td></tr><tr><td>Inactive this cycle</td><td>773</td></tr></table>
+<h3>Policies</h3>
+<table><tr><td>Public Code Suggestions Enabled</td><td>Allowed</td></tr><tr><td>IDE Chat Enabled</td><td>ENABLED</td></tr><tr><td>Platform Chat Enabled</td><td>ENABLED</td></tr><tr><td>CLI Enabled</td><td>ENABLED</td></tr></table>

__tests__/mock/sample-copilot-details-output.md

@@ -0,0 +1,16 @@
+{
+  "seat_breakdown": {
+    "pending_invitation": 0,
+    "pending_cancellation": 0,
+    "added_this_cycle": 1,
+    "total": 867,
+    "active_this_cycle": 94,
+    "inactive_this_cycle": 773
+  },
+  "seat_management_setting": "assign_all",
+  "plan_type": "enterprise",
+  "public_code_suggestions": "allow",
+  "ide_chat": "enabled",
+  "cli": "enabled",
+  "platform_chat": "enabled"
+}