Skip to content

docs: harden GITHUB_TOKEN permissions in gitStream workflow templates#850

Open
MishaKav wants to merge 2 commits intomainfrom
LINBEE-24071-harden-github-token-permissions
Open

docs: harden GITHUB_TOKEN permissions in gitStream workflow templates#850
MishaKav wants to merge 2 commits intomainfrom
LINBEE-24071-harden-github-token-permissions

Conversation

@MishaKav
Copy link
Copy Markdown
Collaborator

@MishaKav MishaKav commented Apr 20, 2026

✨ PR Description

Purpose: Add explicit minimal GITHUB_TOKEN permissions to gitStream workflow templates and update documentation to reflect security hardening best practices.

Main changes:

  • Added permissions: { contents: read } block to all gitStream workflow YAML files across multiple locations
  • Updated timeout from 5 to 15 minutes in main workflow files for improved reliability
  • Documented GITHUB_TOKEN permission hardening with explanation of least-privilege principle and App token separation

Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using.
💡 Tip: You can customize your AI Description using Guidelines Learn how

Add `permissions: contents: read` to the generated gitStream workflow
templates and all inline snippets in the installation + troubleshooting
docs. Add a dedicated section explaining the two-token split (workflow
GITHUB_TOKEN vs. gitStream App installation token) and why scoping to
contents: read does not affect any feature.

Covers:
- docs/downloads/gitstream.yml
- docs/downloads/gitstream-lite.yml
- docs/github-installation.md (inline snippets + new section)
- docs/troubleshooting.md (dependabot + lite snippets)
- tutorials/basic-usage-python-repo/.github/workflows/gitstream.yml
- .github/workflows/gitstream.yml (dogfood)

Follows https://github.blog/changelog/2021-04-20-github-actions-control-permissions-for-github_token/
Copy link
Copy Markdown

@orca-security-us orca-security-us bot left a comment

Choose a reason for hiding this comment

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

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed OSS Licenses high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

@linearb
Copy link
Copy Markdown

linearb bot commented Apr 20, 2026

Credits balance too low. Add more credits here

Copy link
Copy Markdown

@linearb linearb bot left a comment

Choose a reason for hiding this comment

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

✨ PR Review

LGTM

Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using.
💡 Tip: You can customize your AI Review using Guidelines Learn how

@linearb linearb bot added the 5 min review label Apr 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant