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.

Supercharge your Swift app development

Get started

You might also like

1.18.0 Himalaya - Documentation generation, Swift interface for accessing resources, and code linting
Tuist 1.18.0 is packed with interesting automatomation feature that will streamline developers' workflows further. This new version provides commands for auto-generating documentation and linting the Swift code, and integrates the generation of Swift interfaces for resources into the project generation.
Workspace improvements with Tuist 0.13.0
The just baked new version of Tuist, 0.13.0, is already with us. We added significant improvements to workspaces like being able to define additional files that are added to the project. We also aligned the structured of the generated workspaces to match the filesystem. This version also makes sure that for those test targets that depend on a host application are set up with the right settings.
Releasing Tuist 3.0
Highlighting updates from the 3.0 release and first Tuist Cloud preview.