Skip to content

feat: add --auto-file-issue flag to automatically create GitHub Issues on test failure #428

@A-d-i-t-y

Description

@A-d-i-t-y

Reason/Context

Why we need this:
When microcks test fails in GitHub Actions CI, developers only
see a red check and plain text logs. There is no structured way
to track which tests failed and why.

How this will help:
A new --auto-file-issue flag will automatically create a structured
GitHub Issue containing failed operations, reproduction command,
test endpoint, runner used, and a link to full results on Microcks UI.

Motivation:
This improves CI/CD observability and reduces time spent debugging
test failures in GitHub Actions pipelines.

Description

Problem

When microcks test fails in GitHub Actions CI, developers see:

  • A red check mark
  • Plain text logs buried in CI output

There is no automatic way to track, reproduce, or assign test failures.

Proposed Solution

Add --auto-file-issue flag to the test command that:

  1. Detects test failure
  2. Uses GitHub API to create a structured Issue with:
    • Which operations failed
    • Exact reproduction command
    • Test endpoint and runner used
    • Link to full test result on Microcks UI

Example Usage

microcks test 'Beer API:1.0' $URL POSTMAN
--microcksURL=$MICROCKS_URL
--auto-file-issue
--github-token=$GITHUB_TOKEN
--github-repo=org/repo

Example Issue Created

Title: [Microcks] Test Failed: Beer API v1.0
Body:

Implementation ideas

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions