GitHub Runner Status

An Electron-based macOS menu bar application that displays the status of GitHub self-hosted runners in your organization. The app provides a convenient way to monitor runner availability directly from your menu bar.

• Prerequisites
• Installation
• Usage
  • Entering Your GitHub Personal Access Token (PAT)
• Configuration
• Troubleshooting
• Contributing
• License

• Operating System: macOS (M1 or later).
• Node.js: Version 14 or higher. Download from nodejs.org.
• npm: Comes bundled with Node.js.
• Git: For cloning the repository (optional).

1. Clone the Repository (or download the source code):

   git clone https://github.com/yourusername/github-runner-status.git

2. Navigate to the Project Directory:

   cd GRS

3. Change to your Organization

   in renderer.js file change it to you organization name in line 50

4. Install Dependencies:

   npm install

5. Rebuild Native Modules (Required because keytar is a native module):

   npm run build

To start the application in development mode:

npm run start

• The app will launch, and an icon will appear in your macOS menu bar.
• Click the icon to open the application window.

1. Generate a PAT:

   • Go to GitHub Settings > Developer settings > Personal access tokens.
   • Click on Generate new token.
   • Select the following scopes:
     • repo (if accessing private repositories).
     • admin:org (for organization administration).
     • read:org (to read organization data).
   • Generate the token and copy it.

2. Enter the PAT in the Application:

   • When you first run the app, you'll be prompted to enter your PAT.
   • Paste your token into the input field and click Save Token.
   • The token will be securely stored in your macOS Keychain.

3. Authorization for SSO (If Applicable):

   • If your organization uses Single Sign-On (SSO), you may need to authorize the token.
   • Follow GitHub's instructions to authorize your PAT for SSO.

• For distributing the app outside your machine, consider code signing and notarizing the app.
• Requires an Apple Developer Account.