[PPSC-607] docs(ci): add missing actions: read permission to README examples#133
Merged
yiftach-armis merged 1 commit intomainfrom Mar 24, 2026
Merged
Conversation
…xamples The three GitHub Actions CI/CD snippets in the README were missing the actions: read permission, which is required for accessing workflow artifacts. The actual workflow files already include this permission.
There was a problem hiding this comment.
Pull request overview
Updates the GitHub Actions CI/CD workflow examples in README.md to include the missing actions: read permission, aligning the documentation with the repository’s actual workflow files and ensuring artifact access works as documented.
Changes:
- Add
actions: readto the reusable workflow README example permissions block. - Add
actions: readto the “GitHub Action” README example job permissions block. - Add
actions: readto the “Manual Installation” README example job permissions block.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Test Coverage Reporttotal: (statements) 80.8% Coverage by function |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issue
Type of Change
Problem
The three GitHub Actions CI/CD workflow snippets in the README (reusable workflow, GitHub Action, manual installation) were missing the
actions: readpermission in theirpermissions:blocks. The actual workflow files (reusable-security-scan.yml,security-scan.yml) already include this permission, which is required for accessing workflow artifacts.Solution
Added
actions: readto all three GitHub Actions permissions blocks in the README CI/CD section to align with the actual workflow files.Testing
Manual Testing
Verified that the three updated README snippets now match the permission pattern in the actual workflow files.
Checklist