Tuist

Log in
product

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.

xcodebuild [flags] | xcbeautify --renderer github-actions

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.

An image that shows a GitHub Actions run summary with xcbeautify comments.

Furthermore, you'll find native inline feedback on PRs. This includes compiler warnings, compiler errors, and test failures.

An image that shows a GitHub Actions run with an inline xcbeautify comment.

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.

Unlock your iOS team's full potential

Chat with the founders

You might also like

product
Releasing Tuist 2.0
In this post, we share more details about this new major version of the project, 2.0, and present the direction we are taking as we move towards 3.0.
product
Tuist 0.16.0 allows users to link system libraries and frameworks
From the just released 0.16.0 version of Tuist, users will be able to define dependencies with system libraries and frameworks from their targets. Moreover, we added support for customizing the list of input and output files in their target action, and generation of targets with no build settings at all. This version also ships with minor improvements and bug fixes that had been reported by users.
product
Tuist 0.11.0 has been released
Tuist 0.11.0 is out and it includes features like "tuist up" that help users configure their environment before working with the projects, or support for generating target schemes. This version also adds support for defining environment variables for targets, as well as some minor improvements and fixes.