Use lowercase for outputs

olivier-lacroix · olivier-lacroix · commit 9147c08c6677 · 2025-09-14T18:48:46.000+10:00
diff --git a/README.md b/README.md
@@ -352,35 +352,35 @@ The action makes available some data for downstream processing.
 
 | Name | Description |
 | --- | --- |
-| `ACTIVITY_RUN` | The type of activity that was run. One of `process_pr`, `post_comment`, `save_coverage_data_files`. |
+| `activity_run` | The type of activity that was run. One of `process_pr`, `post_comment`, `save_coverage_data_files`. |
 
 All the following outputs are only available when running in PR mode.
 
 | Name | Description |
 | --- | --- |
-| `COMMENT_FILE_WRITTEN` | A boolean indicating whether a comment file was written to `COMMENT_FILENAME` or not. |
-| `NEW_COVERED_LINES` | The number of covered lines in the pull request. |
-| `NEW_NUM_STATEMENTS` | The number of statements in the pull request. |
-| `NEW_PERCENT_COVERED` | The coverage percentage of the pull request. |
-| `NEW_MISSING_LINES` | The number of lines with missing coverage in the pull request. |
-| `NEW_EXCLUDED_LINES` | The number of excluded lines in the pull request. |
-| `NEW_NUM_BRANCHES` | The number of branches in the pull request. |
-| `NEW_NUM_PARTIAL_BRANCHES` | The number of partial branches in the pull request. |
-| `NEW_COVERED_BRANCHES` | The number of covered branches in the pull request. |
-| `NEW_MISSING_BRANCHES` | The number of branches with missing coverage in the pull request. |
-| `REFERENCE_COVERED_LINES` | The number of covered lines in the base branch. |
-| `REFERENCE_NUM_STATEMENTS` | The number of statements in the base branch. |
-| `REFERENCE_PERCENT_COVERED` | The coverage percentage of the base branch. |
-| `REFERENCE_MISSING_LINES` | The number of lines with missing coverage in the base branch. |
-| `REFERENCE_EXCLUDED_LINES` | The number of excluded lines in the base branch. |
-| `REFERENCE_NUM_BRANCHES` | The number of branches in the base branch. |
-| `REFERENCE_NUM_PARTIAL_BRANCHES` | The number of partial branches in the base branch. |
-| `REFERENCE_COVERED_BRANCHES` | The number of covered branches in the base branch. |
-| `REFERENCE_MISSING_BRANCHES` | The number of branches with missing coverage in the base branch. |
-| `DIFF_TOTAL_NUM_LINES` | The total number of lines in the diff. |
-| `DIFF_TOTAL_NUM_VIOLATIONS` | The total number of lines with missing coverage in the diff. |
-| `DIFF_TOTAL_PERCENT_COVERED` | The coverage percentage of the diff. |
-| `DIFF_NUM_CHANGED_LINES` | The number of changed lines in the diff. |
+| `comment_file_written` | A boolean indicating whether a comment file was written to `COMMENT_FILENAME` or not. |
+| `new_covered_lines` | The number of covered lines in the pull request. |
+| `new_num_statements` | The number of statements in the pull request. |
+| `new_percent_covered` | The coverage percentage of the pull request. |
+| `new_missing_lines` | The number of lines with missing coverage in the pull request. |
+| `new_excluded_lines` | The number of excluded lines in the pull request. |
+| `new_num_branches` | The number of branches in the pull request. |
+| `new_num_partial_branches` | The number of partial branches in the pull request. |
+| `new_covered_branches` | The number of covered branches in the pull request. |
+| `new_missing_branches` | The number of branches with missing coverage in the pull request. |
+| `reference_covered_lines` | The number of covered lines in the base branch. |
+| `reference_num_statements` | The number of statements in the base branch. |
+| `reference_percent_covered` | The coverage percentage of the base branch. |
+| `reference_missing_lines` | The number of lines with missing coverage in the base branch. |
+| `reference_excluded_lines` | The number of excluded lines in the base branch. |
+| `reference_num_branches` | The number of branches in the base branch. |
+| `reference_num_partial_branches` | The number of partial branches in the base branch. |
+| `reference_covered_branches` | The number of covered branches in the base branch. |
+| `reference_missing_branches` | The number of branches with missing coverage in the base branch. |
+| `diff_total_num_lines` | The total number of lines in the diff. |
+| `diff_total_num_violations` | The total number of lines with missing coverage in the diff. |
+| `diff_total_percent_covered` | The coverage percentage of the diff. |
+| `diff_num_changed_lines` | The number of changed lines in the diff. |
 
 Usage may look like this
 
