Add more fields to the output CSV

Specifically, and fields for the pull request number, the opt-in status
of the pull request author, and a timestamp for when the data was
generated.

src/archiver.ts

@@ -0,0 +1,56 @@
+import * as core from '@actions/core'
+import { DefaultArtifactClient } from '@actions/artifact'
+import { PullRequest } from '@octokit/webhooks-types' // eslint-disable-line import/no-unresolved
+import * as fs from 'fs'
+import * as path from 'path'
+import { Score } from 'sizeup-core'
+import { Configuration } from './configuration'
+import { OptInStatus } from './initializer'
+
+export async function createScoreArtifact(
+  pull: PullRequest,
+  score: Score,
+  optInStatus: OptInStatus,
+  config: Configuration
+): Promise<void> {
+  if (!config.archiving?.persistScoreArtifact) {
+    core.info('Skipping score artifact creation')
+    return
+  }
+
+  core.info('Creating score artifact')
+
+  const tmpDir = path.resolve(__dirname, './tmp')
+  const scoreFile = path.resolve(tmpDir, './sizeup-score/sizeup-score.csv')
+
+  fs.mkdirSync(path.dirname(scoreFile), { recursive: true })
+  fs.writeFileSync(scoreFile, scoreFileContents(pull, score, optInStatus))
+
+  const client = new DefaultArtifactClient()
+  await client.uploadArtifact('sizeup-score', [scoreFile], tmpDir, {
+    retentionDays: config.archiving?.artifactRetention
+  })
+}
+
+function scoreFileContents(
+  pull: PullRequest,
+  score: Score,
+  optInStatus: OptInStatus
+): string {
+  const fields = [
+    ['pull-request-number', `${pull.number}`],
+    ['opted-in', `${optInStatus === OptInStatus.In}`],
+    ['score', `${score.result}`],
+    ['category', score.category?.name || ''],
+    ['timestamp', `${Date.now()}`]
+  ]
+
+  const header = []
+  const data = []
+  for (const [key, value] of fields) {
+    header.push(key)
+    data.push(value)
+  }
+
+  return [header.join(','), data.join(',')].join('\n')
+}

src/main.ts

@@ -1,6 +1,5 @@
 import * as core from '@actions/core'
 import * as github from '@actions/github'
-import { DefaultArtifactClient } from '@actions/artifact'
 import { PullRequest, Label } from '@octokit/webhooks-types' // eslint-disable-line import/no-unresolved
 import { SizeUp, Score } from 'sizeup-core'
 import * as YAML from 'yaml'
@@ -15,6 +14,7 @@ import {
 } from './initializer'
 import { Git } from './git'
 import { addOrUpdateScoreThresholdExceededComment } from './commenting'
+import { createScoreArtifact } from './archiver'
 
 const DEFAULT_LABEL_PREFIX = 'sizeup/'
 
@@ -51,7 +51,7 @@ export async function run(): Promise<void> {
       optInStatus,
       config
     )
-    await createScoreArtifact(score, config)
+    await createScoreArtifact(pullRequest, score, optInStatus, config)
   } catch (error) {
     if (error instanceof Error) core.setFailed(error.message)
   }
@@ -259,29 +259,3 @@ async function applyLabel(
     }
   }
 }
-
-async function createScoreArtifact(
-  score: Score,
-  config: Configuration
-): Promise<void> {
-  if (!config.archiving?.persistScoreArtifact) {
-    core.info('Skipping score artifact creation')
-    return
-  }
-
-  core.info('Creating score artifact')
-
-  const tmpDir = path.resolve(__dirname, './tmp')
-  const scoreFile = path.resolve(tmpDir, './sizeup-score/sizeup-score.csv')
-
-  fs.mkdirSync(path.dirname(scoreFile), { recursive: true })
-  fs.writeFileSync(
-    scoreFile,
-    `score,category\n${score.result},${score.category?.name || ''}`
-  )
-
-  const client = new DefaultArtifactClient()
-  await client.uploadArtifact('sizeup-score', [scoreFile], tmpDir, {
-    retentionDays: config.archiving?.artifactRetention
-  })
-}