v0.4.4 (#167)

* 163 initalization is delayed and time taken to launch tests reopen with git enabled (#166)

* Get git information from cli and update docs

* Update unit tests

* Update actions

* Updated checkout to v2 for reporterplus

* Updated windows command

* Updated marketplace docs

* Updated version

Author: reach2jeyan

.github/workflows/actions-test.yml

@@ -35,13 +35,14 @@ jobs:
           poetry run playwright install --with-deps
       
       - name: 🧪 Run playwright test and generate report using marketplace plugin
-        uses: reporterplus/pytest-html-plus-action@v1
+        uses: reporterplus/pytest-html-plus-action@v2
         with:
           htmloutput: "report_output_playwright"
           capturescreenshots: "all"
           testpath: "tests/browser/test_playwright.py"
           usepoetry: "true"
           xmlreport: "report_output_playwright/report.xml"
+          gitbranch: "$(git rev-parse --abbrev-ref HEAD)"
 
       - name: Upload reports
         if: always()

.github/workflows/unit-test-windows.yml

@@ -43,7 +43,7 @@ jobs:
 
       - name: 🧪 Run tests with coverage
         run: |
-          poetry run pytest --cov=pytest_html_plus tests/ --cov-fail-under=39 --cov-report=term --reruns 1 --ignore=tests/browser --generate-xml --xml-report report_output/final_xml_windows.xml
+          poetry run pytest --cov=pytest_html_plus tests/ --cov-fail-under=39 --cov-report=term --reruns 1 --ignore=tests/browser --generate-xml --xml-report report_output/final_xml_windows.xml --git-branch $(git rev-parse --abbrev-ref HEAD)
 
       - name: Upload HTML Report
         if: always()

.github/workflows/unit-test.yml

@@ -33,7 +33,9 @@ jobs:
 
       - name: 🧪 Run tests with coverage
         run: |
-          poetry run pytest --cov=pytest_html_plus tests/ --cov-fail-under=39 --cov-report=term --reruns 1 --ignore=tests/browser --generate-xml --xml-report report_output/final_xml_ubuntu.xml
+          export REPORT_BRANCH="$(git rev-parse --abbrev-ref HEAD)"
+          export REPORT_COMMIT="$(git rev-parse HEAD)"
+          poetry run pytest --cov=pytest_html_plus tests/ --cov-fail-under=39 --cov-report=term --reruns 1 --ignore=tests/browser --generate-xml --xml-report report_output/final_xml_ubuntu.xml --git-branch "$REPORT_BRANCH" --git-commit "$REPORT_COMMIT"
 
       - name: Upload HTML Report
         if: always()

docs/cli/cli.rst

@@ -41,6 +41,20 @@ Overview
      - Path for XML report
      - ``None``
      - Useful when generating multiple output types
+   * - ``--env``
+     - Include environment variables in the execution metadata.
+     - Default: None
+     - Useful for adding CI or custom environment metadata (safe values only).
+   * - ``--git-branch``
+     - Branch name to display in the report.
+     - Default: "NA"
+     - Useful when running tests manually or when CI does not provide branch information.
+   * - ``--git-commit``
+     - Commit SHA to display in the report.
+     - Default: "NA"
+     - Useful for ensuring traceability when CI does not set commit environment variables.
+
+
 
 
 Detailed Option Usage

docs/cli/execution-metadata.rst

@@ -0,0 +1,86 @@
+Version Control & Environment Metadata (``--git-branch``, ``--git-commit``, ``--env``)
+=======================================================================================
+
+These flags allow you to inject version control and environment metadata directly into
+your test execution report. This is particularly useful for CI/CD integrations, manual test
+runs, or ensuring traceability when Git information is not automatically detectable.
+
+Flags Overview
+--------------
+
+- ``--git-branch``
+  Specifies the Git branch name to display in the report.
+  **Default:** ``NA``
+  **Accepted Values:** Any string (e.g., ``main``, ``feature/login-ui``)
+  Useful when running tests manually or in CI systems that do not automatically expose a branch name.
+
+- ``--git-commit``
+  Specifies the Git commit SHA to display in the report.
+  **Default:** ``NA``
+  **Accepted Values:** Any valid commit hash (e.g., ``5bb4c87e9da4ff1780540b25a04725ade5c3bc37``)
+  Helps ensure full traceability of test runs, especially in detached HEAD mode.
+
+- ``--env`` or ``--environment``
+  Adds the value of a specific environment variable to the report metadata.
+  **Default:** ``None``
+  **Accepted Values:** A single environment variable key (e.g., ``BUILD_ID``) or any text of your choice for (e.g. your env name like staging)
+  Useful for adding CI job IDs, build numbers, or other contextual metadata.
+
+Usage Examples
+--------------
+
+**Specify branch and commit explicitly:**
+
+.. code-block:: bash
+
+   pytest --git-branch main --git-commit 5bb4c87
+
+**Include a CI environment variable in the metadata:**
+
+.. code-block:: bash
+
+   pytest --env BUILD_ID
+
+If ``BUILD_ID`` is set in your environment, the report will include:
+
+
+**Combine all three flags for complete control:**
+
+.. code-block:: bash
+
+   export REPORT_BRANCH="$(git rev-parse --abbrev-ref HEAD)"
+   export REPORT_COMMIT="$(git rev-parse HEAD)"
+
+   pytest --git-branch "$REPORT_BRANCH" --git-commit "$REPORT_COMMIT"
+          --env CI_JOB_ID
+
+Use Cases
+---------
+
+- **CI/CD Pipelines**
+  Pass branch, commit, or pipeline identifiers directly into your reports for accurate mapping
+  of test runs to code snapshots.
+
+- **Manual Test Execution**
+  Useful when running tests outside a Git repository, inside a Docker container, or from
+  distributed artifacts where Git metadata may be unavailable.
+
+- **Build & Release Tracking**
+  Supply values like ``BUILD_ID``, ``RUN_NUMBER``, or ``PIPELINE_ID`` so downstream systems
+  can correlate test results with deployments.
+
+Report Contents
+---------------
+
+- When supplied, branch and commit information will be added to the report header.
+- The value of the environment variable provided through ``--env`` will appear as a key/value
+  entry under execution metadata.
+- If the given environment variable does not exist, its value will be shown as ``NA``.
+
+Important Notes
+---------------
+
+- If not provided, both ``--git-branch`` and ``--git-commit`` default to ``NA``.
+- The ``--env`` flag accepts **only one environment variable key per usage**.
+  If you need to include multiple variables, specify the flag multiple times.
+- Avoid using ``--env`` to expose sensitive information such as API tokens or passwords.

docs/marketplace/usage.rst

@@ -99,6 +99,12 @@ pytest-html-plus plugin options.
    * - ``usepoetry``
      - Run pytest through ``poetry run pytest``.
      - ``false``
+   * - ``gitbranch``
+     - Insert value of the branch from the CI
+     - ``NA``
+   * - ``gitcommit``
+     - Insert value of the branch from the CI
+     - ``NA``
 
 
 Examples

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pytest-html-plus"
-version = "0.4.3"
+version = "0.4.4"
 description = "Get started with rich pytest reports in under 3 seconds. Just install the plugin — no setup required. The simplest, fastest reporter for pytest."
 readme = "README.md"
 authors = ["reporterplus"]

pytest_html_plus/compute_git_branch.py

@@ -1,14 +1,15 @@
 import json
 from datetime import datetime
 
-from pytest_html_plus.utils import is_main_worker, get_env_marker, get_git_information, get_report_title, \
+from pytest_html_plus.utils import is_main_worker, get_env_marker, get_report_title, \
     get_python_version
 
 
-def write_plus_metadata_if_main_worker(config, report_path, output_path="plus_metadata.json"):
+def write_plus_metadata_if_main_worker(config, report_path, output_path="plus_metadata.json", **kwargs):
     if not is_main_worker():
         return
-    branch, commit = get_git_information()
+    branch = kwargs.get("git_branch", "NA")
+    commit = kwargs.get("git_commit", "NA")
     metadata = {
         "report_title": get_report_title(output_path=report_path),
         "environment": get_env_marker(config),

pytest_html_plus/compute_report_metadata.py

@@ -162,11 +162,14 @@ def pytest_sessionfinish(session, exitstatus):
 
 def pytest_sessionstart(session):
     html_output = session.config.getoption("--html-output") or "report_output"
+    git_branch = session.config.getoption("--git-branch") or "NA"
+    git_commit = session.config.getoption("--git-commit") or "NA"
     configure_logging()
     session.config.addinivalue_line(
        "markers", "link(url): Add a link to external test case or documentation."
    )
-    write_plus_metadata_if_main_worker(session.config, report_path=html_output)
+    write_plus_metadata_if_main_worker(session.config, report_path=html_output,
+                                       git_branch=git_branch, git_commit=git_commit)
 
 
 def pytest_load_initial_conftests(args):
@@ -221,6 +224,18 @@ def pytest_addoption(parser):
        default=None,
        help="Path to output the XML report (used with --generatexml)"
    )
+   parser.addoption(
+       "--git-branch",
+       action="store",
+       default="NA",
+       help="Helps show branch information on the report"
+   )
+   parser.addoption(
+       "--git-commit",
+       action="store",
+       default="NA",
+       help="Helps show commitId information on the report"
+   )
 
 import logging
 import sys