Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate GitHub annotations #31

Open
ekohl opened this issue Jan 19, 2024 · 1 comment
Open

Integrate GitHub annotations #31

ekohl opened this issue Jan 19, 2024 · 1 comment

Comments

@ekohl
Copy link
Member

ekohl commented Jan 19, 2024

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.

@ekohl
Copy link
Member Author

ekohl commented Jan 23, 2024

For minitest I've created https://rubygems.org/gems/minitest_reporters_github and add it here: theforeman/foreman#10010

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant