Skip to content

Update README.md#161

Merged
guibranco merged 1 commit intomainfrom
guibranco-patch-1
Apr 12, 2026
Merged

Update README.md#161
guibranco merged 1 commit intomainfrom
guibranco-patch-1

Conversation

@guibranco
Copy link
Copy Markdown
Owner

@guibranco guibranco commented Apr 12, 2026

📑 Description

Update README.md

✅ Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • All the tests have passed

☢️ Does this introduce a breaking change?

  • Yes
  • No

Summary by Sourcery

Update README to document version 5 of the Infisical secrets check GitHub Action and its improved remediation workflow.

Documentation:

  • Refresh README examples to use action version v5.0.1 across all workflow snippets.
  • Document new v5 remediation workflow, including PR-based ignore handling and automatic .infisicalignore management.
  • Clarify feature list, error-handling behavior, and recommended permissions with updated formatting and wording.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated version references to v5.0.1 in all usage examples and workflow configurations.
    • Added documentation for the new v5 remediation workflow.
    • Enhanced "Ignoring False Positives" section with details on PR-comment-based .infisicalignore creation and updates, including duplicate removal and commit suggestion features.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Apr 12, 2026

Reviewer's Guide

Updates the README to document version 5.0.1 of the GitHub Infisical Secrets Check action, including new remediation capabilities, standardized markdown tables and formatting, and clarified guidance on error handling and ignoring false positives.

Flow diagram for v5 false-positive handling and .infisicalignore updates

flowchart TD
  Start([Secrets_detected_by_v5_action])
  CheckFalsePositives{Are_any_findings_false_positives?}
  UsePRUI[Use_PR_comment_suggestions]
  ManualFlow[Use_manual_infisicalignore_fallback]

  AutoCheckFile{Does_.infisicalignore_exist?}
  CreateFile[Create_.infisicalignore_at_repo_root]
  AppendFingerprints[Append_new_fingerprints_from_comment]
  RemoveDuplicates[Remove_duplicate_fingerprints]
  CommitSuggestion[Apply_Commit_suggestion_in_PR_UI]

  ManualCreate[Create_.infisicalignore_file_at_repo_root]
  ManualAdd[Manually_add_fingerprint_values]

  RerunScan[Re_run_or_wait_for_next_scan]
  End([Scan_results_updated])

  Start --> CheckFalsePositives
  CheckFalsePositives -->|No| RerunScan
  CheckFalsePositives -->|Yes| UsePRUI
  CheckFalsePositives -->|Prefer_manual_update| ManualFlow

  UsePRUI --> AutoCheckFile
  AutoCheckFile -->|No| CreateFile
  AutoCheckFile -->|Yes| AppendFingerprints

  CreateFile --> AppendFingerprints --> RemoveDuplicates --> CommitSuggestion --> RerunScan

  ManualFlow --> ManualCreate --> ManualAdd --> RerunScan

  RerunScan --> End
Loading

File-Level Changes

Change Details Files
Update all usage examples to reference the latest action version.
  • Bump action version from v4.1.0 to v5.0.1 in the primary workflow snippet.
  • Update action version in all subsequent example jobs (default usage, custom token, disabled comments, and outputs examples).
README.md
Improve markdown formatting for inputs/outputs and section separators.
  • Reformat the Inputs table with aligned columns and consistent spacing.
  • Reformat the Outputs table to match the new table style.
  • Add horizontal rule separators (---) between major sections for readability.
  • Normalize bullet style (using * instead of -) where updated.
README.md
Document new v5 remediation workflow and behavior when secrets or tool failures occur.
  • Add a subsection under the failure scenario describing the new interactive remediation workflow, including fingerprints display, .infisicalignore management, and commit suggestion button.
  • Clarify that remediation can now be done directly from the PR UI without leaving GitHub.
  • Convert tool-failure description bullets to consistent markdown list style.
README.md
Refresh feature list and error handling documentation to reflect v5 capabilities.
  • Replace the old feature bullet list with a new one that highlights interactive remediation, automatic .infisicalignore handling, duplicate fingerprint prevention, and workflow-friendly outputs.
  • Update the Error Handling section to distinguish between improvements introduced in v4 and the additional remediation-focused improvements in v5, including commit suggestions and duplicate entry prevention.
  • Fix minor wording issues and tighten phrasing around failure behavior and feedback.
README.md
Expand and clarify instructions for ignoring false positives using .infisicalignore.
  • Describe the new v5 flow where the action automatically detects/creates/updates .infisicalignore and generates a commit suggestion button in PR comments.
  • Explain that duplicates are automatically removed when updating the ignore file.
  • Keep a manual fallback subsection that shows how to create .infisicalignore by hand with example fingerprints.
  • Rephrase the opening of the section to emphasize v5’s in-PR remediation and then describe manual fallback.
