Address review comments

Author: pksunkara

README.md

@@ -377,12 +377,12 @@ If it is set to `true`, this action will leave a commit comment comparing the cu
 `github-token` is necessary as well. Please note that a personal access token is not necessary to
 send a commit comment. `secrets.GITHUB_TOKEN` is sufficient.
 
-#### `save-on-pr` (Optional)
+#### `save-data-file` (Optional)
 
 - Type: Boolean
 - Default: `true`
 
-If it is set to `true`, any commits that are part of a PR will not save the current benchmark.
+If it is set to `true`, this action will not save the current benchmark to the external data file.
 You can use this option to set up your action to compare the benchmarks between PR and base branch.
 
 #### `alert-threshold` (Optional)

action.yml

@@ -39,8 +39,8 @@ inputs:
     description: 'Leave a comment with benchmark result comparison. To enable this feature, github-token input must be given as well'
     required: false
     default: false
-  save-on-pr:
-    description: 'Save the benchmark data on pull requests'
+  save-data-file:
+    description: 'Save the benchmark data to external file'
     required: false
     default: true
   comment-on-alert:

src/config.ts

@@ -14,7 +14,7 @@ export interface Config {
     autoPush: boolean;
     skipFetchGhPages: boolean;
     commentAlways: boolean;
-    saveOnPr: boolean;
+    saveDataFile: boolean;
     commentOnAlert: boolean;
     alertThreshold: number;
     failOnAlert: boolean;
@@ -213,7 +213,7 @@ export async function configFromJobInput(): Promise<Config> {
     const autoPush = getBoolInput('auto-push');
     const skipFetchGhPages = getBoolInput('skip-fetch-gh-pages');
     const commentAlways = getBoolInput('comment-always');
-    const saveOnPr = getBoolInput('save-on-pr');
+    const saveDataFile = getBoolInput('save-data-file');
     const commentOnAlert = getBoolInput('comment-on-alert');
     const alertThreshold = getPercentageInput('alert-threshold');
     const failOnAlert = getBoolInput('fail-on-alert');
@@ -254,7 +254,7 @@ export async function configFromJobInput(): Promise<Config> {
         autoPush,
         skipFetchGhPages,
         commentAlways,
-        saveOnPr,
+        saveDataFile,
         commentOnAlert,
         alertThreshold,
         failOnAlert,

src/write.ts

@@ -117,7 +117,15 @@ function getCurrentRepo() {
 }
 
 function floatStr(n: number) {
-    return Number.isInteger(n) ? n.toFixed(0) : n.toFixed(2);
+    if (Number.isInteger(n)) {
+        return n.toFixed(0);
+    }
+
+    if (n > 1) {
+        return n.toFixed(2);
+    }
+
+    return n.toString();
 }
 
 function strVal(b: BenchmarkResult): string {
@@ -133,7 +141,6 @@ function commentFooter(): string {
     // eslint-disable-next-line @typescript-eslint/camelcase
     const repoUrl = repo.html_url ?? '';
     const actionUrl = repoUrl + '/actions?query=workflow%3A' + encodeURIComponent(github.context.workflow);
-    core.debug(`Action URL: ${actionUrl}`);
 
     return `This comment was automatically generated by [workflow](${actionUrl}) using [github-action-benchmark](https://github.com/marketplace/actions/continuous-benchmark).`;
 }
@@ -360,7 +367,6 @@ async function writeBenchmarkToGitHubPagesWithRetry(
         autoPush,
         skipFetchGhPages,
         maxItemsInChart,
-        saveOnPr,
     } = config;
     const dataPath = path.join(benchmarkDataDirPath, 'data.js');
     const isPrivateRepo = github.context.payload.repository?.private ?? false;
@@ -379,11 +385,6 @@ async function writeBenchmarkToGitHubPagesWithRetry(
     const data = await loadDataJs(dataPath);
     const prevBench = addBenchmarkToDataJson(name, bench, data, maxItemsInChart);
 
-    if (!saveOnPr && github.context.eventName === 'pull_request') {
-        core.debug('Skipping storing benchmarks');
-        return prevBench;
-    }
-
     await storeDataJs(dataPath, data);
 
     await git.cmd('add', dataPath);
@@ -461,12 +462,12 @@ async function writeBenchmarkToExternalJson(
     jsonFilePath: string,
     config: Config,
 ): Promise<Benchmark | null> {
-    const { name, maxItemsInChart, saveOnPr } = config;
+    const { name, maxItemsInChart, saveDataFile } = config;
     const data = await loadDataJson(jsonFilePath);
     const prevBench = addBenchmarkToDataJson(name, bench, data, maxItemsInChart);
 
-    if (!saveOnPr && github.context.eventName === 'pull_request') {
-        core.debug('Skipping storing benchmarks');
+    if (!saveDataFile) {
+        core.debug('Skipping storing benchmarks in external data file');
         return prevBench;
     }
 

test/write.ts

@@ -189,7 +189,7 @@ describe('writeBenchmark()', function() {
             autoPush: false,
             skipFetchGhPages: false, // Should not affect
             commentAlways: false,
-            saveOnPr: true,
+            saveDataFile: true,
             commentOnAlert: false,
             alertThreshold: 2.0,
             failOnAlert: true,
@@ -897,7 +897,7 @@ describe('writeBenchmark()', function() {
             autoPush: true,
             skipFetchGhPages: false, // Should not affect
             commentAlways: false,
-            saveOnPr: true,
+            saveDataFile: true,
             commentOnAlert: false,
             alertThreshold: 2.0,
             failOnAlert: true,