✨ NEW: add metadata user option key (#3)

aiidateam · Sep 9, 2020 · 31c3889 · 31c3889
1 parent 4a3689d
commit 31c3889
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/action.yml b/action.yml
@@ -81,6 +81,10 @@ inputs:
     description: 'Whether to overwrite existing HTML/JS/CSS files on GitHub Pages'
     required: false
     default: 'true'
+  metadata:
+    description: 'Additional metadata to store about the run'
+    required: false
+    default: ''
 
 runs:
   using: 'node12'

diff --git a/src/config.ts b/src/config.ts
@@ -24,6 +24,7 @@ export interface Config {
     chartXAxis: 'id' | 'date';
     oneChartGroups: string[];
     overwriteAssets: boolean;
+    metadata: string;
 }
 
 const RE_UINT = /^\d+$/;
@@ -228,6 +229,7 @@ export async function configFromJobInput(): Promise<Config> {
     const oneChartGroups = core.getInput('one-chart-groups').split(',');
     let failThreshold = getPercentageInput('fail-threshold');
     const overwriteAssets = getBoolInput('overwrite-assets');
+    const metadata = core.getInput('metadata');
 
     outputFilePath = await validateOutputFilePath(outputFilePath);
     validateGhPagesBranch(ghPagesBranch);
@@ -272,5 +274,6 @@ export async function configFromJobInput(): Promise<Config> {
         chartXAxis,
         oneChartGroups,
         overwriteAssets,
+        metadata,
     };
 }
diff --git a/src/extract.ts b/src/extract.ts
@@ -182,6 +182,9 @@ export async function extractResult(config: Config): Promise<Benchmark> {
     const output = await fs.readFile(config.outputFilePath, 'utf8');
 
     const benches = extractPytestResult(output);
+    if (config.metadata !== '') {
+        benches.extra['gh-metadata'] = config.metadata;
+    }
 
     if (benches.results.length === 0) {
         throw new Error(`No benchmark result was found in ${config.outputFilePath}. Benchmark output was '${output}'`);

diff --git a/test/write.ts b/test/write.ts
@@ -192,6 +192,7 @@ describe('writeBenchmark()', function() {
             chartXAxis: 'id',
             oneChartGroups: [],
             overwriteAssets: false,
+            metadata: '',
         };
 
         const savedRepository = gitHubContext.payload.repository;
@@ -834,6 +835,7 @@ describe('writeBenchmark()', function() {
             chartXAxis: 'id',
             oneChartGroups: [],
             overwriteAssets: false,
+            metadata: '',
         };
 
         function gitHistory(