README.md
Simplify and standardize the documented permissions block.
  • Remove inline comments from the YAML permissions example, leaving only the minimal keys required: contents: read and pull-requests: write.
  • Keep the permissions block layout consistent with other YAML examples in the README.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@deepsource-io
Copy link
Copy Markdown

deepsource-io Bot commented Apr 12, 2026

DeepSource Code Review

We reviewed changes in 3a8bfde...9f48151 on this pull request. Below is the summary for the review, and you can see the individual issues we found as inline review comments.

See full review on DeepSource ↗

PR Report Card

Overall Grade   Security  

Reliability  

Complexity  

Hygiene  

Code Review Summary

Analyzer Status Updated (UTC) Details
Secrets Apr 12, 2026 1:33p.m. Review ↗

Important

AI Review is run only on demand for your team. We're only showing results of static analysis review right now. To trigger AI Review, comment @deepsourcebot review on this thread.

@guibranco guibranco enabled auto-merge (squash) April 12, 2026 13:33
@gstraccini gstraccini Bot added the ☑️ auto-merge Automatic merging of pull requests (gstraccini-bot) label Apr 12, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 12, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ef5168a9-760a-4179-b23b-2e9e47fd7dc0

📥 Commits

Reviewing files that changed from the base of the PR and between 3a8bfde and 9f48151.

📒 Files selected for processing (1)
  • README.md

Walkthrough

Updated action version references from v4.1.0 to v5.0.1 throughout README workflow examples. Reformatted inputs and outputs table structures. Added v5 remediation workflow documentation and expanded the "Ignoring False Positives" section with PR-comment-based .infisicalignore file management procedures.

Changes

Cohort / File(s) Summary
Documentation Updates
README.md
Version bump from v4.1.0 to v5.0.1 across all workflow YAML examples; reformatted inputs/outputs table alignment; new v5 remediation workflow description; expanded "Ignoring False Positives" section detailing PR-comment-driven .infisicalignore creation with duplicate removal and commit suggestion button, plus manual fallback guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Version five hops into place,
With workflows updated with grace,
PR comments now guide,
False positives subside,
As secrets find their proper space! 🔐

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch guibranco-patch-1

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 and usage tips.

@github-actions github-actions Bot deleted a comment from guibranco Apr 12, 2026
@penify-dev
Copy link
Copy Markdown
Contributor

penify-dev Bot commented Apr 12, 2026

Failed to generate code suggestions for PR

@guibranco guibranco merged commit 12c5189 into main Apr 12, 2026
14 of 16 checks passed
@guibranco guibranco deleted the guibranco-patch-1 branch April 12, 2026 13:33
Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - I've found 1 issue, and left some high level feedback:

  • The first YAML example now closes with four backticks (````) instead of three (```), which likely breaks Markdown code block rendering; consider reverting to a triple-backtick fence for consistency with the other examples.
  • There is a typo in the Error Handling section: Improces PR workflow ergonomics should be Improves PR workflow ergonomics.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The first YAML example now closes with four backticks (````) instead of three (```), which likely breaks Markdown code block rendering; consider reverting to a triple-backtick fence for consistency with the other examples.
- There is a typo in the Error Handling section: `Improces PR workflow ergonomics` should be `Improves PR workflow ergonomics`.

## Individual Comments

### Comment 1
<location path="README.md" line_range="208" />
<code_context>
-- **Scan Execution Errors**: Distinguishes between tool failures and secrets detection
+* Generates commit suggestions for ignore rules
+* Prevents duplicate ignore entries
+* Improces PR workflow ergonomics
+* Keeps scan failures clearly separated from security failures

</code_context>
<issue_to_address>
**issue (typo):** Correct the typo "Improces" to "Improves".

In the Error Handling section, change "Improces PR workflow ergonomics" to "Improves PR workflow ergonomics".

```suggestion
* Improves PR workflow ergonomics
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread README.md
@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

Repository owner deleted a comment from github-actions Bot Apr 12, 2026
@guibranco
Copy link
Copy Markdown
Owner Author

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs
2026-04-12T13:33:59Z INF scanning for exposed secrets...
1:33PM INF 143 commits scanned.
2026-04-12T13:33:59Z INF scan completed in 22.4ms
2026-04-12T13:33:59Z INF no leaks found

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

Labels

☑️ auto-merge Automatic merging of pull requests (gstraccini-bot)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant