XCBeautify: Supporting GitHub Actions Annotations
Learn about the latest xcbeautify renderer.
Overview
XCBeautify now features an output format option for GitHub Actions.
Getting Started
To utilize this function, simply run xcbeautify and add the --renderer github-actions flag during execution.
How It Works
When you use the GitHub Actions renderer, xcbeautify formats output that harnesses workflow commands to highlight warnings, errors, and other results directly within the GitHub user interface.
When you run a pull request check with the GitHub Actions renderer, you’ll find all xcodebuild results and feedback in the Annotations section of the run summary.
Furthermore, you’ll find native inline feedback on PRs. This includes compiler warnings, compiler errors, and test failures.
By using this feature, you may avoid the need for additional third-party tools, such as Danger and related dependencies, to report a summary of xcodebuild output.
Introducing Renderers
As of 0.21.0, xcbeautify adds the Renderer concept. Renderer specifies the way you want xcbeautify to format its output.
Historically, xcbeautify has only supported one command line output format. This is now the format provided by the TerminalRenderer, and it’s the default option.
Renderer provides the groundwork to add other output formats, such as for other CI/CD providers.
Final Thoughts
If you’d like to learn more about this change, you can find the introductory pull request here.
Thank you to Eli Perkins for providing support and direction on this change and supporting GitHub Actions annotations.
Feedback
If you’d like to provide feedback or a contribution, please consider opening an issue or pull request.