Skip to content

Integrate GitHub annotations #31

@ekohl

Description

@ekohl

Similar to how Jenkins can utilize JUnit XML to report failures, GitHub has annotations . The primary benefit is that you don't need to dig into the console output for failures, but rather report them as annotations in the changed files tab.

It depends on the tool/testing framework.

RuboCop

Version 1.2.0 introduced a GitHub formatter (via rubocop/rubocop@e4a25e6). This is enabled via rubocop --formatter github or via similar methods in Rakefile (where it can look at ENV['GITHUB_ACTIONS'] == 'true').

RSpec

There is rspec-github which documents its usage well.

Minitest

There is an open PR to integrate this into the tooling.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions