Introduce configuration setting for displaying issue and pull request labels in rich truecolor #10720

andyfeller · 2025-04-02T22:45:21Z

Fixes github/cli#834
Fixes github/cli#835

The GitHub CLI is working to provide an accessible, out-of-the-box experience for users with color being a major area of improvement. This PR is focused on how issue and pull request labels are displayed in terminals that support 24-bit truecolor. In a truecolor terminal, there are several gh commands that would display labels using their custom RGB hex codes. However, these colors might not be minimally contrasting with users' background colors. Without terminal support to change how truecolors are rendered, this creates a challenge for GitHub CLI users with low vision.

This pull request introduces the new color_labels configuration setting and GH_COLOR_LABELS environment variable that can be used with gh config set to enable displaying labels using their truecolor RGB hex codes in several gh commands:

gh issue list
gh issue status
gh issue view
gh label list
gh pr view

Demo

`gh config`

`gh environment`

`gh issue list`

Default
Color enabled

`gh issue status`

Default
Color enabled

`gh issue view`

Default
Color enabled

`gh label list`

Default
Color enabled

`gh pr view`

Default
Color enabled

This commit implements the actual changes around configuration setting / environment variable logic for displaying labels using their RGB hex color code in terminals with truecolor support. One of the subtler changes in this commit is renaming generic ColorScheme.HexToRGB logic to render truecolor to ColorScheme.Label as this feature was being used exclusively for labels. This is due to confusion about introducing the new `color_labels` config on top of generic coloring logic.

pkg/iostreams/color.go

This commit adds the new environment variable to the `gh environment` help topic. Additionally, there is a small fix for Go linter for an unused variable raised as a problem.

This commit completely removes the iostreams.NewColorScheme() initializer function in favor of exporting the type fields for greater clarity in its use. The result being code specifying only the fields that matter to test cases.

williammartin

Looks really good as I was following acceptance, thanks for all the screenshots. Happy for you to approve and make a call on the env var.

williammartin · 2025-04-08T13:32:27Z

pkg/iostreams/color.go

-
-func (c *ColorScheme) Enabled() bool {
-	return c.enabled
+	// Enabled is whether color is used at all.


Food For Thought

Not for this PR, but it really looks to me here like there is role trying to get out here.

Think:

type NoColor struct{} // all funcs return t with no further formatting type ANSIColor struct{ Theme: string } // all funcs return base-16 colors type RichColor struct{ ANSIColor: ANSIColor, Theme: string, ColorLabels: bool } // upgrade colors if possible, otherwise fall back to ANSI

Then most of the conditionals would go away and a pattern would be set for what is acceptable for the different levels of color support.

I think you're touching on an important smell that we should address in a follow up. 💯

Basically, it would be easier to reason and affect change if we moved from this collection of fields on a single type to specialized types that encapsulate scheme-specific behaviors.

williammartin · 2025-04-08T13:37:30Z

pkg/cmd/factory/default.go

 	}

