Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The problem-matchers documentation is missing a lot of information #394

Open
JasonGross opened this issue Mar 28, 2020 · 2 comments
Open
Labels
documentation enhancement New feature or request

Comments

@JasonGross
Copy link

JasonGross commented Mar 28, 2020

The file https://github.com/actions/toolkit/blob/master/docs/problem-matchers.md is missing a lot of relevant information. Here are some questions it does not answer:

  1. The docs say: "column: a group number containing the column information". What is the valid format for "column information"? Is it used anywhere? Is it displayed anywhere?
  2. The docs say "code: a group number containing the error code". Is this the exit code? Any sort of number associated with the code? Is it used anywhere?
  3. The docs says "at least one pattern must set the message". What happens if multiple patterns set the message? Are they concatenated? Is all but the last one dropped?
  4. The docs say "file: a group number containing the file name". Does the file name need to be absolute? Relative to the root of the repo? Relative to "fromPath" (which maybe defaults to the root of the repo)? Either absolute or relative? And what happens if the file does not exist? Or exists but not in a file touched by the PR? Or exists but only in a submodule? Or contains special characters such as "? (Empirically, this last one (or possibly non-existent file) seems to result in the file .github being chosen instead.)
@JasonGross JasonGross added the enhancement New feature or request label Mar 28, 2020
@lots0logs
Copy link

bump

@bilderbuchi
Copy link

From this dupe issue comment: the information that the match when using fromPath needs to be a file or a directory path with trailing slash included, otherwise the path's parent folder is used (which is probably not what you want).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants