Documentation around colored output in logs #583
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
Do these color changes carry over to annotation messages or is it just for the log output? |
|
@xt0rted very late, but the annotations are broken if colors are used. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves: https://github.com/github/c2c-actions-service/issues/1402
Improvements to action logs are now out for everyone!
https://github.blog/changelog/2020-09-23-github-actions-log-improvements/
One of the new features is proper support for 3/4 bit, 8 bit and 24 bit color. Action authors should have information about how to use this.
This PR adds some documentation to the
corepackage README. There is some existing documentation about logging so this felt like the most logical place to add this new information. Colored output works with the normalconsole.logmethod, but it's best to document it with ourcore.infomethod.🖌Rendered 🖼
There are a bunch of NPM packages that can be used to assist with this, but I intentionally choose to document the raw ANSI codes. Towards the end I call out one NPM package that I tested and have found to work pretty well. Some popular ones such as chalk don't work because of how they handle string prototypes.
Testing