gradle / gradle/develocity-build-validation-scripts

Add a plain text console mode for environments that do not render ASNI escape codes

Open
#546 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
115
Forks
23
Avg merge
1d 4h
Merged PRs (30d)
6

Description

The Build Validation Scripts utilize ANSI escape codes in the summary section in order to render text with color in terminals that support it. While this is visually pleasant and a reasonable default, not every environment attempts to render color when these codes are encountered. Instead, they are printed as plain text, leading to visual clutter. Notably, Jenkins console logs do not support these escape codes (without plugin support):

Screenshot 2023-12-20 at 7 46 46 AM

To solve this, it would be nice if there were a way to disable these escape codes and just print the plain text output.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not identify a file, command entry point, or test. Begin by locating the Build Validation Scripts' summary output and its ANSI escape-code handling; done means an explicit plain-text mode produces readable output without escape codes, including in Jenkins logs.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.