Use more concise input name

I decided the "-name" part of the input name was superfluous.

This is part of a single PR, so no further backwards compatibility measures are necessary. I just don't feel like making the effort to fixup the previous name change commit and deal with all the conflicts while rebasing.

Author: per1234

README.md

@@ -8,7 +8,7 @@ This action comments on the pull request with a report on the resulting change i
 
 ## Inputs
 
-### `sketches-reports-source-name`
+### `sketches-reports-source`
 
 **Default**: "size-deltas-reports"
 
@@ -20,7 +20,7 @@ Recommended for public repositories.
 
 The use of a scheduled workflow is necessary in order for the action to have the [write permissions required to comment on pull requests submitted from forks](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token).
 
-In this usage, the `sketches-reports-source-name` defines the name of the workflow artifact that contains the memory usage data, as specified to the [`actions/upload-artifact`](https://github.com/actions/upload-artifact) action via its `name` input.
+In this usage, the `sketches-reports-source` defines the name of the workflow artifact that contains the memory usage data, as specified to the [`actions/upload-artifact`](https://github.com/actions/upload-artifact) action via its `name` input.
 
 #### Run from the same workflow as the [`arduino/compile-sketches`](https://github.com/arduino/compile-sketches) action
 
@@ -32,7 +32,7 @@ In order to get reports for pull requests from forks, the ["Send write tokens to
 
 If the "Send write tokens to workflows from fork pull requests" setting is not enabled but the ["Run workflows from fork pull requests" setting](https://docs.github.com/en/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks) is enabled, the workflow should be configured to only run the action when the pull request is not from a fork (`if: github.event.pull_request.head.repo.full_name == github.repository`). This will prevent workflow job failures that would otherwise be caused when the report creation failed due to not having the necessary write permissions.
 
-In this usage, the `sketches-reports-source-name` defines the path to the folder containing the memory usage data, as specified to the [`actions/download-artifact`](https://github.com/actions/download-artifact) action via its `path` input.
+In this usage, the `sketches-reports-source` defines the path to the folder containing the memory usage data, as specified to the [`actions/download-artifact`](https://github.com/actions/download-artifact) action via its `path` input.
 
 ### `github-token`
 
@@ -110,7 +110,7 @@ jobs:
     if: github.event_name == 'pull_request' # Only run the job when the workflow is triggered by a pull request
     runs-on: ubuntu-latest
     steps:
-      # This step is needed to get the size data produced by the compile job
+      # This step is needed to get the size data produced by the compile jobs
       - name: Download sketches reports artifact
         uses: actions/download-artifact@v2
         with:
@@ -119,5 +119,5 @@ jobs:
 
       - uses: arduino/report-size-deltas@main
         with:
-          sketches-reports-source-name: ${{ env.SKETCHES_REPORTS_PATH }}
+          sketches-reports-source: ${{ env.SKETCHES_REPORTS_PATH }}
 ```

action.yml

@@ -1,7 +1,7 @@
 name: 'Report Arduino Sketch Size Deltas'
 description: 'Comments on the pull request with a report on the resulting change in memory usage of Arduino sketches'
 inputs:
-  sketches-reports-source-name:
+  sketches-reports-source:
     description: 'When run from scheduled workflow, name of the workflow artifact that contains sketches reports. When run from a pull request triggered workflow, path to the folder containing sketches reports.'
     default: 'size-deltas-reports'
   github-token:

reportsizedeltas/reportsizedeltas.py

@@ -22,11 +22,11 @@ def main():
 
     if "INPUT_SIZE-DELTAS-REPORTS-ARTIFACT-NAME" in os.environ:
         print("::warning::The size-deltas-report-artifact-name input is deprecated. Use the equivalent input: "
-              "sketches-reports-source-name instead.")
-        os.environ["INPUT_SKETCHES-REPORTS-SOURCE-NAME"] = os.environ["INPUT_SIZE-DELTAS-REPORTS-ARTIFACT-NAME"]
+              "sketches-reports-source instead.")
+        os.environ["INPUT_SKETCHES-REPORTS-SOURCE"] = os.environ["INPUT_SIZE-DELTAS-REPORTS-ARTIFACT-NAME"]
 
     report_size_deltas = ReportSizeDeltas(repository_name=os.environ["GITHUB_REPOSITORY"],
-                                          sketches_reports_source_name=os.environ["INPUT_SKETCHES-REPORTS-SOURCE-NAME"],
+                                          sketches_reports_source=os.environ["INPUT_SKETCHES-REPORTS-SOURCE"],
                                           token=os.environ["INPUT_GITHUB-TOKEN"])
 
     report_size_deltas.report_size_deltas()
@@ -79,9 +79,9 @@ class ReportKeys:
         sketches = "sketches"
         compilation_success = "compilation_success"
 
-    def __init__(self, repository_name, sketches_reports_source_name, token):
+    def __init__(self, repository_name, sketches_reports_source, token):
         self.repository_name = repository_name
-        self.sketches_reports_source_name = sketches_reports_source_name
+        self.sketches_reports_source = sketches_reports_source
         self.token = token
 
     def report_size_deltas(self):
@@ -96,7 +96,7 @@ def report_size_deltas(self):
 
     def report_size_deltas_from_local_reports(self):
         """Comment a report of memory usage change to the pull request."""
-        sketches_reports_folder = pathlib.Path(os.environ["GITHUB_WORKSPACE"], self.sketches_reports_source_name)
+        sketches_reports_folder = pathlib.Path(os.environ["GITHUB_WORKSPACE"], self.sketches_reports_source)
         sketches_reports = self.get_sketches_reports(artifact_folder_object=sketches_reports_folder)
 
         if sketches_reports:
@@ -239,7 +239,7 @@ def get_artifact_download_url_for_run(self, run_id):
 
             for artifact_data in artifacts_data["artifacts"]:
                 # The artifact is identified by a specific name
-                if artifact_data["name"] == self.sketches_reports_source_name:
+                if artifact_data["name"] == self.sketches_reports_source:
                     return artifact_data["archive_download_url"]
 
             page_number += 1
@@ -258,13 +258,13 @@ def get_artifact(self, artifact_download_url):
         artifact_folder_object = tempfile.TemporaryDirectory(prefix="reportsizedeltas-")
         try:
             # Download artifact
-            with open(file=artifact_folder_object.name + "/" + self.sketches_reports_source_name + ".zip",
+            with open(file=artifact_folder_object.name + "/" + self.sketches_reports_source + ".zip",
                       mode="wb") as out_file:
                 with self.raw_http_request(url=artifact_download_url) as fp:
                     out_file.write(fp.read())
 
             # Unzip artifact
-            artifact_zip_file = artifact_folder_object.name + "/" + self.sketches_reports_source_name + ".zip"
+            artifact_zip_file = artifact_folder_object.name + "/" + self.sketches_reports_source + ".zip"
             with zipfile.ZipFile(file=artifact_zip_file, mode="r") as zip_ref:
                 zip_ref.extractall(path=artifact_folder_object.name)
             os.remove(artifact_zip_file)

reportsizedeltas/tests/test_reportsizedeltas.py

@@ -19,17 +19,17 @@
 
 
 def get_reportsizedeltas_object(repository_name="FooOwner/BarRepository",
-                                sketches_reports_source_name="foo-artifact-name",
+                                sketches_reports_source="foo-artifact-name",
                                 token="foo token"):
     """Return a reportsizedeltas.ReportSizeDeltas object to use in tests.
 
     Keyword arguments:
     repository_name -- repository owner and name e.g., octocat/Hello-World
-    sketches_reports_source_name -- name of the workflow artifact that contains the memory usage data
+    sketches_reports_source -- name of the workflow artifact that contains the memory usage data
     token -- GitHub access token
     """
     return reportsizedeltas.ReportSizeDeltas(repository_name=repository_name,
-                                             sketches_reports_source_name=sketches_reports_source_name, token=token)
+                                             sketches_reports_source=sketches_reports_source, token=token)
 
 
 def directories_are_same(left_directory, right_directory):
@@ -99,11 +99,11 @@ def setup_environment_variables(monkeypatch):
     class ActionInputs:
         """A container for the values of the environment variables"""
         repository_name = "GoldenOwner/GoldenRepository"
-        sketches_reports_source_name = "golden-artifact-name"
+        sketches_reports_source = "golden-source-name"
         token = "golden-github-token"
 
     monkeypatch.setenv("GITHUB_REPOSITORY", ActionInputs.repository_name)
-    monkeypatch.setenv("INPUT_SKETCHES-REPORTS-SOURCE-NAME", ActionInputs.sketches_reports_source_name)
+    monkeypatch.setenv("INPUT_SKETCHES-REPORTS-SOURCE", ActionInputs.sketches_reports_source)
     monkeypatch.setenv("INPUT_GITHUB-TOKEN", ActionInputs.token)
 
     return ActionInputs()
@@ -125,7 +125,7 @@ def report_size_deltas(self):
     reportsizedeltas.set_verbosity.assert_called_once_with(enable_verbosity=False)
     reportsizedeltas.ReportSizeDeltas.assert_called_once_with(
         repository_name=setup_environment_variables.repository_name,
-        sketches_reports_source_name=setup_environment_variables.sketches_reports_source_name,
+        sketches_reports_source=setup_environment_variables.sketches_reports_source,
         token=setup_environment_variables.token
     )
     ReportSizeDeltas.report_size_deltas.assert_called_once()
@@ -140,9 +140,9 @@ def test_main_size_deltas_report_artifact_name_deprecation_warning(capsys,
 
     if use_size_deltas_report_artifact_name:
         monkeypatch.setenv("INPUT_SIZE-DELTAS-REPORTS-ARTIFACT-NAME", size_deltas_report_artifact_name)
-        expected_sketches_reports_source_name = size_deltas_report_artifact_name
+        expected_sketches_reports_source = size_deltas_report_artifact_name
     else:
-        expected_sketches_reports_source_name = setup_environment_variables.sketches_reports_source_name
+        expected_sketches_reports_source = setup_environment_variables.sketches_reports_source
 
     class ReportSizeDeltas:
         """Stub"""
@@ -162,12 +162,12 @@ def report_size_deltas(self):
         expected_output = (
             expected_output
             + "::warning::The size-deltas-report-artifact-name input is deprecated. Use the equivalent input: "
-              "sketches-reports-source-name instead."
+              "sketches-reports-source instead."
         )
 
     assert capsys.readouterr().out.strip() == expected_output
 
-    assert os.environ["INPUT_SKETCHES-REPORTS-SOURCE-NAME"] == expected_sketches_reports_source_name
+    assert os.environ["INPUT_SKETCHES-REPORTS-SOURCE"] == expected_sketches_reports_source
 
 
 def test_set_verbosity():
@@ -200,9 +200,9 @@ def test_report_size_deltas(mocker, monkeypatch):
 
 
 def test_report_size_deltas_from_local_reports(mocker, monkeypatch):
-    sketches_reports_source_name = "golden-sketches-reports-source-path"
+    sketches_reports_source = "golden-sketches-reports-source-path"
     github_workspace = "golden-github-workspace"
-    sketches_reports_folder = pathlib.Path(github_workspace, sketches_reports_source_name)
+    sketches_reports_folder = pathlib.Path(github_workspace, sketches_reports_source)
     sketches_reports = unittest.mock.sentinel.sketches_reports
     report = "golden report"
 
@@ -214,7 +214,7 @@ def test_report_size_deltas_from_local_reports(mocker, monkeypatch):
     mocker.patch("reportsizedeltas.ReportSizeDeltas.generate_report", autospec=True, return_value=report)
     mocker.patch("reportsizedeltas.ReportSizeDeltas.comment_report", autospec=True)
 
-    report_size_deltas = get_reportsizedeltas_object(sketches_reports_source_name=sketches_reports_source_name)
+    report_size_deltas = get_reportsizedeltas_object(sketches_reports_source=sketches_reports_source)
 
     # Test handling of no sketches reports data available
     reportsizedeltas.ReportSizeDeltas.get_sketches_reports.return_value = None
@@ -413,14 +413,14 @@ def test_get_artifact_download_url_for_sha():
 
 def test_get_artifact_download_url_for_run():
     repository_name = "test_name/test_repo"
-    sketches_reports_source_name = "test_sketches_reports_source_name"
+    sketches_reports_source = "test_sketches_reports_source"
     archive_download_url = "archive_download_url"
     run_id = "1234"
 
     report_size_deltas = get_reportsizedeltas_object(repository_name=repository_name,
-                                                     sketches_reports_source_name=sketches_reports_source_name)
+                                                     sketches_reports_source=sketches_reports_source)
 
-    json_data = {"artifacts": [{"name": sketches_reports_source_name, "archive_download_url": archive_download_url},
+    json_data = {"artifacts": [{"name": sketches_reports_source, "archive_download_url": archive_download_url},
                                {"name": "bar123", "archive_download_url": "wrong_artifact_url"}]}
     report_size_deltas.api_request = unittest.mock.MagicMock(return_value={"json_data": json_data,
                                                                            "additional_pages": False,