@@ -392,7 +392,7 @@ Usage may look like this
     GITHUB_TOKEN: ${{ github.token }}
 
 - name: Enforce coverage
-  if: ${{ steps.coverage_comment.outputs.NEW_PERCENT_COVERED < steps.coverage_comment.outputs.REFERENCE_PERCENT_COVERED }}
+  if: ${{ steps.coverage_comment.outputs.new_percent_covered < steps.coverage_comment.outputs.reference_percent_covered }}
   run: echo "Coverage decreased." && exit 1
 ```
 
diff --git a/action.yml b/action.yml
@@ -111,58 +111,58 @@ inputs:
       Deprecated, see https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging
     default: false
 outputs:
-  ACTIVITY_RUN:
+  activity_run:
     description: >
       The type of activity that was run. One of `process_pr`, `post_comment`, `save_coverage_data_files`.
-  COMMENT_FILE_WRITTEN:
+  comment_file_written:
     description: >
       A boolean indicating whether a comment file was written to COMMENT_FILENAME or not.
       If so, you'll need to run the action in workflow_run mode to post it. If "false",
       no comment file was written (likely because the comment was already posted to the PR).
       Only available when running in PR mode.
-  NEW_COVERED_LINES:
+  new_covered_lines:
     description: The number of covered lines in the pull request. (Only available in PR mode)
-  NEW_NUM_STATEMENTS:
+  new_num_statements:
     description: The number of statements in the pull request. (Only available in PR mode)
-  NEW_PERCENT_COVERED:
+  new_percent_covered:
     description: The coverage percentage of the pull request. (Only available in PR mode)
-  NEW_MISSING_LINES:
+  new_missing_lines:
     description: The number of lines with missing coverage in the pull request. (Only available in PR mode)
-  NEW_EXCLUDED_LINES:
+  new_excluded_lines:
     description: The number of excluded lines in the pull request. (Only available in PR mode)
-  NEW_NUM_BRANCHES:
+  new_num_branches:
     description: The number of branches in the pull request. (Only available in PR mode)
-  NEW_NUM_PARTIAL_BRANCHES:
+  new_num_partial_branches:
     description: The number of partial branches in the pull request. (Only available in PR mode)
-  NEW_COVERED_BRANCHES:
+  new_covered_branches:
     description: The number of covered branches in the pull request. (Only available in PR mode)
-  NEW_MISSING_BRANCHES:
+  new_missing_branches:
     description: The number of branches with missing coverage in the pull request. (Only available in PR mode)
-  REFERENCE_COVERED_LINES:
+  reference_covered_lines:
     description: The number of covered lines in the base branch. (Only available in PR mode)
-  REFERENCE_NUM_STATEMENTS:
+  reference_num_statements:
     description: The number of statements in the base branch. (Only available in PR mode)
-  REFERENCE_PERCENT_COVERED:
+  reference_percent_covered:
     description: The coverage percentage of the base branch. (Only available in PR mode)
-  REFERENCE_MISSING_LINES:
+  reference_missing_lines:
     description: The number of lines with missing coverage in the base branch. (Only available in PR mode)
-  REFERENCE_EXCLUDED_LINES:
+  reference_excluded_lines:
     description: The number of excluded lines in the base branch. (Only available in PR mode)
-  REFERENCE_NUM_BRANCHES:
+  reference_num_branches:
     description: The number of branches in the base branch. (Only available in PR mode)
-  REFERENCE_NUM_PARTIAL_BRANCHES:
+  reference_num_partial_branches:
     description: The number of partial branches in the base branch. (Only available in PR mode)
-  REFERENCE_COVERED_BRANCHES:
+  reference_covered_branches:
     description: The number of covered branches in the base branch. (Only available in PR mode)
-  REFERENCE_MISSING_BRANCHES:
+  reference_missing_branches:
     description: The number of branches with missing coverage in the base branch. (Only available in PR mode)
-  DIFF_TOTAL_NUM_LINES:
+  diff_total_num_lines:
     description: The total number of lines in the diff. (Only available in PR mode)
-  DIFF_TOTAL_NUM_VIOLATIONS:
+  diff_total_num_violations:
     description: The total number of lines with missing coverage in the diff. (Only available in PR mode)
-  DIFF_TOTAL_PERCENT_COVERED:
+  diff_total_percent_covered:
     description: The coverage percentage of the diff. (Only available in PR mode)
-  DIFF_NUM_CHANGED_LINES:
+  diff_num_changed_lines:
     description: The number of changed lines in the diff. (Only available in PR mode)
 runs:
   using: docker
diff --git a/coverage_comment/coverage.py b/coverage_comment/coverage.py
@@ -21,8 +21,20 @@ class CoverageMetadata:
     show_contexts: bool
 
 
+class OutputMixin:
+    def as_output(self, prefix: str) -> dict:
+        data = dataclasses.asdict(self)
+        output = {}
+        for key, value in data.items():
+            if value is not None and not isinstance(value, dict):
+                output[f"{prefix}_{key}"] = (
+                    float(value) if isinstance(value, decimal.Decimal) else value
+                )
+        return output
+
+
 @dataclasses.dataclass(kw_only=True)
-class CoverageInfo:
+class CoverageInfo(OutputMixin):
     covered_lines: int
     num_statements: int
     percent_covered: decimal.Decimal
@@ -33,16 +45,6 @@ class CoverageInfo:
     covered_branches: int = 0
     missing_branches: int = 0
 
-    def as_output(self, prefix: str) -> dict:
-        data = dataclasses.asdict(self)
-        output = {}
-        for key, value in data.items():
-            if value is not None:
-                output[f"{prefix}_{key.upper()}"] = (
-                    float(value) if isinstance(value, decimal.Decimal) else value
-                )
-        return output
-
 
 @dataclasses.dataclass(kw_only=True)
 class FileCoverage:
@@ -86,23 +88,13 @@ def violation_lines(self) -> list[int]:
 
 
 @dataclasses.dataclass(kw_only=True)
-class DiffCoverage:
+class DiffCoverage(OutputMixin):
     total_num_lines: int
     total_num_violations: int
     total_percent_covered: decimal.Decimal
     num_changed_lines: int
     files: dict[pathlib.Path, FileDiffCoverage]
 
-    def as_output(self, prefix: str) -> dict:
-        data = dataclasses.asdict(self)
-        output = {}
-        for key, value in data.items():
-            if value is not None and not isinstance(value, dict):
-                output[f"{prefix}_{key.upper()}"] = (
-                    float(value) if isinstance(value, decimal.Decimal) else value
-                )
-        return output
-
 
 def compute_coverage(
     num_covered: int,
diff --git a/coverage_comment/main.py b/coverage_comment/main.py
@@ -268,11 +268,11 @@ def process_pr(
             ],
         )
 
-    outputs = {"ACTIVITY_RUN": "process_pr"}
-    outputs |= coverage.info.as_output(prefix="NEW")
-    outputs |= diff_coverage.as_output(prefix="DIFF")
+    outputs = {"activity_run": "process_pr"}
+    outputs |= coverage.info.as_output(prefix="new")
+    outputs |= diff_coverage.as_output(prefix="diff")
     if previous_coverage:
-        outputs |= previous_coverage.info.as_output(prefix="REFERENCE")
+        outputs |= previous_coverage.info.as_output(prefix="reference")
 
     try:
         if config.FORCE_WORKFLOW_RUN or not pr_number:
@@ -298,10 +298,10 @@ def process_pr(
             filename=config.FINAL_COMMENT_FILENAME,
             content=comment,
         )
-        outputs |= {"COMMENT_FILE_WRITTEN": True}
+        outputs["comment_file_written"] = True
         log.debug("Comment stored locally on disk")
     else:
-        outputs |= {"COMMENT_FILE_WRITTEN": False}
+        outputs["comment_file_written"] = False
         log.debug("Comment not generated")
 
     github.set_output(
@@ -371,7 +371,7 @@ def post_comment(
     )
     log.info("Comment posted in PR")
 
-    github.set_output(github_output=config.GITHUB_OUTPUT, ACTIVITY_RUN="post_comment")
+    github.set_output(github_output=config.GITHUB_OUTPUT, activity_run="post_comment")
     return 0
 
 
@@ -450,7 +450,7 @@ def save_coverage_data_files(
     log.info(log_message)
 
     github.set_output(
-        github_output=config.GITHUB_OUTPUT, ACTIVITY_RUN="save_coverage_data_files"
+        github_output=config.GITHUB_OUTPUT, activity_run="save_coverage_data_files"
     )
 
     return 0
diff --git a/tests/integration/test_main.py b/tests/integration/test_main.py
@@ -66,34 +66,34 @@ def get_expected_output(
     comment_written: bool, reference_coverage: bool
 ) -> dict[str, str]:
     output = {
-        "ACTIVITY_RUN": '"process_pr"',
-        "COMMENT_FILE_WRITTEN": str(comment_written).lower(),
-        "NEW_COVERED_LINES": "7",
-        "NEW_NUM_STATEMENTS": "9",
-        "NEW_PERCENT_COVERED": "0.7777777777777778",
-        "NEW_MISSING_LINES": "2",
-        "NEW_EXCLUDED_LINES": "0",
-        "NEW_NUM_BRANCHES": "0",
-        "NEW_NUM_PARTIAL_BRANCHES": "0",
-        "NEW_COVERED_BRANCHES": "0",
-        "NEW_MISSING_BRANCHES": "0",
-        "DIFF_TOTAL_NUM_LINES": "4",
-        "DIFF_TOTAL_NUM_VIOLATIONS": "1",
-        "DIFF_TOTAL_PERCENT_COVERED": "0.75",
-        "DIFF_NUM_CHANGED_LINES": "6",
+        "activity_run": '"process_pr"',
+        "comment_file_written": str(comment_written).lower(),
+        "new_covered_lines": "7",
+        "new_num_statements": "9",
+        "new_percent_covered": "0.7777777777777778",
+        "new_missing_lines": "2",
+        "new_excluded_lines": "0",
+        "new_num_branches": "0",
+        "new_num_partial_branches": "0",
+        "new_covered_branches": "0",
+        "new_missing_branches": "0",
+        "diff_total_num_lines": "4",
+        "diff_total_num_violations": "1",
+        "diff_total_percent_covered": "0.75",
+        "diff_num_changed_lines": "6",
     }
     if reference_coverage:
         output.update(
             {
-                "REFERENCE_COVERED_LINES": "3",
-                "REFERENCE_NUM_STATEMENTS": "10",
-                "REFERENCE_PERCENT_COVERED": "0.3",
-                "REFERENCE_MISSING_LINES": "7",
-                "REFERENCE_EXCLUDED_LINES": "0",
-                "REFERENCE_NUM_BRANCHES": "0",
-                "REFERENCE_NUM_PARTIAL_BRANCHES": "0",
-                "REFERENCE_COVERED_BRANCHES": "0",
-                "REFERENCE_MISSING_BRANCHES": "0",
+                "reference_covered_lines": "3",
+                "reference_num_statements": "10",
+                "reference_percent_covered": "0.3",
+                "reference_missing_lines": "7",
+                "reference_excluded_lines": "0",
+                "reference_num_branches": "0",
+                "reference_num_partial_branches": "0",
+                "reference_covered_branches": "0",
+                "reference_missing_branches": "0",
             }
         )
     return output
