What are the default problem matchers? #25670

jtbandes · 2021-08-09T20:06:55Z

jtbandes
Aug 9, 2021

I’ve read about custom problem matchers, but it seems like some program output (ESLint, for example) is already picked up as errors in check logs, and shows up as a per-line annotation in the PR changed files screen.

Which problem matchers are enabled by default? Rather than going to the effort of writing a custom matcher, I’d like to tailor the output of my job to fit with existing matchers.

Answered by jsoref

Aug 10, 2021

Interesting question.

I’m not sure if this is active:

  <a href="https://github.com/actions/runner/blob/be9632302ceef50bfb36ea998cea9c94c75e5d4d/src/Runner.Plugins/Repository/v1.1/GitSourceProvider.cs#L39-L49" target="_blank" rel="noopener">github.com</a>

actions/runner/blob/be9632302ceef50bfb36ea998cea9c94c75e5d4d/src/Runner.Plugins/Repository/v1.1/GitSourceProvider.cs#L39-L49

    
      
          ""problemMatcher"": [
              {
                  ""owner"": ""checkout-git"",
                  ""pattern"": [
                      {
                          ""regexp"": ""^(fatal|error): (.*)$"",
                          ""message"": 2
                      }
                  ]
 …

View full answer

jsoref · 2021-08-10T02:55:26Z

jsoref
Aug 10, 2021

Interesting question.

I’m not sure if this is active:

  <a href="https://github.com/actions/runner/blob/be9632302ceef50bfb36ea998cea9c94c75e5d4d/src/Runner.Plugins/Repository/v1.1/GitSourceProvider.cs#L39-L49" target="_blank" rel="noopener">github.com</a>

actions/runner/blob/be9632302ceef50bfb36ea998cea9c94c75e5d4d/src/Runner.Plugins/Repository/v1.1/GitSourceProvider.cs#L39-L49

    
      
          ""problemMatcher"": [
              {
                  ""owner"": ""checkout-git"",
                  ""pattern"": [
                      {
                          ""regexp"": ""^(fatal|error): (.*)$"",
                          ""message"": 2
                      }
                  ]
              }
          ]

My guess is that for most repositories, most of the time, this is active:

  <a href="https://github.com/actions/checkout/blob/25a956c84d5dd820d28caab9f86b8d183aeeff3d/dist/problem-matcher.json#L2-L12" target="_blank" rel="noopener">github.com</a>

actions/checkout/blob/25a956c84d5dd820d28caab9f86b8d183aeeff3d/dist/problem-matcher.json#L2-L12

    
      
          "problemMatcher": [
              {
                  "owner": "checkout-git",
                  "pattern": [
                      {
                          "regexp": "^(fatal|error): (.*)$",
                          "message": 2
                      }
                  ]
              }
          ]

if you use actions/setup-python, you probably get this:

  <a href="https://github.com/actions/setup-python/blob/a1121449a217580167611672a6c61b4cf314e0f2/.github/python.json#L2-L17" target="_blank" rel="noopener">github.com</a>

actions/setup-python/blob/a1121449a217580167611672a6c61b4cf314e0f2/.github/python.json#L2-L17

    
      
          "problemMatcher": [
              {
                  "owner": "python",
                  "pattern": [
                      {
                          "regexp": "^\\s*File\\s\\\"(.*)\\\",\\sline\\s(\\d+),\\sin\\s(.*)$",
                          "file": 1,
                          "line": 2
                      },
                      {
                          "regexp": "^\\s*raise\\s(.*)\\(\\'(.*)\\'\\)$",
                          "message": 2
                      }
                  ]
              }
          ]

If you use setup-node, you probably get this:

  <a href="https://github.com/actions/setup-node/blob/5c355be17065acf11598c7a9bb47112fbcf2bbdc/.github/tsc.json#L2-L17" target="_blank" rel="noopener">github.com</a>

actions/setup-node/blob/5c355be17065acf11598c7a9bb47112fbcf2bbdc/.github/tsc.json#L2-L17

    
      
          "problemMatcher": [
              {
                  "owner": "tsc",
                  "pattern": [
                      {
                          "regexp": "^([^\\s].*)[\\(:](\\d+)[,:](\\d+)(?:\\):\\s+|\\s+-\\s+)(error|warning|info)\\s+TS(\\d+)\\s*:\\s*(.*)$",
                          "file": 1,
                          "line": 2,
                          "column": 3,
                          "severity": 4,
                          "code": 5,
                          "message": 6
                      }
                  ]
              }
          ]

and this:

  <a href="https://github.com/actions/setup-node/blob/5c355be17065acf11598c7a9bb47112fbcf2bbdc/.github/eslint-compact.json#L2-L17" target="_blank" rel="noopener">github.com</a>

actions/setup-node/blob/5c355be17065acf11598c7a9bb47112fbcf2bbdc/.github/eslint-compact.json#L2-L17

    
      
          "problemMatcher": [
              {
                  "owner": "eslint-compact",
                  "pattern": [
                      {
                          "regexp": "^(.+):\\sline\\s(\\d+),\\scol\\s(\\d+),\\s(Error|Warning|Info)\\s-\\s(.+)\\s\\((.+)\\)$",
                          "file": 1,
                          "line": 2,
                          "column": 3,
                          "severity": 4,
                          "message": 5,
                          "code": 6
                      }
                  ]
              }
          ]

and this:

  <a href="https://github.com/actions/setup-node/blob/5c355be17065acf11598c7a9bb47112fbcf2bbdc/.github/eslint-stylish.json#L2-L21" target="_blank" rel="noopener">github.com</a>

actions/setup-node/blob/5c355be17065acf11598c7a9bb47112fbcf2bbdc/.github/eslint-stylish.json#L2-L21

    
      
          "problemMatcher": [
              {
                  "owner": "eslint-stylish",
                  "pattern": [
                      {
                          "regexp": "^([^\\s].*)$",
                          "file": 1
                      },
                      {
                          "regexp": "^\\s+(\\d+):(\\d+)\\s+(error|warning|info)\\s+(.*)\\s\\s+(.*)$",
                          "line": 1,
                          "column": 2,
                          "severity": 3,
                          "message": 4,
                          "code": 5,
                          "loop": true
                      }
                  ]
              }
          ]

via:

  <a href="https://github.com/actions/setup-node/blob/25316bbc1f10ac9d8798711f44914b1cf3c4e954/src/main.ts#L59-L64" target="_blank" rel="noopener">github.com</a>

actions/setup-node/blob/25316bbc1f10ac9d8798711f44914b1cf3c4e954/src/main.ts#L59-L64

    
      
          core.info(`##[add-matcher]${path.join(matchersPath, 'tsc.json')}`);
          core.info(
            `##[add-matcher]${path.join(matchersPath, 'eslint-stylish.json')}`
          );
          core.info(
            `##[add-matcher]${path.join(matchersPath, 'eslint-compact.json')}`

and setup-go:

  <a href="https://github.com/actions/setup-go/blob/3b4dc6cbed1779f759b9c638cb83696acea809d1/matchers.json#L2-L15" target="_blank" rel="noopener">github.com</a>

actions/setup-go/blob/3b4dc6cbed1779f759b9c638cb83696acea809d1/matchers.json#L2-L15

    
      
          "problemMatcher": [
              {
                  "owner": "go",
                  "pattern": [
                      {
                          "regexp": "^\\s*(\\.{0,2}[\\/\\\\].+\\.go):(?:(\\d+):(\\d+):)? (.*)",
                          "file": 1,
                          "line": 2,
                          "column": 3,
                          "message": 4
                      }
                  ]
              }
          ]

Results extracted from:

  <a href="https://github.com/search?q=org:actions%2Bproblemmatcher&amp;type=code" target="_blank" rel="noopener">GitHub</a>

Build software better, together

GitHub is where people build software. More than 65 million people use GitHub to discover, fork, and contribute to over 200 million projects.

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Community

What are the default problem matchers? #25670

{{title}}

Replies: 1 comment

{{title}}

Select a reply