Skip to content

docs(tflint): Replace deprecated value in example#880

Merged
MaxymVlasov merged 1 commit intomasterfrom
docs/tflint
May 7, 2025
Merged

docs(tflint): Replace deprecated value in example#880
MaxymVlasov merged 1 commit intomasterfrom
docs/tflint

Conversation

@MaxymVlasov
Copy link
Copy Markdown
Collaborator

Description of your changes

--module was deprecated in TFLint v0.50.0 and removed in v0.54.0.

According to #534 (comment), it should be replaced to --call-module-type="all"

Copilot AI review requested due to automatic review settings May 7, 2025 13:28
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented May 7, 2025

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated the example and explanation for the terraform_tflint hook's args section to use --call-module-type="all" instead of --module.

Walkthrough

The documentation for the terraform_tflint hook in the README was updated to replace the argument --module with --call-module-type="all" in both the example and the explanatory text. No changes were made to code or exported entities.

Changes

File Change Summary
README.md Updated documentation example and explanation to use --call-module-type="all" instead of --module.

Sequence Diagram(s)

No sequence diagram is generated as the changes are limited to documentation updates.


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dd4bb9d and d8b69b6.

📒 Files selected for processing (1)
  • README.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: 🧪 Tests / pytest@🐍3.9@windows-2025
  • GitHub Check: 🧹 Linters / pre-commit@🐍3.13@ubuntu-latest
  • GitHub Check: 🧪 Tests / pytest@🐍3.13@windows-2025
  • GitHub Check: 🧪 Tests / pytest@🐍3.13@macos-14
  • GitHub Check: 🧪 Tests / pytest@🐍3.12@windows-2025
  • GitHub Check: 🧪 Tests / pytest@🐍3.12@macos-14
  • GitHub Check: 🧪 Tests / pytest@🐍3.11@windows-2025
  • GitHub Check: 🧪 Tests / pytest@🐍3.10@windows-2025
  • GitHub Check: 🧪 Tests / pytest@🐍3.10@macos-14
  • GitHub Check: pre-commit
🔇 Additional comments (2)
README.md (2)

350-350: Correctly replaced deprecated --module with --call-module-type="all"
The example hook args now use the supported --call-module-type="all" flag, which aligns with TFLint v0.54.0+ and addresses the deprecation of --module.


353-353: Consistent explanatory text
The descriptive text has been updated to reference --call-module-type="all" instead of --module, matching the example and ensuring clarity.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

@MaxymVlasov MaxymVlasov changed the title docs(tflint): Replace repecated value in example docs(tflint): Replace depecated value in example May 7, 2025
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the configuration example in the README to reflect the removal of the deprecated --module flag in TFLint v0.54.0 by replacing it with --call-module-type="all".

  • Replaced --module with --call-module-type="all" in the configuration sample.
  • Updated the corresponding explanatory text to match the new argument.

Comment thread README.md
@MaxymVlasov MaxymVlasov changed the title docs(tflint): Replace depecated value in example docs(tflint): Replace deprecated value in example May 7, 2025
@MaxymVlasov MaxymVlasov merged commit 8931c65 into master May 7, 2025
49 checks passed
@MaxymVlasov MaxymVlasov deleted the docs/tflint branch May 7, 2025 15:12
@antonbabenko
Copy link
Copy Markdown
Owner

This PR is included in version 1.99.1 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants