Add problem-matchers for Pylint, MyPy, and Black #1580
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
GitHub [Problem Matchers](https://github.com/actions/toolkit/blob/main/docs/problem-matchers.md) are a mechanism that enable workflow steps to scan the outputs of GitHub Actions for regex patterns and automatically write annotations in the workflow summary page. Using Problem Matchers allows information to be displayed more prominently in the GitHub user interface. This adds a problem matcher for Pylint output. In the near future, we will almost certainly add more problem matchers, so this also starts a README file where we can acknowlege where they come from as we add them.
mpharrigan
reviewed
Mar 5, 2025
| @@ -130,6 +134,8 @@ jobs: | |||
| python -m pip install --upgrade pip | |||
| pip install -r dev_tools/requirements/envs/dev.env.txt | |||
| pip install --no-deps -e . | |||
| - name: Set up problem matcher for Mypy output | |||
| run: echo '::add-matcher::.github/problem-matchers/mypy.json' | |||
There was a problem hiding this comment.
just echoing things triggers this?
There was a problem hiding this comment.
I know it looks bonkers, but believe it or not, that bit with the ::add-matcher:: is the special sauce that GitHub uses to detect what's happening. Why this syntax and not something more clear? ¯_(ツ)_/¯
mpharrigan
approved these changes
Mar 5, 2025
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.
GitHub Problem Matchers are a mechanism that enable workflow steps to scan the outputs of GitHub Actions for regex patterns and automatically write annotations in the workflow summary page. Using Problem Matchers allows information to be displayed more prominently in the GitHub user interface.
This add problem matchers for Pylint, Mypy and Black output.