Skip to content

support simultaneous full-text and github output #4087

Description

@cwastranis

The github output format emits github "workflow commands", which the github UI
interprets and uses to annotate source files with the detected errors. These
commands are elided from the full workflow logs, which means that users looking
at these logs cannot see file and line information for pyrefly errors. It would
be ideal if pyrefly could emit both github and full-text output
simultaneously.

I'm happy to submit a PR for this (subject to my company approving the CLA), and
would appreciate some feedback on how to best proceed.

Some history I've found:

Proposals:

  1. Add a new output format (maybe full-github?) that emits both github and
    full-text outputs.
  2. Allow arbitrary combinations of output formats.
  3. make --[no-]-github-workflow-commands a separate option, orthogonal to --output-format

Of these, I think 1 would be the better choice? 2 seems like it creates a lot of
new "test surface" and its not clear what other use cases might be relevant.

Metadata

Metadata

Assignees

Labels

configurationhelp wantedLarger than "good first issue", but still well-defined and ready for someone to pick up

Fields

No fields configured for Feature.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions