Skip to content

ci: add descriptive workflow tracking configuration summary #1905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Rish-2006 wants to merge 2 commits into from
Closed

ci: add descriptive workflow tracking configuration summary #1905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d91223
docs: add installation permission troubleshooting note
Rish-2006 Jun 30, 2026
ed88574
ci: add descriptive workflow tracking configuration summary
Rish-2006 Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# TermUI Automated CI Pipeline Configuration
# Purpose: Validates workspace build status, style compliance, and testing execution bounds.
# Trigger: Executes automatically on incoming pull requests and main branch updates.

name: CI

on:
Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,6 +478,8 @@ examples/

## Development
> **Note:** This project uses [Bun](https://bun.sh) as its package manager. Install Bun first: https://bun.sh/docs/installation
> **Note:** If you encounter execution policy or permission errors during setup, open your terminal as an Administrator (Windows) or use `sudo` before running commands (Mac/Linux).

Comment on lines +481 to +482

@coderabbitai coderabbitai Bot Jun 30, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🩺 Stability & Availability | 🟠 Major | ⚡ Quick win

Avoid recommending sudo for Bun commands.

Using sudo with Bun (sudo bun install, etc.) typically creates downstream permission issues in ~/.bun, node_modules, and cache directories. The correct fix for EACCES errors is usually fixing directory ownership (chown -R $(whoami) <dir>) rather than elevating privileges. Additionally, "Mac" should be "macOS" for accuracy.

Consider rewording to:

  • Separate Windows execution policy (PowerShell) from Unix permission issues.
  • Direct users to check directory ownership or Bun's official troubleshooting instead of blanket sudo advice.
 > **Note:** If you encounter execution policy or permission errors during setup, open your terminal as an Administrator (Windows) or use `sudo` before running commands (Mac/Linux).
+> **Note:** On Windows, PowerShell execution policy errors may require Administrator privileges. On macOS/Linux, permission errors with Bun are usually fixed by ensuring correct directory ownership rather than using `sudo`.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
> **Note:** If you encounter execution policy or permission errors during setup, open your terminal as an Administrator (Windows) or use `sudo` before running commands (Mac/Linux).
> **Note:** On Windows, PowerShell execution policy errors may require Administrator privileges. On macOS/Linux, permission errors with Bun are usually fixed by ensuring correct directory ownership rather than using `sudo`.
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 481 - 482, The setup note in README should not
recommend using sudo for Bun commands, and it should use macOS instead of Mac.
Update the guidance in the README section that mentions execution
policy/permission errors to separate Windows PowerShell execution policy fixes
from Unix/macOS permission troubleshooting, and point users toward fixing
directory ownership or Bun’s official troubleshooting rather than suggesting
elevated privileges. Keep the wording anchored around the existing setup note so
it replaces the current blanket Administrator/sudo advice.


```bash
bun install
Expand Down
Loading