Adds support for Github pages html url coverage report

Author: daniel-anya

action.yml

@@ -102,6 +102,10 @@ inputs:
       notice, warning and error as annotation type. For more information look here:
       https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-a-notice-message
     default: warning
+  USE_GH_PAGES_HTML_URL:
+    description: >
+      If true, will use the GitHub Pages URL for the coverage report instead of the raw URL or an htmlpreview.github.io link.
+    default: false
   VERBOSE:
     description: >
       Deprecated, see https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging

coverage_comment/main.py

@@ -430,6 +430,7 @@ def save_coverage_data_files(
         github_host=github_host,
         branch=config.FINAL_COVERAGE_DATA_BRANCH,
         repository=config.GITHUB_REPOSITORY,
+        use_gh_pages_html_url=config.USE_GH_PAGES_HTML_URL,
     )
     readme_file, log_message = communication.get_readme_and_log(
         is_public=is_public,

coverage_comment/settings.py

@@ -63,6 +63,7 @@ class Config:
     ANNOTATE_MISSING_LINES: bool = False
     ANNOTATION_TYPE: str = "warning"
     MAX_FILES_IN_COMMENT: int = 25
+    USE_GH_PAGES_HTML_URL: bool = False
     VERBOSE: bool = False
     # Only for debugging, not exposed in the action:
     FORCE_WORKFLOW_RUN: bool = False

coverage_comment/storage.py

@@ -172,10 +172,36 @@ def get_repo_file_url(
     return f"{github_host}/{repository}/{part}/{branch}{path}".rstrip("/")
 
 
-def get_html_report_url(github_host: str, repository: str, branch: str) -> str:
+def get_html_report_url(
+    github_host: str,
+    repository: str,
+    branch: str,
+    use_gh_pages_html_url: bool = False,
+) -> str:
+    """
+    Computes the URL for an HTML report:
+    - If use_gh_pages_html_url is True:
+        * GitHub.com => https://<user_or_org>.github.io/<repo>/<pages_path>
+        * GitHub Enterprise => https://<host>/pages/<user_or_org>/<repo>/<pages_path>
+    - If use_gh_pages_html_url is False:
+        * GitHub.com => https://htmlpreview.github.io/?<readme_url>
+        * GitHub Enterprise => <readme_url>
+    """
+    html_report_path = "htmlcov/index.html"
     readme_url = get_repo_file_url(
-        github_host, repository=repository, branch=branch, path="/htmlcov/index.html"
+        github_host, repository=repository, branch=branch, path=html_report_path
     )
+
     if github_host.endswith("github.com"):
-        return f"https://htmlpreview.github.io/?{readme_url}"
+        if use_gh_pages_html_url:
+            user, repo = repository.split("/", 1)
+            return f"https://{user}.github.io/{repo}/{html_report_path}"
+        else:
+            return f"https://htmlpreview.github.io/?{readme_url}"
+    else:
+        # Assume GitHub Enterprise
+        if use_gh_pages_html_url:
+            return f"{github_host}/pages/{repository}/{html_report_path}"
+
+    # Always fallback to the raw readme_url
     return readme_url

tests/integration/test_github.py

@@ -45,20 +45,28 @@ def test_get_repository_info(gh, session):
 
     assert info == github.RepositoryInfo(default_branch="baz", visibility="public")
 
+
 @pytest.mark.parametrize(
     "api_url, expected",
     [
         ("https://api.github.com/repos/foo/bar", "https://github.com"),
         ("https://api.github.com:8080/repos/foo/bar", "https://github.com:8080"),
         ("https://api.github.com/repos/foo/bar/issues", "https://github.com"),
-        ("https://my-ghe.company.com/api/v3/repos/foo/bar", "https://my-ghe.company.com"),
-        ("https://my-ghe.company.com/api/v3/repos/foo/bar/issues", "https://my-ghe.company.com"),
-    ]
+        (
+            "https://my-ghe.company.com/api/v3/repos/foo/bar",
+            "https://my-ghe.company.com",
+        ),
+        (
+            "https://my-ghe.company.com/api/v3/repos/foo/bar/issues",
+            "https://my-ghe.company.com",
+        ),
+    ],
 )
 def test_extract_github_host(api_url, expected):
     result = github.extract_github_host(api_url=api_url)
     assert result == expected
 
+
 def test_download_artifact(gh, session, zip_bytes):
     artifacts = [
         {"name": "bar", "id": 456},

tests/unit/test_storage.py

@@ -227,20 +227,35 @@ def test_get_repo_file_url__no_path(github_host):
 
 
 @pytest.mark.parametrize(
-    "github_host, expected",
+    "github_host,use_gh_pages_html_url,expected",
     [
         (
             "https://github.com",
+            True,
+            "https://foo.github.io/bar/htmlcov/index.html",
+        ),
+        (
+            "https://github.com",
+            False,
             "https://htmlpreview.github.io/?https://github.com/foo/bar/blob/baz/htmlcov/index.html",
         ),
         (
             "https://github.mycompany.com",
+            True,
+            "https://github.mycompany.com/pages/foo/bar/htmlcov/index.html",
+        ),
+        (
+            "https://github.mycompany.com",
+            False,
             "https://github.mycompany.com/foo/bar/blob/baz/htmlcov/index.html",
         ),
     ],
 )
-def test_get_html_report_url(github_host, expected):
+def test_get_html_report_url(github_host, use_gh_pages_html_url, expected):
     result = storage.get_html_report_url(
-        github_host=github_host, repository="foo/bar", branch="baz"
+        github_host=github_host,
+        repository="foo/bar",
+        branch="baz",
+        use_gh_pages_html_url=use_gh_pages_html_url,
     )
     assert result == expected