docs: Add Security section to README (fixes #17)#19
docs: Add Security section to README (fixes #17)#19vorburger wants to merge 1 commit intobearmini:masterfrom
Conversation
Mention the new security warning that appears when upgrading to version v1.0.8 on the README.
WalkthroughAdds 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
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.
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. Comment |
There was a problem hiding this comment.
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.
Mention the new security warning that appears when upgrading to version v1.0.8 on the README.
Summary by CodeRabbit