pr-bot

A Go-based tool to analyze merged pull requests and determine their presence across release branches. Available as both a CLI tool for individual use and a Slack bot server for team collaboration.

✨ Ready to use out of the box - go install gives you a fully functional tool, just configure Google Sheets API access! The tool helps track the deployment status of changes across different release versions.

🌿 Branch Structure

latest - Production branch (stable releases)
master - Development branch (active development)

🚀 Quick Start

CLI Mode

# Install latest release  
go install github.com/openshift-assisted/pr-bot@latest

# Add Go bin to PATH (if needed)  
export PATH=$PATH:~/go/bin

# Set up your API tokens
export PR_BOT_GITHUB_TOKEN="your_github_token_here"
export PR_BOT_GITLAB_TOKEN="your_gitlab_token_here" 
export PR_BOT_JIRA_TOKEN="your_jira_token_here"

# Start analyzing PRs right away - no external files needed!
pr-bot -pr https://github.com/openshift/assisted-service/pull/7788

# Check version
pr-bot -version

Server Mode (Slack Bot)

# Set up all required tokens in .env file
cat > .env << EOF
# Required tokens for all functionality
PR_BOT_GITHUB_TOKEN=your_github_token_here
PR_BOT_GITLAB_TOKEN=your_gitlab_token_here
PR_BOT_JIRA_TOKEN=your_jira_token_here

# Required for Slack bot server mode (OAuth bot token)
PR_BOT_SLACK_BOT_TOKEN=xoxb-your-bot-token-here

# Required: Google Sheets for GA data (service account for private sheets)
PR_BOT_GOOGLE_SERVICE_ACCOUNT_JSON='{"type": "service_account", "project_id": "your-project", "private_key_id": "...", "private_key": "-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n", "client_email": "[email protected]", "client_id": "...", "auth_uri": "https://accounts.google.com/o/oauth2/auth", "token_uri": "https://oauth2.googleapis.com/token"}'
PR_BOT_GOOGLE_SHEET_ID=your_private_google_sheet_id_here
EOF

# Start server
pr-bot -server

# Use in Slack (multiple ways)
/pr https://github.com/openshift/assisted-service/pull/7788
@pr-bot pr https://github.com/openshift/assisted-service/pull/7788
# Or send direct message: pr https://github.com/openshift/assisted-service/pull/7788

Features

🔧 Dual Mode Architecture

CLI Tool: Perfect for individual developers and CI/CD pipelines
Slack Bot Server: Team-friendly slash commands for collaborative analysis

📊 Analysis Capabilities

PR Analysis: Get detailed information about merged pull requests including commit hash and merge date
Release Branch Tracking: Automatically discover and check all release branches matching patterns
Version Detection: Extract version numbers from branch names and report which versions contain changes
SaaS Version Badges: Real-time deployment status badges showing production/staging/not deployed status from GitLab
JIRA Integration: Analyze all PRs related to a JIRA ticket including backports
MCE Validation: Verify commits against MCE GitLab snapshots with SHA extraction

📅 Release Management

GA Status Tracking: Analyze General Availability status from Google Sheets
Real-time Data: Live release schedule updates directly from Google Sheets
Release Schedule Integration: Parse "In Progress" and "ACM MCE Completed" tabs to determine GA dates
Version Comparison: Compare MCE/GitHub versions to track changes between releases with required component-specific analysis

🚀 User Experience

Auto-Update Notifications: Automatically checks for newer versions and prompts users to update
Multi-Repository Support: Works with assisted-service, assisted-installer, assisted-installer-agent, and assisted-installer-ui
Flexible Configuration: Support for environment variables, config files, and command-line options
High Performance: Optimized with caching and parallel processing to minimize API calls

🔒 Data Source Architecture

This tool uses Google Sheets API as the exclusive data source for GA (General Availability) release information:

🌐 Google Sheets Integration

✅ Real-time Data: Always uses the latest release schedule from Google Sheets
🔄 Live Updates: Changes reflect immediately without redeployment
🔐 Secure Access: Service account authentication for private sheets
📱 Easy Maintenance: Familiar spreadsheet interface for data management
🚀 No Rebuilds: Update GA data through Google Sheets without touching code
🔒 Private Sheets: Full support for private Google Sheets with proper authentication

📋 Required Configuration

Both environment variables are required for the tool to function:

