Skip to content

lint: ignore userPrefs.jsonc - #11174

Merged
Jorropo merged 1 commit into
meshtastic:developfrom
Jorropo:lint/mqtt-example-password
Jul 26, 2026
Merged

lint: ignore userPrefs.jsonc#11174
Jorropo merged 1 commit into
meshtastic:developfrom
Jorropo:lint/mqtt-example-password

Conversation

@Jorropo

@Jorropo Jorropo commented Jul 23, 2026

Copy link
Copy Markdown
Member

checkov/CKV_SECRET_6 flags the commented-out "large4cats" example, which
is the public default credential for the meshtastic.org MQTT broker rather
than a real secret. Suppress it with an explicit justification.

One of a series of small, independent lint cleanups that clear trunk check failures. This PR contains a single commit.

Written by Claude (Claude Code).

Summary by CodeRabbit

  • Chores
    • Updated linting configuration to exclude the user preferences file from automated checks.
    • Added context explaining the exception for documented example credentials.

@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The lint configuration now ignores userPrefs.jsonc for all linters and documents the related commented credential false positive.

Changes

Lint configuration

Layer / File(s) Summary
Ignore user preferences example file
.trunk/trunk.yaml
Adds userPrefs.jsonc to the all-linters ignore list and explains the checkov/CKV_SECRET_6 false positive.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: vidplace7

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description summarizes the change, but it does not follow the repository template or include the required attestations. Replace the prose with the template sections and fill in the attestations, including testing status and any affected devices.
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title accurately summarizes the main change: ignoring userPrefs.jsonc from lint checks.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

⚡ Try this PR in the Web Flasher

Flash this PR in the Web Flasher

firmware commit boards expires

Warning

This is an automated, unreviewed CI test build. Back up your device configuration
before flashing, and only flash devices you are able to recover.

Supported boards built by this PR (30)
Device Board Platform
Crowpanel Adv 3.5 TFT elecrow-adv-35-tft esp32-s3
Heltec HT62 heltec-ht62-esp32c3-sx1262 esp32-c3
Heltec Mesh Node 096 heltec-mesh-node-t096 nrf52840
Heltec Mesh Node T1 heltec-mesh-node-t1 nrf52840
Heltec Mesh Node T114 heltec-mesh-node-t114 nrf52840
Heltec V3 heltec-v3 esp32-s3
Heltec V4 heltec-v4 esp32-s3
Meshnology W10 meshnology_w10 esp32-s3
Raspberry Pi Pico pico rp2040
Raspberry Pi Pico W picow rp2040
RAK WisMesh Pocket V3 rak_wismesh_pocket nrf52840
RAK WisMesh Pod rak_wismesh_pod nrf52840
RAK WisMesh Repeater Mini V2 rak_wismesh_repeater_mini nrf52840
RAK WisMesh Tag rak_wismeshtag nrf52840
RAK WisBlock 11200 rak11200 esp32
RAK WisBlock 11310 rak11310 rp2040
RAK3312 rak3312 esp32-s3
RAK WisBlock 4631 rak4631 nrf52840
Seeed SenseCAP Mesh-Tracker-X1 seeed_mesh_tracker_X1 nrf52840
Seeed Wio Tracker L1 seeed_wio_tracker_L1 nrf52840
Seeed Xiao NRF52840 Kit seeed_xiao_nrf52840_kit nrf52840
Seeed Xiao ESP32-S3 seeed-xiao-s3 esp32-s3
Station G2 station-g2 esp32-s3
Station G3 station-g3 esp32-s3
LILYGO T-Deck t-deck-tft esp32-s3
LILYGO T-Echo t-echo nrf52840
LILYGO T-Echo Plus t-echo-plus nrf52840
LILYGO T-Impulse Plus t-impulse-plus nrf52840
LilyGo T3-C6 tlora-c6 esp32-c6
Seeed SenseCAP T1000-E tracker-t1000-e nrf52840

Build artifacts expire on 2026-08-23. Updated for c1c1e57.

@Jorropo
Jorropo force-pushed the lint/mqtt-example-password branch from 7edf40d to dc8818f Compare July 23, 2026 23:10
@Jorropo Jorropo added ai-generated Possible AI-generated low-quality content cleanup Code cleanup or refactor labels Jul 23, 2026

@vidplace7 vidplace7 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd rather not pollute this file with trunk comments.
Let's have trunk ignore userPrefs.jsonc entirely instead.

checkov/CKV_SECRET_6 flags the commented-out "large4cats" example, which
is the public default credential for the meshtastic.org MQTT broker rather
than a real secret. Ignore the file in .trunk/trunk.yaml so the example
config stays free of lint-suppression comments.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@Jorropo
Jorropo force-pushed the lint/mqtt-example-password branch from dc8818f to c1c1e57 Compare July 24, 2026 02:52

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.trunk/trunk.yaml:
- Around line 105-111: Change the linter scope for the userPrefs.jsonc ignore
entry from ALL to Checkov only, preserving the existing path and exception for
CKV_SECRET_6 while keeping other linters enabled.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 66a35abd-6215-4bef-bef1-5dd874a92b60

📥 Commits

Reviewing files that changed from the base of the PR and between 372b751 and c1c1e57.

📒 Files selected for processing (1)
  • .trunk/trunk.yaml

Comment thread .trunk/trunk.yaml
@vidplace7
vidplace7 enabled auto-merge July 24, 2026 02:58
@vidplace7
vidplace7 added this pull request to the merge queue Jul 24, 2026
@Jorropo
Jorropo removed this pull request from the merge queue due to a manual request Jul 24, 2026
@Jorropo
Jorropo added this pull request to the merge queue Jul 24, 2026
@vidplace7
vidplace7 removed this pull request from the merge queue due to the queue being cleared Jul 24, 2026
@Jorropo Jorropo changed the title lint: mark example MQTT password as a non-secret lint: ignore uprefs.jsonc Jul 26, 2026
@Jorropo Jorropo changed the title lint: ignore uprefs.jsonc lint: ignore userPrefs.jsonc Jul 26, 2026
@Jorropo
Jorropo added this pull request to the merge queue Jul 26, 2026
Merged via the queue into meshtastic:develop with commit 4800484 Jul 26, 2026
107 checks passed
madeofstown pushed a commit to madeofstown/meshtastic-firmware that referenced this pull request Jul 26, 2026
checkov/CKV_SECRET_6 flags the commented-out "large4cats" example, which
is the public default credential for the meshtastic.org MQTT broker rather
than a real secret. Ignore the file in .trunk/trunk.yaml so the example
config stays free of lint-suppression comments.

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
t-miura pushed a commit to t-miura/firmware that referenced this pull request Jul 26, 2026
checkov/CKV_SECRET_6 flags the commented-out "large4cats" example, which
is the public default credential for the meshtastic.org MQTT broker rather
than a real secret. Ignore the file in .trunk/trunk.yaml so the example
config stays free of lint-suppression comments.

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-generated Possible AI-generated low-quality content cleanup Code cleanup or refactor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants