Rename size-deltas-report-folder-name input to sketches-report-path

Now that the report is always generated and is used to transfer data to the reportsizetrends module, it's misleading for the input name to reference "deltas".

The previous input name is still supported. It is now undocumented and a warning will be printed in the workflow log when it is used.

Although no longer an accurate name, the previous default value is retained to avoid breaking workflows that use the default input value and then reference that path in the actions/upload-artifact step.

Author: per1234

README.md

@@ -115,12 +115,13 @@ GitHub access token used to get information from the GitHub API. Only needed if
 
 Name of the sketch used to compare memory usage change. Default `""`.
 
-### `enable-size-deltas-report`
+### `sketches-report-path`
 
-Set to `true` to cause the action to determine the change in memory usage for the [`size-reports-sketch`](#size-reports-sketch) between the pull request branch and the tip of the pull request's base branch. This may be used with the [`arduino/actions/libraries/report-size-deltas` action](https://github.com/arduino/actions/tree/master/libraries/report-size-deltas). Default `false`.
+Path in which to save a JSON formatted file containing data from the sketch compilations. Should be used only to store reports. Relative paths are relative to [`GITHUB_WORKSPACE`](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables). The folder will be created if it doesn't already exist. This report is used by the `arduino/libraries/report-size-deltas` and `arduino/libraries/report-size-trends` actions. Default `"size-deltas-reports"`.
 
-### `size-deltas-report-folder-name`
+### `enable-size-deltas-report`
 
+Set to `true` to cause the action to determine the change in memory usage for the [`size-reports-sketch`](#size-reports-sketch) between the pull request branch and the tip of the pull request's base branch. This may be used with the [`arduino/actions/libraries/report-size-deltas` action](https://github.com/arduino/actions/tree/master/libraries/report-size-deltas). Default `false`.
 
 ### `enable-size-trends-report`
 
@@ -176,7 +177,6 @@ The ID of the Google Sheets spreadsheet to write the memory usage trends data to
 ### `size-trends-report-sheet-name`
 
 The sheet name in the Google Sheets spreadsheet used for the memory usage trends report. Default `"Sheet1"`.
-Path in which to save a JSON formatted file containing data from the sketch compilations. Should be used only to store reports. Relative paths are relative to [`GITHUB_WORKSPACE`](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables). The folder will be created if it doesn't already exist. Default `"size-deltas-reports"`.
 
 ## Example usage
 

action.yml

@@ -25,12 +25,12 @@ inputs:
   size-report-sketch:
     description: 'Name of the sketch used to compare memory usage change'
     default: ''
+  sketches-report-path:
+    description: 'Path in which to save a JSON formatted file containing data from the sketch compilations'
+    default: 'size-deltas-reports'
   enable-size-deltas-report:
     description: 'Set to true to cause the action to determine the change in memory usage for the size-reports-sketch'
     default: false
-  size-deltas-report-folder-name:
-    description: 'Folder to save the memory usage change report to'
-    default: 'size-deltas-reports'
   enable-size-trends-report:
     description: 'Set to true to cause the action to record the memory usage of size-reports-sketch'
     default: false

compilesketches/compilesketches.py

@@ -22,6 +22,11 @@
 
 
 def main():
+    if "INPUT_SIZE-DELTAS-REPORT-FOLDER-NAME" in os.environ:
+        print("::warning::The size-deltas-report-folder-name input is deprecated. Use the equivalent input: "
+              "sketches-report-path instead.")
+        os.environ["INPUT_SKETCHES-REPORT-PATH"] = os.environ["INPUT_SIZE-DELTAS-REPORT-FOLDER-NAME"]
+
     compile_sketches = CompileSketches(
         cli_version=os.environ["INPUT_CLI-VERSION"],
         fqbn_arg=os.environ["INPUT_FQBN"],
@@ -32,7 +37,7 @@ def main():
         github_token=os.environ["INPUT_GITHUB-TOKEN"],
         report_sketch=os.environ["INPUT_SIZE-REPORT-SKETCH"],
         enable_size_deltas_report=os.environ["INPUT_ENABLE-SIZE-DELTAS-REPORT"],
-        sketches_report_path=os.environ["INPUT_SIZE-DELTAS-REPORT-FOLDER-NAME"],
+        sketches_report_path=os.environ["INPUT_SKETCHES-REPORT-PATH"],
         enable_size_trends_report=os.environ["INPUT_ENABLE-SIZE-TRENDS-REPORT"],
         google_key_file=os.environ["INPUT_KEYFILE"],
         size_trends_report_spreadsheet_id=os.environ["INPUT_SIZE-TRENDS-REPORT-SPREADSHEET-ID"],

compilesketches/tests/test_compilesketches.py

@@ -80,7 +80,10 @@ def test_directories_are_same():
     ) is False
 
 
-def test_main(monkeypatch, mocker):
+@pytest.mark.parametrize("use_size_deltas_report_folder_name, expected_sketches_report_path",
+                         [(True, "FooSizeDeltasReportFolderName"),
+                          (False, "FooSketchesReportPath")])
+def test_main(monkeypatch, mocker, use_size_deltas_report_folder_name, expected_sketches_report_path):
     cli_version = "1.0.0"
     fqbn_arg = "foo:bar:baz"
     platforms = "- name: FooVendor:BarArchitecture"
@@ -90,7 +93,8 @@ def test_main(monkeypatch, mocker):
     github_token = "FooGitHubToken"
     report_sketch = "FooReportSketch"
     enable_size_deltas_report = "true"
-    sketches_report_path = "FooSizeDeltasReportFolderName"
+    sketches_report_path = "FooSketchesReportPath"
+    size_deltas_report_folder_name = "FooSizeDeltasReportFolderName"
     enable_size_trends_report = "true"
     google_key_file = "FooKeyfile"
     size_trends_report_spreadsheet_id = "FooSpreadsheetID"
@@ -109,7 +113,9 @@ def compile_sketches(self):
     monkeypatch.setenv("INPUT_VERBOSE", verbose)
     monkeypatch.setenv("INPUT_SIZE-REPORT-SKETCH", report_sketch)
     monkeypatch.setenv("INPUT_ENABLE-SIZE-DELTAS-REPORT", enable_size_deltas_report)
-    monkeypatch.setenv("INPUT_SIZE-DELTAS-REPORT-FOLDER-NAME", sketches_report_path)
+    monkeypatch.setenv("INPUT_SKETCHES-REPORT-PATH", sketches_report_path)
+    if use_size_deltas_report_folder_name:
+        monkeypatch.setenv("INPUT_SIZE-DELTAS-REPORT-FOLDER-NAME", size_deltas_report_folder_name)
     monkeypatch.setenv("INPUT_ENABLE-SIZE-TRENDS-REPORT", enable_size_trends_report)
     monkeypatch.setenv("INPUT_KEYFILE", google_key_file)
     monkeypatch.setenv("INPUT_SIZE-TRENDS-REPORT-SPREADSHEET-ID", size_trends_report_spreadsheet_id)
@@ -130,7 +136,7 @@ def compile_sketches(self):
         github_token=github_token,
         report_sketch=report_sketch,
         enable_size_deltas_report=enable_size_deltas_report,
-        sketches_report_path=sketches_report_path,
+        sketches_report_path=expected_sketches_report_path,
         enable_size_trends_report=enable_size_trends_report,
         google_key_file=google_key_file,
         size_trends_report_spreadsheet_id=size_trends_report_spreadsheet_id,