export PR_BOT_GOOGLE_SERVICE_ACCOUNT_JSON='{"type": "service_account", "project_id": "your-project", ...}'
export PR_BOT_GOOGLE_SHEET_ID="your-google-sheet-id"

⚡ Benefits

✅ Real-time Updates: Live data from Google Sheets
✅ Zero Downtime: Update data without restarting services
✅ Collaborative: Multiple users can maintain the release schedule
✅ Audit Trail: Google Sheets provides change history
✅ Simplified Deployment: No data files to manage
✅ Private Access: Works with private sheets through service account authentication

🔍 Check Your Configuration

pr-bot --data-source
# Shows your current configuration including Google Sheets setup

Installation

Option 1: Install via Go (Recommended)

# Install latest stable release (recommended)
go install github.com/openshift-assisted/pr-bot@latest

# Or install from development branch
go install github.com/openshift-assisted/pr-bot@master

# Add Go bin directory to PATH (if not already done)
echo 'export PATH=$PATH:~/go/bin' >> ~/.bashrc
source ~/.bashrc

# Verify installation
pr-bot -version

Option 2: Download Binary

# Download from GitHub releases (replace VERSION with actual version)
wget https://github.com/openshift-assisted/pr-bot/releases/latest/download/pr-bot-linux-amd64
chmod +x pr-bot-linux-amd64
mv pr-bot-linux-amd64 pr-bot

# Add to PATH
sudo mv pr-bot /usr/local/bin/

Option 3: Build from Source

🚀 Build from Source

# Clone repository
git clone https://github.com/openshift-assisted/pr-bot.git
cd pr-bot

# Build the application
go build .

# Configure Google Sheets access (required)
export PR_BOT_GOOGLE_SERVICE_ACCOUNT_JSON='{"type": "service_account", "project_id": "your-project", ...}'
export PR_BOT_GOOGLE_SHEET_ID="your-google-sheet-id"

# Verify configuration
./pr-bot --data-source

👤 Maintainer Builds & Releases

For project maintainers who can build and release new versions:

⚠️ Requirements for Building/Releasing:

Google Sheets API access (service account JSON and Sheet ID)
GitHub repository write access
Being listed in the GitHub Actions workflow conditions

# Clone repository
git clone https://github.com/openshift-assisted/pr-bot.git
cd pr-bot

# Build CLI distribution version
./scripts/build-cli.sh

# For releases, build and release:
./scripts/build-cli.sh
gh release create v0.X.X --title "vX.X.X - Release Title" --notes "Release notes" ./pr-bot

⚡ New Architecture Benefits:

No sensitive data files in the repository
Real-time data updates without rebuilding
Simplified build process for all contributors
Users configure their own Google Sheets access

Prerequisites

Go 1.21 or later (if building from source)
GitHub token (REQUIRED) - For API access
GitLab token (REQUIRED) - For SaaS version badges and MCE validation
JIRA token (REQUIRED) - For JIRA ticket analysis
Red Hat VPN connection (REQUIRED) - For accessing internal GitLab and JIRA APIs
Google Sheets API access (REQUIRED) - For GA release schedule data

GitHub Token Setup

Go to GitHub Settings > Personal Access Tokens
Click "Generate new token (classic)"
Give it a name like "pr-bot"
Select scopes: public_repo (for public repos) or repo (for private repos)
Copy the generated token

Set it as an environment variable:

For CLI usage:

export PR_BOT_GITHUB_TOKEN="your_token_here"

For Slack server usage (add to .env file):

echo "PR_BOT_GITHUB_TOKEN=your_token_here" >> .env

⚠️ Important: Without a GitHub token, you're limited to 60 requests per hour and will get rate limited quickly when analyzing multiple branches.

JIRA Token Setup (Required for -jt flag)

For JIRA ticket analysis, you'll need a JIRA API token:

Get JIRA API Token:
- Go to Red Hat JIRA API Tokens
- Click "Create token"
- Give it a name like "pr-bot"
- Copy the generated token

Set as environment variable:

For CLI usage:

export PR_BOT_JIRA_TOKEN="your-jira-token-here"

For Slack server usage (add to .env file):

echo "PR_BOT_JIRA_TOKEN=your-jira-token-here" >> .env

Important Notes:

Required only if you want to use the -jt flag for JIRA ticket analysis
The token should have read access to JIRA issues
Used to find cloned tickets and extract GitHub PR URLs from JIRA tickets

