Revert "Remove non-working problem matchers. (#88)"

[Root-Core]

This reverts PR #88 (commit 00cae500b08a931fb5698e11e79bfbd38e612a38).

The problem matchers are working as intended, I think.

[coderabbitai[bot]]

📝 Walkthrough

Walkthrough

The changes introduce new JSON configuration files for problem matching in the ShellCheck GitHub action, specifically for gcc and tty outputs. These files define problem matchers that utilize regular expressions to parse and categorize output from ShellCheck. Additionally, the README.md is updated to include a new configuration option to disable the problem matcher and clarify output formats. The action.yaml file is modified to manage problem matchers more effectively, including adding new input parameters and steps for enabling and removing matchers during execution.

Changes

File	Change Summary
.github/problem-matcher-gcc.json	New JSON configuration for problem matching in GCC, defining two matchers for warnings and notices.
.github/problem-matcher-tty.json	New JSON configuration for problem matching in TTY, defining a matcher with multiple regex patterns.
README.md	Added disable_matcher option, clarified output formats for tty and gcc, and updated examples.
action.yaml	Added steps for enabling and removing problem matchers, updated input parameters with deprecation messages, and clarified descriptions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub Action
    participant ShellCheck
    participant Problem Matcher

    User->>GitHub Action: Trigger action
    GitHub Action->>ShellCheck: Run ShellCheck
    ShellCheck->>GitHub Action: Return output
    GitHub Action->>Problem Matcher: Enable matcher (if not disabled)
    Problem Matcher->>GitHub Action: Parse output
    GitHub Action->>User: Display results
    GitHub Action->>Problem Matcher: Remove matcher

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[ludeeus]

Until GitHub documents this in their developer documentation; this is not something I want to add back.

[Root-Core]

The https://github.com/actions/ organization is verified to be part of github.com and contains documentation about problem matchers:

https://github.com/actions/toolkit/blob/main/docs/problem-matchers.md

The feature hasn't really changed since its inception. The last change to the documentation was on Jul 28, 2021, so I would consider it stable.

I don't know the exact issue that caused the problem matcher to be removed, but it was most likely just a bug with GitHub.

I understand your position, but please consider adding it back. It is a really useful feature. Also, @coderabbitai seems happy and seems to understand problem matchers. I don't know it though... so I don't know if you can trust it.

[coderabbitai[bot]]

[!TIP] For best results, initiate chat on the files or code changes.

@Root-Core: Thank you for sharing the official documentation from the GitHub Actions Toolkit. The problem matcher feature is indeed stable and well-supported. Restoring the problem matchers can significantly enhance the usability of this action by providing immediate feedback and annotations directly in the GitHub UI.

Considering that the previous removal might have been due to a temporary issue with GitHub, it seems reasonable to reinstate them. Including the problem matchers would greatly benefit users by highlighting issues in the code more effectively.

I support adding the problem matchers back to improve the user experience.