pytest Integration with CI Insights

This guide explains how to integrate Pytest with CI Insights using the pytest-mergify plugin. Once installed, test results are automatically uploaded to CI Insights without any extra workflow changes.

You need to install the pytest-mergify plugin to automatically upload your test results to CI Insights. This can be done in different way depending on your way of managing your Python dependencies. Below are a few examples:

pip install pytest-mergify

Or add pytest-mergify to your requirements.txt.

setup(
    name="your-package",
    ...
    install_requires=[
        ...
    ],
    extras_require={
        "dev": ["pytest-mergify"]
    },
    ...
)

Make sure those dependencies are installed when running your tests.

[options.extras_require]
dev =
    pytest-mergify

Make sure those dependencies are installed when running your tests.

poetry add --group dev pytest-mergify

Your workflow should run your test as usual while exporting the secret MERGIFY_TOKEN as an environment variable. You’ll need to add the following code to the GitHub Actions step running your tests:

env:
  MERGIFY_TOKEN: ${{ secrets.MERGIFY_TOKEN }}

For example:

- name: Run Tests 🧪
  env:
    MERGIFY_TOKEN: ${{ secrets.MERGIFY_TOKEN }}
  run: pytest

The plugin collects your test results and sends them to CI Insights. Check the CI Insights dashboard afterward to view execution metrics, detect flaky tests, and gather actionable feedback.