GitLab Token Setup (Required for SaaS Badges and MCE Validation)

For SaaS version deployment badges and MCE snapshot validation (used in PR analysis and version comparison), you'll need a GitLab API token:

Get GitLab API Token:
- Go to GitLab Personal Access Tokens
- Click "Add new token"
- Give it a name like "pr-bot"
- Select scope: read_api (for reading repository files)
- Set expiration date (optional)
- Copy the generated token

Set as environment variable:

For CLI usage:

export PR_BOT_GITLAB_TOKEN="your-gitlab-token-here"

For Slack server usage (add to .env file):

echo "PR_BOT_GITLAB_TOKEN=your-gitlab-token-here" >> .env

Important Notes:

Required for SaaS version deployment badges (reads deployments.yaml for production/staging status)
Required for MCE snapshot validation (SHA extraction from down-sha.yaml)
Used in PR analysis to validate against MCE snapshots
Enables version comparison features (-v flag)
Token should have read_api scope to access repository files

Google Sheets Setup (Required for GA Data)

The tool requires Google Sheets API access using service account authentication for private sheet access:

Create Google Cloud Service Account:
- Go to Google Cloud Console
- Create a new project or select an existing one
- Enable the "Google Sheets API" in APIs & Services > Library
- Go to "IAM & Admin" > "Service Accounts"
- Click "Create Service Account"
- Give it a name (e.g., "pr-bot-sheets") and click "Create and Continue"
- Skip the optional roles and click "Done"
Generate Service Account Credentials:
- Click on the newly created service account
- Go to the "Keys" tab
- Click "Add Key" > "Create new key"
- Select "JSON" format and click "Create"
- This downloads a JSON file containing your service account credentials
Share Google Sheet with Service Account:
- Open the JSON file and find the "client_email" field
- Go to your private Google Sheet (e.g., ACM/MCE release schedule)
- Click "Share" and add the service account email with "Viewer" permission
- Make sure "Notify people" is unchecked
Get Google Sheet ID:
- Copy the Sheet ID from the URL: https://docs.google.com/spreadsheets/d/SHEET_ID_HERE/edit

Set as environment variables:

For CLI usage:

export PR_BOT_GOOGLE_SERVICE_ACCOUNT_JSON='{"type": "service_account", "project_id": "your-project", ...}'
export PR_BOT_GOOGLE_SHEET_ID="your-google-sheet-id"

For Slack server usage (add to .env file):

echo "PR_BOT_GOOGLE_SERVICE_ACCOUNT_JSON='your-service-account-json-content'" >> .env
echo "PR_BOT_GOOGLE_SHEET_ID=your-google-sheet-id" >> .env

Important Notes:

Private Sheets: Works with private Google Sheets through service account authentication
Sheet Structure: Must have "In Progress" and "Completed Releases" tabs
Required: Both service account JSON and Sheet ID must be configured
Security: Keep your service account JSON secure and restrict permissions appropriately
Access: Service account must be shared with the Google Sheet

Setup

git clone https://github.com/openshift-assisted/pr-bot.git
cd pr-bot
go mod tidy

Environment Configuration

You can configure the application using a .env file in the project root:

# Copy the example file
cp env.example .env

# Edit the .env file with your tokens
nano .env

The .env file should contain:

# GitHub Configuration
PR_BOT_GITHUB_TOKEN=your-github-token-here
PR_BOT_GITHUB_OWNER=openshift
PR_BOT_GITHUB_REPOSITORY=assisted-service
PR_BOT_GITHUB_BRANCH_PREFIX=release-ocm-
PR_BOT_GITHUB_DEFAULT_BRANCH=master

# Slack Bot Configuration (OAuth bot token for server mode)
PR_BOT_SLACK_BOT_TOKEN=xoxb-your-bot-token-here

# GitLab Configuration (for MCE snapshot validation)
PR_BOT_GITLAB_TOKEN=your-gitlab-token-here

# JIRA Configuration (for MGMT ticket analysis)
PR_BOT_JIRA_TOKEN=your-jira-token-here

