[github action] display black result in job summary #3688
Merged
Conversation
This file contains 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
cooperlees
requested changes
May 13, 2023
action/main.py
Outdated
| @@ -32,7 +32,7 @@ | |||
| describe_name = line[len("describe-name: ") :].rstrip() | |||
| break | |||
| if not describe_name: | |||
| print("::error::Failed to detect action version.", flush=True) | |||
| sys.stderr.write("::error::Failed to detect action version.") | |||
There was a problem hiding this comment.
Do we care about the newline here you've removed? If so I recommend sticking with print cause I believe it will send correct newline in windows ...
Suggested change
| sys.stderr.write("::error::Failed to detect action version.") | |
| print("::error::Failed to detect action version.", file=sys.stderr, flush=True) |
There was a problem hiding this comment.
It does need to be written to stderr so as errors do not appear in the job summary part (which won't parse it correctly) but the annotation one, like this:
I've updated the PR with your feedback
|
I also checked action was correctly running on a Windows runner, an example run is here https://github.com/tieum/atuin-graph/actions/runs/4972553308 
|
cooperlees
approved these changes
May 14, 2023
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.
Description
This PR updates the black github action to display the output of black in the job summary
Checklist
CHANGES.mdif necessary?Result looks like this:
- erroring with verbosity on
- success with verbosity off