Skip to content

docs: Add Security section to README (fixes #17)#19

Open
vorburger wants to merge 1 commit intobearmini:masterfrom
vorburger:patch-1
Open

docs: Add Security section to README (fixes #17)#19
vorburger wants to merge 1 commit intobearmini:masterfrom
vorburger:patch-1

Conversation

@vorburger
Copy link

@vorburger vorburger commented Sep 13, 2025

Mention the new security warning that appears when upgrading to version v1.0.8 on the README.

Summary by CodeRabbit

  • Documentation
    • Added a Security section to the README describing a VS Code extension security warning encountered when upgrading to v1.0.8.
    • Included references to related issues (VS Code Extensions manager warning #17 and Security: VScode "executable code" warning for 1.0.8 #15) for further details and tracking.
    • Clarified that there are no functional changes or public API modifications associated with this update.
    • Provides guidance and visibility for users who may see the warning during upgrades.

Mention the new security warning that appears when upgrading to version v1.0.8 on the README.
@coderabbitai
Copy link

coderabbitai bot commented Sep 13, 2025

Walkthrough

Adds a Security section to README.md noting a VS Code extension security warning for upgrades to v1.0.8 and referencing issues #17 and #15. No code or API changes.

Changes

Cohort / File(s) Summary of Changes
Documentation update
README.md
Added “Security” section describing a VS Code extension security warning related to upgrading to v1.0.8; linked issues #17 and #15. No functional/public API modifications.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit read the README’s lore,
It added notes—security galore!
No code to tweak, no APIs bend,
Just warnings marked for friend to friend.
Thump-thump! Docs safe, we hop once more. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "docs: Add Security section to README (fixes #17)" is concise and directly reflects the primary change (adding a Security section to the README) while including a relevant issue reference; it is specific, readable, and appropriate for a docs-only change.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
README.md (1)

46-48: Polish wording + format the warning for readability.

Minor clarity/grammar tweaks and a blockquote make this easier to scan.

-## Security
-
-Re. the Security Warning about _"The update for systemd-unit-file extension introduces executable code, which is not present in the currently installed version. Please review the extension and update it manually."_ which you'll see in Visual Studio Code's Extensions when upgrading previous versions to v1.0.8, please see issues [#17](https://github.com/bearmini/vscode-systemd-unit-file/issues/17) and [#15](https://github.com/bearmini/vscode-systemd-unit-file/issues/15).
+## Security
+
+If you see the following warning when upgrading from earlier versions to `v1.0.8` in VS Code’s Extensions view:
+
+> “The update for systemd-unit-file extension introduces executable code, which is not present in the currently installed version. Please review the extension and update it manually.”
+
+See issues [#17](https://github.com/bearmini/vscode-systemd-unit-file/issues/17) and [#15](https://github.com/bearmini/vscode-systemd-unit-file/issues/15) for background and status.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0dfc69c and 1c010c7.

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

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.

1 participant