docs: add inline comments explaining workflow token permissions#19604
docs: add inline comments explaining workflow token permissions#19604ZachDreamZ wants to merge 2 commits into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Deploy Preview for kubestellarconsole ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
👋 Welcome to the KubeStellar community! 💖 Thanks and congrats 🎉 for opening your first PR here! We're excited to have you contributing. Before merge, please ensure:
📬 If you're using KubeStellar in your organization, please add your name to our Adopters list. 🙏 It really helps the project gain momentum and credibility — a small contribution back with a big impact. Resources:
A maintainer will review your PR soon. Hope you have a great time here! 🌟 ~~~~~~~~~~ 🌟 📬 If you like KubeStellar, please ⭐ star ⭐ our repo to support it! 🙏 It really helps the project gain momentum and credibility — a small contribution back with a big impact. |
There was a problem hiding this comment.
Pull request overview
This PR hardens GitHub Actions documentation by adding inline, job-level comments explaining exactly why each workflow needs specific GITHUB_TOKEN write permissions, aligning with least-privilege expectations and making Scorecard TokenPermissions alerts easier to review.
Changes:
- Added inline explanations for
contents: write,issues: write,pull-requests: write,packages: write, andactions: writeat the job level. - Clarified which concrete job behavior/step requires each write scope (e.g., committing screenshots, dispatching another workflow, pushing to GHCR/gh-pages).
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/process-screenshots.yml | Documents why contents: write and issues: write are required for committing screenshots and updating issue comments. |
| .github/workflows/hive-interactive.yml | Documents why issues: write, pull-requests: write, contents: read, and actions: write are required across the jobs. |
| .github/workflows/helm-release.yml | Documents why contents: write (gh-pages) and packages: write (GHCR) are required for Helm publishing. |
| .github/workflows/deploy-checksum.yml | Documents why contents: write is required to commit deploy.sh.sha256 updates to main. |
| .github/workflows/cleanup-screenshots.yml | Documents why contents: write and issues: write are required for deleting screenshots and updating issue comment URLs. |
28c529a to
5474415
Compare
5474415 to
db04ae6
Compare
clubanderson
left a comment
There was a problem hiding this comment.
Quality Review
Documentation-only change adding inline permission comments to workflow YAML files. This is a good practice for auditability — makes it easy for reviewers and Scorecard to verify that write scopes are intentional and minimal.
No testing concerns — no runtime behavior changed.
🔍 Quality ReviewInline permission comments improve reviewability and help Scorecard auditors understand why each write scope exists. This is a documentation-only change — no functional risk. Quality observation — First-time contributor: Welcome @ZachDreamZ! The DCO signoff is present ✅ and the change scope is appropriate. LGTM from quality perspective. Quality agent (ACMM L4/L6 — full mode) |
53c00c2 to
8ef2c62
Compare
|
Rebased. Fixed the conflicts. |
Each job-level permissions block now documents which step requires the write scope and why, making it easier for reviewers and Scorecard to verify that permissions are intentional and minimal. Addresses Scorecard TokenPermissions alerts from issue kubestellar#19602. Signed-off-by: ZachDreamZ <ZachDreamZ@users.noreply.github.com>
Each job-level
permissions:block now documents which step requires the write scope and why. This makes it straightforward for reviewers and automated tools (like Scorecard) to verify that permissions are intentional and minimal.Closes #19602