Add support for GitHub annotations in GitHub actions #1052
Conversation
This allows to add more formaters based on the same error list.
This allows GitHub to parse it and display annotations on pull requests.
Use REUSE_OUTPUT_FORMAT to allow overriding lint output formats in certain environments (like CI).
Hopefully this will land via fsfe/reuse-tool#1052.
|
Wow, amazing PR @nijel ! Thank you for this work. I wonder whether it makes sense to keep Do you know whether this GitHub format of errors is also consumed by other programs? |
|
|
| Environment | ||
| ----------- | ||
|
|
||
| .. envvar:: REUSE_OUTPUT_FORMAT | ||
|
|
||
| Specifies output format, one of ``plain``, ``lines``, ``github``, ``json`` | ||
|
|
||
| It behaves same as corresponding command line options. |
There was a problem hiding this comment.
There should be a documented order of precedence here. If both REUSE_OUTPUT_FORMAT and a CLI flag are used, which takes precedence?
As written in the code, I believe the env var takes precedence. I do not know if this is desirable behaviour.
There was a problem hiding this comment.
Additionally, should quiet be a valid value here?
There was a problem hiding this comment.
Additionally, what should happen if the value of REUSE_OUTPUT_FORMAT is invalid?
Signed-off-by: Carmen Bianca BAKKER <[email protected]>
I added a rather silly fallback. Maybe an error should be raised, but I don't want to deal with catching this very obscure error. Signed-off-by: Carmen Bianca BAKKER <[email protected]>
Signed-off-by: Carmen Bianca BAKKER <[email protected]>
Signed-off-by: Carmen Bianca BAKKER <[email protected]>
Signed-off-by: Carmen Bianca BAKKER <[email protected]>
The first implementation of this consumed the `reuse lint --json` output. It was later patched up to consume the ProjectReport instead, but the docstrings were apparently never adjusted accordingly. Signed-off-by: Carmen Bianca BAKKER <[email protected]>
--githubto format output according to https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actionsREUSE_OUTPUT_FORMATto override output from the environment, this is useful to change output in CI compared to when running in user environment.changelog.d/<directory>/.AUTHORS.rst.docs/man/or elsewhere.the current specification.
changed files.