add new input update-comment

defaults to false for old behavior

Author: 2bndy5

action.yml

@@ -7,6 +7,9 @@ inputs:
   github-token:
     description: "GitHub access token used to comment the memory usage comparison results to the PR thread"
     default: ${{ github.token }}
+  update-comment:
+    description: "when posting a report, set this to true to only update the previous report (if one exists)"
+    default: false
 runs:
   using: "docker"
   image: "Dockerfile"

reportsizedeltas/reportsizedeltas.py

@@ -32,6 +32,7 @@ def main() -> None:
         repository_name=os.environ["GITHUB_REPOSITORY"],
         sketches_reports_source=os.environ["INPUT_SKETCHES-REPORTS-SOURCE"],
         token=os.environ["INPUT_GITHUB-TOKEN"],
+        update_comment=os.environ["INPUT_UPDATE-COMMENT"] == "true",
     )
 
     report_size_deltas.report_size_deltas()
@@ -87,10 +88,11 @@ class ReportKeys:
         sketches = "sketches"
         compilation_success = "compilation_success"
 
-    def __init__(self, repository_name: str, sketches_reports_source: str, token: str) -> None:
+    def __init__(self, repository_name: str, sketches_reports_source: str, token: str, update_comment: bool) -> None:
         self.repository_name = repository_name
         self.sketches_reports_source = sketches_reports_source
         self.token = token
+        self.update_comment = update_comment
 
     def report_size_deltas(self) -> None:
         """Comment a report of memory usage change to pull request(s)."""
@@ -572,7 +574,7 @@ def comment_report(self, pr_number: int, report_markdown: str) -> None:
         report_data = json.dumps(obj={"body": report_markdown}).encode(encoding="utf-8")
         url = f"https://api.github.com/repos/{self.repository_name}/issues/{pr_number}"
 
-        comment_url = self.get_previous_comment(url)
+        comment_url = None if not self.update_comment else self.get_previous_comment(url)
         url = comment_url or url + "/comments"
         method = "PATCH" if comment_url else None
 

reportsizedeltas/tests/test_reportsizedeltas.py

@@ -22,6 +22,7 @@ def get_reportsizedeltas_object(
     repository_name: str = "FooOwner/BarRepository",
     sketches_reports_source: str = "foo-artifact-pattern",
     token: str = "foo token",
+    update_comment: bool = False,
 ) -> reportsizedeltas.ReportSizeDeltas:
     """Return a reportsizedeltas.ReportSizeDeltas object to use in tests.
 
@@ -32,7 +33,10 @@ def get_reportsizedeltas_object(
     token -- GitHub access token
     """
     return reportsizedeltas.ReportSizeDeltas(
-        repository_name=repository_name, sketches_reports_source=sketches_reports_source, token=token
+        repository_name=repository_name,
+        sketches_reports_source=sketches_reports_source,
+        token=token,
+        update_comment=update_comment,
     )
 
 
@@ -106,10 +110,12 @@ class ActionInputs:
         repository_name = "GoldenOwner/GoldenRepository"
         sketches_reports_source = "golden-source-pattern"
         token = "golden-github-token"
+        update_comment = "false"
 
     monkeypatch.setenv("GITHUB_REPOSITORY", ActionInputs.repository_name)
     monkeypatch.setenv("INPUT_SKETCHES-REPORTS-SOURCE", ActionInputs.sketches_reports_source)
     monkeypatch.setenv("INPUT_GITHUB-TOKEN", ActionInputs.token)
+    monkeypatch.setenv("INPUT_UPDATE-COMMENT", ActionInputs.token)
 
     return ActionInputs()
 
@@ -132,6 +138,7 @@ def report_size_deltas(self):
         repository_name=setup_environment_variables.repository_name,
         sketches_reports_source=setup_environment_variables.sketches_reports_source,
         token=setup_environment_variables.token,
+        update_comment=setup_environment_variables.update_comment == "true",
     )
     ReportSizeDeltas.report_size_deltas.assert_called_once()
 
@@ -768,7 +775,6 @@ def test_comment_report():
     report_size_deltas = get_reportsizedeltas_object(repository_name=repository_name)
 
     report_size_deltas.http_request = unittest.mock.MagicMock()
-    report_size_deltas.get_previous_comment = unittest.mock.Mock(return_value=None)
 
     report_size_deltas.comment_report(pr_number=pr_number, report_markdown=report_markdown)