# Google Sheets Configuration (Required - service account for private sheets)
PR_BOT_GOOGLE_SERVICE_ACCOUNT_JSON='{"type": "service_account", "project_id": "your-project", "private_key_id": "...", "private_key": "-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n", "client_email": "[email protected]", "client_id": "...", "auth_uri": "https://accounts.google.com/o/oauth2/auth", "token_uri": "https://oauth2.googleapis.com/token"}'
PR_BOT_GOOGLE_SHEET_ID=your-private-google-sheet-id-here

Optional: Build Binary

make build

Configuration

The tool can be configured through environment variables, config files, or command-line flags.

Environment Variables

# GitHub Configuration (Required)
export PR_BOT_GITHUB_TOKEN="your-github-token"
export PR_BOT_GITHUB_OWNER="openshift"
export PR_BOT_GITHUB_REPOSITORY="assisted-service"
export PR_BOT_GITHUB_BRANCH_PREFIX="release-ocm-"
export PR_BOT_GITHUB_DEFAULT_BRANCH="master"

# Slack Bot Configuration (Required for Slack mode)
export PR_BOT_SLACK_BOT_TOKEN="xoxb-your-bot-token-here"

# Google Sheets Configuration (Required for GA data)
export PR_BOT_GOOGLE_SERVICE_ACCOUNT_JSON='{"type": "service_account", "project_id": "your-project", ...}'
export PR_BOT_GOOGLE_SHEET_ID="your-google-sheet-id"

# GitLab Configuration (Optional for MCE validation)
export PR_BOT_GITLAB_TOKEN="your-gitlab-token-here"

# JIRA Configuration (Required for JIRA ticket analysis)
export PR_BOT_JIRA_TOKEN="your-jira-token-here"

Config File

Create a config.yaml file:

github:
  token: "your-github-token"
  owner: "openshift"
  repository: "assisted-service"
  branch_prefix: "release-ocm-"
  default_branch: "master"
slack:
  bot_token: "xoxb-your-bot-token-here"
gitlab:
  token: "your-gitlab-token-here"
jira:
  token: "your-jira-token-here"
google:
  service_account_json: |
    {
      "type": "service_account",
      "project_id": "your-project",
      "private_key_id": "...",
      "private_key": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n",
      "client_email": "[email protected]",
      "client_id": "...",
      "auth_uri": "https://accounts.google.com/o/oauth2/auth",
      "token_uri": "https://oauth2.googleapis.com/token"
    }
  sheet_id: "your-google-sheet-id"

Default Configuration

Repository: openshift/assisted-service
Branch Prefix: release-ocm-
Default Branch: master

Usage

🖥️ CLI Mode

The CLI tool automatically checks for updates on startup and provides comprehensive PR analysis.

Basic Commands

# Show version and check for updates
pr-bot -version

# Show help
pr-bot

# Enable debug logging for any command
pr-bot -d -pr <PR_URL>

PR Analysis

Analyze merged PRs from any supported repository:

# Analyze a PR (auto-detects repository)
pr-bot -pr https://github.com/openshift/assisted-service/pull/1234
pr-bot -pr https://github.com/openshift/assisted-installer/pull/100
pr-bot -pr https://github.com/openshift/assisted-installer-agent/pull/200
pr-bot -pr https://github.com/openshift-assisted/assisted-installer-ui/pull/2991

# Just use the PR number if you're in the right repo context
pr-bot -pr 1234

JIRA Ticket Analysis

Analyze all PRs related to a JIRA ticket (finds backports automatically):

# Full URL
pr-bot -jt https://issues.redhat.com/browse/MGMT-20662

# Just ticket ID
pr-bot -jt MGMT-20662

Version Comparison

# Compare GitHub tag with previous version for specific components
pr-bot -v assisted-service v2.40.1
pr-bot -v assisted-installer v2.44.0

# Compare MCE versions for specific components
pr-bot -v mce assisted-service 2.8.0
pr-bot -v mce assisted-installer 2.8.0

Component Selection: For both regular and MCE version comparisons, you must specify which component/repository to analyze:

Available Components:

assisted-service - openshift/assisted-service
assisted-installer - openshift/assisted-installer
assisted-installer-agent - openshift/assisted-installer-agent
assisted-installer-ui - openshift-assisted/assisted-installer-ui

Regular Version Comparison: Compares GitHub tags between different releases of the same repository. MCE Version Comparison: Compares component SHAs between MCE snapshots, allowing you to track changes specific to that component between MCE versions.

Note: Component specification is required - there are no defaults to avoid confusion about which repository is being analyzed.