+	if _, ghColorLabels := os.LookupEnv("GH_COLOR_LABELS"); ghColorLabels {
+		io.SetColorLabels(true) // TODO: should this be a truthy value?


I think probably just for conventions sake of being able to disable something that is otherwise configured on? Like if you have it configured in config and then want to disable it.

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | minor | `v2.69.0` -> `v2.72.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>cli/cli (cli/cli)</summary> ### [`v2.72.0`](https://github.com/cli/cli/releases/tag/v2.72.0): GitHub CLI 2.72.0 [Compare Source](cli/cli@v2.71.2...v2.72.0) ####

Accessibility public preview This release marks the public preview of several accessibility improvements to the GitHub CLI that have been under development over the past year in partnership with our friends at [Charm](https://github.com/charmbracelet) including: - customizable and contrasting colors - non-interactive user input prompting - text-based spinners These new experiences are captured in a new `gh a11y` help topic command, which goes into greater detail into the motivation behind each of them as well as opt-in configuration settings / environment variables. We would like you to share your feedback and join us on this journey through one of [GitHub Accessibility feedback channels](https://accessibility.github.com/feedback)! 🙌 #### What's Changed ##### ✨ Features - Introduce `gh accessibility` help topic highlighting GitHub CLI accessibility experiences by [@andyfeller](https://github.com/andyfeller) in cli/cli#10890 - \[gh pr view] Support `closingIssuesReferences` JSON field by [@iamazeem](https://github.com/iamazeem) in cli/cli#10544 ##### 🐛 Fixes - Fix expected error output of `TestRepo/repo-set-default` by [@aconsuegra](https://github.com/aconsuegra) in cli/cli#10884 - Ensure accessible password and auth token prompters disable echo mode by [@andyfeller](https://github.com/andyfeller) in cli/cli#10885 - Fix: Accessible multiselect prompt respects default selections by [@BagToad](https://github.com/BagToad) in cli/cli#10901 #### New Contributors - [@aconsuegra](https://github.com/aconsuegra) made their first contribution in cli/cli#10884 **Full Changelog**: cli/cli@v2.71.2...v2.72.0 ### [`v2.71.2`](https://github.com/cli/cli/releases/tag/v2.71.2): GitHub CLI 2.71.2 [Compare Source](cli/cli@v2.71.1...v2.71.2) #### What's Changed - Fix pr create when push.default tracking and no merge ref by [@williammartin](https://github.com/williammartin) in cli/cli#10863 **Full Changelog**: cli/cli@v2.71.1...v2.71.2 ### [`v2.71.1`](https://github.com/cli/cli/releases/tag/v2.71.1): GitHub CLI 2.71.1 [Compare Source](cli/cli@v2.71.0...v2.71.1) #### What's Changed - Fix pr create when branch name contains slashes by [@williammartin](https://github.com/williammartin) in cli/cli#10859 **Full Changelog**: cli/cli@v2.71.0...v2.71.1 ### [`v2.71.0`](https://github.com/cli/cli/releases/tag/v2.71.0): GitHub CLI 2.71.0 [Compare Source](cli/cli@v2.70.0...v2.71.0) #### What's Changed ##### ✨ Features - `gh pr create`: Support Git's `@{push}` revision syntax for determining head ref by [@BagToad](https://github.com/BagToad) in cli/cli#10513 - Introduce option to opt-out of spinners by [@BagToad](https://github.com/BagToad) in cli/cli#10773 - Update configuration support for accessible colors by [@andyfeller](https://github.com/andyfeller) in cli/cli#10820 - `gh config`: add config settings for accessible prompter and disabling spinner by [@BagToad](https://github.com/BagToad) in cli/cli#10846 ##### 🐛 Fixes - Fix multi pages search for gh search by [@leudz](https://github.com/leudz) in cli/cli#10767 - Fix: `project` commands use shared progress indicator by [@BagToad](https://github.com/BagToad) in cli/cli#10817 - Issue commands should parse args early by [@williammartin](https://github.com/williammartin) in cli/cli#10811 - Feature detect v1 projects on `issue view` by [@williammartin](https://github.com/williammartin) in cli/cli#10813 - Feature detect v1 projects on non web-mode `issue create` by [@williammartin](https://github.com/williammartin) in cli/cli#10815 - Feature detect v1 projects on web mode issue create by [@williammartin](https://github.com/williammartin) in cli/cli#10818 - Feature detect v1 projects on issue edit by [@williammartin](https://github.com/williammartin) in cli/cli#10819 ##### 📚 Docs & Chores - Refactor Sigstore verifier logic by [@malancas](https://github.com/malancas) in cli/cli#10750 #####

Dependencies - chore(deps): bump github.com/sigstore/sigstore-go from 0.7.1 to 0.7.2 by [@dependabot](https://github.com/dependabot) in cli/cli#10787 - Bump google.golang.org/grpc from 1.71.0 to 1.71.1 by [@dependabot](https://github.com/dependabot) in cli/cli#10758 #### New Contributors - [@leudz](https://github.com/leudz) made their first contribution in cli/cli#10767 **Full Changelog**: cli/cli@v2.70.0...v2.71.0 ### [`v2.70.0`](https://github.com/cli/cli/releases/tag/v2.70.0): GitHub CLI 2.70.0 [Compare Source](cli/cli@v2.69.0...v2.70.0) #### Accessibility This release contains dark shipped changes that are part of a larger GitHub CLI accessibility preview still under development. More information about these will be announced later this month including various channels to work with GitHub and GitHub CLI maintainers on shaping these experiences. ##### Ensure table headers are thematically contrasting [#8292](cli/cli#8292) is a long time issue where table headers were difficult to see in terminals with light background. Ahead of the aforementioned preview, `v2.70.0` has shipped changes that improve the out-of-the-box experience based on terminal background detection. The following screenshots demonstrate the Mac Terminal using the Basic profile, which responds to user's appearance preferences: <img width="1512" alt="Screenshot of gh repo list in light background terminal" src="https://github.com/user-attachments/assets/87413dde-eec8-43eb-9c16-dc84f8249ddf" /> <img width="1512" alt="Screenshot of gh repo list in dark background terminal" src="https://github.com/user-attachments/assets/7430b42c-7267-402b-b565-a296beb4d5ea" /> For more information including demos from various official distributions, see [#10649](cli/cli#10649). #### What's Changed ##### ✨ Features - Update go-gh and document available sprig funcs by [@BagToad](https://github.com/BagToad) in cli/cli#10680 - Introducing experimental support for rendering markdown with customizable, accessible colors by [@andyfeller](https://github.com/andyfeller) [@jtmcg](https://github.com/jtmcg) in cli/cli#10680 - Ensure table datetime columns have thematic, customizable muted text by [@andyfeller](https://github.com/andyfeller) in cli/cli#10709 - Ensure table headers are thematically contrasting by [@andyfeller](https://github.com/andyfeller) in cli/cli#10649 - Introduce configuration setting for displaying issue and pull request labels in rich truecolor by [@andyfeller](https://github.com/andyfeller) in cli/cli#10720 - Ensure muted text is thematic and customizable by [@andyfeller](https://github.com/andyfeller) in cli/cli#10737 - \[gh repo create] Show host name in repo creation prompts by [@iamazeem](https://github.com/iamazeem) in cli/cli#10516 - Introduce accessible prompter for screen readers (preview) by [@BagToad](https://github.com/BagToad) in cli/cli#10710 ##### 🐛 Fixes - `run list`: do not fail on organization/enterprise ruleset imposed workflows by [@BagToad](https://github.com/BagToad) in cli/cli#10660 - Implement safeguard for `gh alias delete` test, prevent wiping out GitHub CLI configuration by [@andyfeller](https://github.com/andyfeller) in cli/cli#10683 - Pin third party actions to commit sha by [@BagToad](https://github.com/BagToad) in cli/cli#10731 - Fallback to job run logs when step logs are missing by [@babakks](https://github.com/babakks) in cli/cli#10740 - \[gh ext] Fix `GitKind` extension directory path by [@iamazeem](https://github.com/iamazeem) in cli/cli#10609 - Fix job log resolution to skip legacy logs in favour of normal/new ones by [@babakks](https://github.com/babakks) in cli/cli#10769 ##### 📚 Docs & Chores - `./script/sign` cleanup by [@iamazeem](https://github.com/iamazeem) in cli/cli#10599 - Fix typos in CONTRIBUTING.md by [@rylwin](https://github.com/rylwin) in cli/cli#10657 - Improve `gh at verify --help`, document json output by [@phillmv](https://github.com/phillmv) in cli/cli#10685 - Acceptance test issue/pr create/edit with project by [@williammartin](https://github.com/williammartin) in cli/cli#10707 - Escape dots in regexp pattern in `README.md` by [@babakks](https://github.com/babakks) in cli/cli#10742 - Simplify cosign verification example by not using a regex. by [@kommendorkapten](https://github.com/kommendorkapten) in cli/cli#10759 - Document UNKNOWN STEP in run view by [@williammartin](https://github.com/williammartin) in cli/cli#10770 #####

Dependencies - Update github.com/sigstore/sigstore-go to 0.7.1 and fix breaking function change by [@malancas](https://github.com/malancas) in cli/cli#10749 #### New Contributors - [@rylwin](https://github.com/rylwin) made their first contribution in cli/cli#10657 **Full Changelog**: cli/cli@v2.69.0...v2.70.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

andyfeller added 2 commits April 2, 2025 18:24

Fix comment language

5f03c20

andyfeller temporarily deployed to cli-automation April 2, 2025 22:45 — with GitHub Actions Inactive

Merge branch 'trunk' into andyfeler/colorize-label-optin

e9a1285

andyfeller commented Apr 4, 2025

View reviewed changes

pkg/iostreams/color.go Outdated Show resolved Hide resolved

andyfeller added 2 commits April 4, 2025 11:02

Add label color env var to help topic, unused fix

addbc6a

This commit adds the new environment variable to the `gh environment` help topic. Additionally, there is a small fix for Go linter for an unused variable raised as a problem.

Refactor ColorScheme initializer

e067eac

This commit completely removes the iostreams.NewColorScheme() initializer function in favor of exporting the type fields for greater clarity in its use. The result being code specifying only the fields that matter to test cases.

andyfeller marked this pull request as ready for review April 4, 2025 16:01

andyfeller requested a review from a team as a code owner April 4, 2025 16:01

andyfeller requested a review from BagToad April 4, 2025 16:01

andyfeller temporarily deployed to cli-automation April 4, 2025 16:01 — with GitHub Actions Inactive

cliAutomation assigned andyfeller Apr 4, 2025

williammartin approved these changes Apr 8, 2025

View reviewed changes

andyfeller added 2 commits April 8, 2025 15:24

Use truthy value for GH_COLOR_LABELS

c520610

Test for explicit config disable of label colors

5c12f56

andyfeller merged commit 6dd8f80 into trunk Apr 8, 2025
21 of 22 checks passed

andyfeller deleted the andyfeler/colorize-label-optin branch April 8, 2025 20:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Introduce configuration setting for displaying issue and pull request labels in rich truecolor #10720

Introduce configuration setting for displaying issue and pull request labels in rich truecolor #10720

andyfeller commented Apr 2, 2025 •

edited

Loading

Uh oh!

Uh oh!

williammartin left a comment

Uh oh!

williammartin Apr 8, 2025

Uh oh!

andyfeller Apr 8, 2025 •

edited

Loading

Uh oh!

williammartin Apr 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Introduce configuration setting for displaying issue and pull request labels in rich truecolor #10720

Introduce configuration setting for displaying issue and pull request labels in rich truecolor #10720

Conversation

andyfeller commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Demo

gh config

gh environment

gh issue list

gh issue status

gh issue view

gh label list

gh pr view

Uh oh!

Uh oh!

williammartin left a comment

Choose a reason for hiding this comment

Uh oh!

williammartin Apr 8, 2025

Choose a reason for hiding this comment

Uh oh!

andyfeller Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

williammartin Apr 8, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

andyfeller commented Apr 2, 2025 •

edited

Loading

`gh config`

`gh environment`

`gh issue list`

`gh issue status`

`gh issue view`

`gh label list`

`gh pr view`

andyfeller Apr 8, 2025 •

edited

Loading