Improve descriptions of action outputs

[mislav]

The "files" output isn't a list of files where shellcheck has detected violations, but the full list of files that shellcheck was invoked on.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the action.yaml file for the ShellCheck GitHub action. It marks the ignore input as deprecated, advising users to switch to ignore_paths or ignore_names. Additionally, the descriptions for the files and options outputs have been clarified. While the functionality of the deprecated input remains intact, the focus is on guiding users towards the preferred alternatives without changing the action's overall logic or structure.

Changes

File	Change Summary
action.yaml	Deprecated ignore input with a message to use ignore_paths or ignore_names; updated output descriptions for files and options.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Action
    participant ShellCheck

    User->>Action: Trigger GitHub Action
    Action->>ShellCheck: Execute checks with options
    ShellCheck-->>Action: Return results
    Action-->>User: Provide checked files and options used

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 00b27aa and 5719336.

📒 Files selected for processing (1)

• action.yaml (1 hunks)

🔇 Additional comments (2)

action.yaml (2)

49-49: LGTM! The description now accurately reflects the output's content.

The updated description "The list of files checked" is more precise than the previous version which incorrectly implied it only listed files with issues. This change aligns with the actual behavior where the output includes all files that shellcheck processes, regardless of whether violations were found.

---

52-52: LGTM! The description is now more specific.

The updated description "Shellcheck options used" is more precise by explicitly mentioning "Shellcheck" instead of the generic "The options used".

---

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.