🤖 Server Mode (Slack Bot)

Start the server to enable Slack slash commands:

# Start server (default port 8080)
pr-bot -server

Slack Commands

Once the server is running, use these slash commands in Slack:

# Show help
/info

# Analyze a PR
/pr https://github.com/openshift/assisted-service/pull/1234

# Analyze JIRA ticket  
/jt MGMT-20662

# Compare versions (component required)
/version assisted-service v2.40.1
/version assisted-installer v2.44.0
/version mce assisted-service 2.8.0
/version mce assisted-installer 2.8.0

Slack App Setup

Quick Setup:

Create Slack App: Go to Slack Apps and create a new app
Add Bot Scopes: app_mentions:read, channels:read, chat:write, im:read, im:write, commands
Install App: Install to your workspace and copy the Bot User OAuth Token
Configure Events: Set event URL to https://your-server.com/slack/events
Add Slash Commands: Create /info, /pr, /jt, /version → https://your-server.com/slack/commands
Set Token: PR_BOT_SLACK_BOT_TOKEN=xoxb-your-token

📖 Detailed Setup Guide: See docs/SLACK_BOT_SETUP.md for complete instructions.

📋 Supported Repositories

openshift/assisted-service
openshift/assisted-installer
openshift/assisted-installer-agent
openshift-assisted/assisted-installer-ui

🔧 MCE Validation Components

assisted-service: Direct SHA extraction from down-sha.yaml
assisted-installer: Direct SHA extraction from down-sha.yaml
assisted-installer-agent: Direct SHA extraction from down-sha.yaml
assisted-installer-ui: Multi-step version extraction via stolostron/console → frontend/package.json → @openshift-assisted/ui-lib

Auto-Update Feature

The tool automatically checks for updates when running CLI commands:

# Example output when a new version is available
$ pr-bot -pr https://github.com/openshift/assisted-service/pull/1234

⚠️  A newer version is available: 0.1.0 (current: 0.0.1)
📦 Update with: go install github.com/openshift-assisted/pr-bot@latest
🔗 Or download from: https://github.com/openshift-assisted/pr-bot/releases/latest

# Then it continues with normal execution...

The update check:

✅ Non-blocking: Never fails your command if update check fails
✅ Fast: 5-second timeout, won't slow you down
✅ Informative: Shows current vs latest version and how to update
✅ Automatic: No configuration needed

Troubleshooting

"command not found: pr-bot"

This happens when ~/go/bin is not in your PATH. The binary is installed correctly but your shell can't find it.

Fix:

# Temporary fix (for current session)
export PATH=$PATH:~/go/bin

# Permanent fix (add to your shell profile)
echo 'export PATH=$PATH:~/go/bin' >> ~/.bashrc
source ~/.bashrc

# Verify it works
pr-bot -version

Missing Environment Variables

The CLI validates that required tokens are exported before running commands that need them:

❌ Missing required environment variables for CLI mode:
   • PR_BOT_GITHUB_TOKEN
   • PR_BOT_GITLAB_TOKEN
   • PR_BOT_JIRA_TOKEN

🔧 To fix this, export the missing variables:
  export PR_BOT_GITHUB_TOKEN="your_github_token_here"
  export PR_BOT_GITLAB_TOKEN="your_gitlab_token_here"
  export PR_BOT_JIRA_TOKEN="your_jira_token_here"

Note: Help (pr-bot) and version (pr-bot -version) commands don't require tokens.

"version constraints conflict"

This was fixed in v0.0.3. If you see this error, clean your module cache:

# Clear module cache and reinstall
go clean -modcache
go install github.com/openshift-assisted/pr-bot@latest

Rate Limit Issues

If you see 403 API rate limit exceeded:

# Make sure you have a GitHub token set
export PR_BOT_GITHUB_TOKEN="your_github_token_here"

# Without a token, you're limited to 60 requests/hour
# With a token, you get 5000 requests/hour

IDE/Editor Build Tag Warnings

If your IDE shows errors like "No packages found for embedded files" or import issues:

Issue: The embedded package uses build tags, which can confuse IDEs.

For VSCode with Go extension:

// Add to .vscode/settings.json in your project
{
    "go.buildTags": "",
    "gopls": {
        "buildFlags": ["-tags="]
    }
}

For other editors:

