olympix-notifier installs statistics

This is a notifier Github App for the Olympix Toolsuite. It allows Olympix's tools to report back to the github repo with test results as check runs.

Olympix Notifier GitHub App

This GitHub App is part of the Olympix Toolsuite and enables test result reporting via GitHub Check Runs. It works seamlessly with Olympix’s GitHub Actions—currently supporting the Olympix Mutation Test Generator.

What does it do?

When you install this app on your repository and run the Olympix Mutation Test Generator GitHub Action, it automatically creates a Check Run on your commits. This check includes:

- Mutation testing status (pass/fail based on threshold)

- A JSON payload containing detailed mutation results

You can use the JSON output to power your own scripts or CI/CD decisions in follow-up actions.

Getting Started

To use this GitHub App, you must:

1. Be a premium user of the Olympix Toolsuite.

2. Use the Olympix Mutation Test Generator GitHub Action in your repository.

3. Install this app on your GitHub repository.

The app will automatically activate when the action is triggered.

Required Configuration

Make sure to include the following environment variables in your GitHub Action workflow:

env: OLYMPIX_API_TOKEN: ${{ secrets.OLYMPIX_API_TOKEN }} OLYMPIX_FAIL_MUTATION_GHA_THRESHOLD: 30 OLYMPIX_GITHUB_COMMIT_HEAD_SHA: ${{ github.sha }}

- OLYMPIX_API_TOKEN is your API key (required by the Action). - OLYMPIX_FAIL_MUTATION_GHA_THRESHOLD sets the mutation score threshold (as a percentage) below which the check run will fail. - OLYMPIX_GITHUB_COMMIT_HEAD_SHA determines which commit gets the check run.

Output Format

The result is embedded in the text field of the Check Run as a JSON object, allowing advanced users to script on top of it as needed.

Learn More

- 📘 [Mutation Test Generator Action Docs](http://olympix.github.io/Github%20Actions/mutation-test-generator/) - 📩 Questions? Reach out to us at [contact@olympix.ai](mailto:contact@olympix.ai)

Description from the GitHub Marketplace listing.