Default build (no tags) = embedded data version ✅
Use -tags=filesystem for development with external files
Build tag warnings are normal - both versions build correctly

Verify both work:

go build .                    # filesystem version (default)
go build -tags=embedded .     # embedded version (maintainers only)

Team Deployment

For CLI Distribution

Create installation script for your team:

#!/bin/bash
# install-pr-bot.sh

echo "🚀 Installing pr-bot..."

# Install latest version
go install github.com/openshift-assisted/pr-bot@latest

# Verify installation
pr-bot -version

echo "✅ Installation complete!"
echo "📋 Next steps:"
echo "1. Set up your tokens via export:"
echo "   export PR_BOT_GITHUB_TOKEN='your_github_token_here'"
echo "   export PR_BOT_GITLAB_TOKEN='your_gitlab_token_here'"
echo "   export PR_BOT_JIRA_TOKEN='your_jira_token_here'"
echo "2. Test with: pr-bot -pr <PR_URL>"

For Server Deployment

Docker deployment (recommended):

# Dockerfile
FROM golang:1.21-alpine AS builder
WORKDIR /app
COPY . .
RUN go build -o pr-bot .

FROM alpine:latest
RUN apk --no-cache add ca-certificates
WORKDIR /root/
COPY --from=builder /app/pr-bot .
COPY --from=builder /app/VERSION .
COPY --from=builder /app/data ./data
EXPOSE 8080
CMD ["./pr-bot", "-server"]

Kubernetes deployment:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: pr-bot
spec:
  replicas: 2
  selector:
    matchLabels:
      app: pr-bot
  template:
    metadata:
      labels:
        app: pr-bot
    spec:
      containers:
      - name: pr-bot
        image: your-registry/pr-bot:latest
        ports:
        - containerPort: 8080
        env:
        - name: PR_BOT_GITHUB_TOKEN
          valueFrom:
            secretKeyRef:
              name: pr-bot-secrets
              key: github-token
        # ... other environment variables

With Debug Output

./pr-bot -d -pr https://github.com/openshift/assisted-service/pull/1234

Debug mode provides detailed logging including:

Configuration values at startup
Google Sheets API parsing progress
GA status analysis steps
GitHub API request details
Release branch matching logic

Show Help

./pr-bot

Example Output

=== PR Analysis Summary ===
PR #1234: Fix authentication bug in installer
Hash: a1b2c3d4e5f6
Merged to 'master' at: 2024-01-15 10:30:00 +0000 UTC
URL: https://github.com/openshift/assisted-service/pull/1234

=== Release Branch Analysis ===

✓ Found in 3 release branches:
  - release-ocm-2.13 (version 2.13) - merged at 2024-01-16 14:20:00 +0000 UTC
    GA Status:
      ACM 2.13.3: GA (GA: 2024-01-10)
      MCE 2.8.2: GA (GA: 2024-01-10)
  - release-ocm-2.14 (version 2.14) - merged at 2024-01-17 09:15:00 +0000 UTC
    GA Status:
      ACM 2.14.1: Next Version (GA: 2024-02-15)
      MCE 2.9.1: Merged but not GA
  - release-ocm-2.15 (version 2.15) - merged at 2024-01-18 11:45:00 +0000 UTC
    GA Status:
      ACM 2.15.0: Not Found
      MCE 2.10.0: Not Found

✗ Not found in 2 release branches:
  - release-ocm-2.10 (version 2.10)
  - release-ocm-2.11 (version 2.11)

Analysis completed at: 2024-01-20 16:30:00 +0000 UTC

GA Status Meanings

GA: The change is included in a Generally Available release
Next Version: The change was merged after the GA date, so it will be in the next version
Merged but not GA: The change is merged but no GA date is available yet
Not Found: No release information found for this version

🤝 Contributing

🔐 Approval Required

All changes require maintainer approval before merging.

📝 Open issues for discussions and feature requests
🔄 Submit PRs for code changes - all PRs require review
⏳ Wait for approval - no self-merging allowed
🚫 No direct pushes - all changes go through PR process

👤 Maintainer Contact

Contact the repository maintainer for questions or urgent changes.

🛠️ For Contributors

Fork the repository
Create a feature branch
Make your changes
Submit a PR with clear description
Wait for maintainer approval

🛠️ Development

Project Structure

pr-bot/
├── main.go                   # Main application entry point
├── internal/
│   ├── config/              # Configuration management
│   ├── github/              # GitHub API client
│   ├── ga/                  # GA status parsing
│   ├── logger/              # Logging utilities
│   ├── models/              # Data models
│   └── slack/               # Slack API client
├── pkg/
│   └── analyzer/            # Core analysis logic
├── scripts/                 # Build and utility scripts
├── go.mod                   # Go module definition
├── Makefile                 # Build automation
└── README.md               # This file

Building and Testing

# Show available commands
make help

# Build the application
make build

# Run tests
make test

# Format code
make fmt

# Run linter
make lint

# Run all checks
make check

# Clean build artifacts
make clean

Adding New Components

The project follows Go best practices with a clean architecture:

Models (internal/models/): Define data structures
GitHub Client (internal/github/): API interaction layer
Analyzer (pkg/analyzer/): Business logic
Configuration (internal/config/): Configuration management
CLI (main.go): Command-line interface
GA Parser (internal/ga/): Google Sheets parsing for release tracking

API Rate Limits

Without GitHub token: 60 requests per hour
With GitHub token: 5,000 requests per hour

For production use, always configure a GitHub token.

Troubleshooting

Slack Bot Issues

If you have issues with the Slack bot:

Check bot token: Ensure PR_BOT_SLACK_BOT_TOKEN is set correctly
Verify scopes: Make sure all required bot scopes are configured
Check installation: Ensure the app is installed to your workspace
Test endpoints: Verify your server is accessible at the configured URLs
Use debug mode: Run with -d flag to see detailed error messages:
```
./pr-bot -server -d
```

See docs/SLACK_BOT_SETUP.md for detailed troubleshooting.

Contributing

Fork the repository
Create a feature branch
Make your changes
Add tests
Run make check to ensure quality
Submit a pull request

License

This project is licensed under the MIT License.

Name		Name	Last commit message	Last commit date
Latest commit History 57 Commits
dev		dev
docs		docs
internal		internal
pkg/analyzer		pkg/analyzer
scripts		scripts
.gitignore		.gitignore
Makefile		Makefile
README.md		README.md
VERSION		VERSION
config.yaml.example		config.yaml.example
dev-workflow.sh		dev-workflow.sh
env.example		env.example
go.mod		go.mod
go.sum		go.sum
main.go		main.go
slack-setup-checklist.md		slack-setup-checklist.md
test-endpoints.sh		test-endpoints.sh
tunnel-alternatives.md		tunnel-alternatives.md

openshift-assisted/pr-bot

Folders and files

Latest commit

History

Repository files navigation

pr-bot

🌿 Branch Structure

🚀 Quick Start

CLI Mode

Server Mode (Slack Bot)

Features

🔧 Dual Mode Architecture

📊 Analysis Capabilities

📅 Release Management

🚀 User Experience

🔒 Data Source Architecture

🌐 Google Sheets Integration

📋 Required Configuration

⚡ Benefits

🔍 Check Your Configuration

Installation

Option 1: Install via Go (Recommended)

Option 2: Download Binary

Option 3: Build from Source

🚀 Build from Source

👤 Maintainer Builds & Releases

Prerequisites

GitHub Token Setup

JIRA Token Setup (Required for -jt flag)

GitLab Token Setup (Required for SaaS Badges and MCE Validation)

Google Sheets Setup (Required for GA Data)

Setup

Environment Configuration

Optional: Build Binary

Configuration

Environment Variables

Config File

Default Configuration

Usage

🖥️ CLI Mode

Basic Commands

PR Analysis

JIRA Ticket Analysis

Version Comparison

🤖 Server Mode (Slack Bot)

Slack Commands

Slack App Setup

📋 Supported Repositories

🔧 MCE Validation Components

Auto-Update Feature

Troubleshooting

"command not found: pr-bot"

Missing Environment Variables

"version constraints conflict"

Rate Limit Issues

IDE/Editor Build Tag Warnings

Team Deployment

For CLI Distribution

For Server Deployment

With Debug Output

Show Help

Example Output

GA Status Meanings

🤝 Contributing

🔐 Approval Required

👤 Maintainer Contact

🛠️ For Contributors

🛠️ Development

Project Structure

Building and Testing

Adding New Components

API Rate Limits

Troubleshooting

Slack Bot Issues

Contributing

License

Roadmap

About

Resources

Uh oh!

Packages