Pull Requests

Overview

Orphelix integrates with GitHub to create and manage Pull Requests (PRs) directly from the dashboard. This enables a complete GitOps workflow where infrastructure changes go through code review before being applied to your cluster.

What are Pull Requests?

Pull Requests (PRs) are a GitHub feature for:

Code Review

Team reviews changes before merging

Discussion

Discuss changes, suggest improvements

CI/CD Integration

Automated tests run on PR changes

Audit Trail

Track who changed what and when

Creating Pull Requests

From YAML Editor

Most common method - edit manifests and create PR:

Edit YAML

Use YAML Editor to modify deployment/configSee YAML Editor for details

Review Changes

Check diff to ensure changes are correct PR Diff

Add Commit Message

Write clear, descriptive message:

Update API gateway to v2.1.0

- Bumps image from v2.0.0 to v2.1.0
- Adds rate limiting configuration
- Increases memory limit to handle higher load

Closes #456

Select Target Branch

Choose where to merge changes:

Main/Master
Staging
Custom

Default production branchMost common choice

Create PR

Click “Create Pull Request”Orphelix:

Creates feature branch
Commits your changes
Opens PR on GitHub
Returns PR link

Multi-file Pull Requests

Create PRs affecting multiple files: Multi-file PR

Use cases:

Update ConfigMap + Deployment (apply both changes together)
Kustomize base + overlay modifications
Coordinated changes across microservices

Select Multiple Files

In Repository Browser, select files with Ctrl+Click

Edit Each File

Make changes to all selected files

Review All Changes

Diff view shows all modified files

Single Commit

All changes in one commit, one PR

From Repository Browser

Browse and edit repository files directly:

Open Repo Browser

Navigate to Repository Browser page

Select Repository

Choose GitHub repository from dropdown

Browse Files

Navigate file tree to find target file

Edit File

Click file, then Edit button

Save and Create PR

Save changes → Auto-creates PR

PR Templates

Orphelix generates structured PR descriptions:

Default Template

## 📦 Changes

Updated Kubernetes resources in namespace: `production`

### Modified Files
- `k8s/deployments/api-gateway.yaml`
- `k8s/configmaps/api-config.yaml`

### Changes Made

**Deployment: api-gateway**
- Updated image from `api:v2.0.0` to `api:v2.1.0`
- Increased memory limit from `512Mi` to `1Gi`
- Added CPU limit: `1000m`

**ConfigMap: api-config**
- Added `RATE_LIMIT_ENABLED=true`
- Updated `MAX_CONNECTIONS=1000`

### Testing Checklist
- [ ] Deploy to staging environment
- [ ] Verify application starts successfully
- [ ] Run integration tests
- [ ] Check resource utilization
- [ ] Validate rate limiting works
- [ ] Monitor error rates

### Rollback Plan
If issues occur:
1. Revert this PR
2. Scale down to 2 replicas
3. Investigate logs in staging

### Related Issues
Closes #456

---
🤖 Generated with [Orphelix](https://github.com/corapoid/orphelix)

Custom Templates

Configure custom PR templates in your repository:

Create .github/pull_request_template.md
Orphelix uses it automatically
Override with custom message if needed

Managing Pull Requests

Viewing PRs

See all PRs created through Orphelix: PR List

PR Information:

Title: PR description
Status: Open, Merged, Closed
Author: Who created PR
Created: When PR was opened
Labels: GitHub labels
Reviews: Review status
Checks: CI/CD status

PR Status Indicators

Open

Color: BlueMeaning: PR awaiting review/mergeActions:

Review changes
Request reviews
Merge when ready

Merged

Color: PurpleMeaning: PR successfully mergedTimeline:

Changes now in target branch
ArgoCD/Flux will sync
Changes apply to cluster

Closed

Color: RedMeaning: PR closed without mergingReasons:

Changes no longer needed
Superseded by another PR
Incorrect approach

Conflicts

Color: OrangeMeaning: Merge conflicts existAction required:

Resolve conflicts on GitHub
Update branch from base
Push resolution

Review Status

PRs show review state:

Pending
Approved
Changes Requested
Commented

Icon: ⏳No reviews yetActions:

Request reviews from team
Self-review if allowed

CI/CD Checks

View automated check status: PR Checks

Common Checks:

YAML Lint

Validates YAML syntaxPass: ✅ Valid YAML Fail: ❌ Syntax errors

Policy Validation

Checks against policies (OPA, Kyverno)Pass: ✅ Complies with policies Fail: ❌ Policy violations

Integration Tests

Runs automated testsPass: ✅ Tests passed Fail: ❌ Tests failed

Security Scan

Scans for vulnerabilitiesPass: ✅ No vulnerabilities Fail: ❌ Security issues found

PR Actions

Merging

Merge PR to apply changes:

Ensure Approved

Required reviews completed

Check Status Checks

All CI/CD checks passed

Click Merge

In GitHub or Orphelix PR view

Select Merge Method

Merge Commit
Squash & Merge
Rebase & Merge

Creates merge commit (default)Preserves full history

Confirm Merge

Changes merged to target branchGitOps operator (ArgoCD/Flux) syncs changes

Closing without Merging

Close PR if changes not needed:

Add Comment

Explain why closing:

Closing this PR as we decided to handle this in #789 instead

Click Close

PR closed but not deleted

Optional: Delete Branch

Clean up feature branch

Updating PRs

Update PR with new commits:

From Orphelix
From Git

Re-open YAML editor
Make additional changes
Save → Commits to same branch
PR automatically updates

git checkout feature-branch
git add .
git commit -m "Address review feedback"
git push origin feature-branch

PR updates automatically

GitOps Workflow

Complete deployment flow with PRs:

Integration with GitOps Tools

ArgoCD
Flux
Manual

Auto-sync on PR merge:

PR merged to main
ArgoCD detects change
Compares with cluster state
Syncs new manifests
Updates deployment

ArgoCD App config:

apiVersion: argoproj.io/v1alpha1
kind: Application
spec:
  syncPolicy:
    automated:
      prune: true
      selfHeal: true

GitRepository + Kustomization:

PR merged to main
Flux polls repo (interval: 1m)
Detects new commit
Applies kustomization
Updates cluster

Flux config:

apiVersion: source.toolkit.fluxcd.io/v1
kind: GitRepository
metadata:
  name: app-repo
spec:
  interval: 1m
  url: https://github.com/org/repo
  ref:
    branch: main

kubectl apply after merge:

PR merged
CI/CD pipeline triggered
Runs kubectl apply
Changes deployed

GitHub Action:

- name: Deploy
  run: |
    kubectl apply -f k8s/

Best Practices

Require Reviews

Configure branch protection:

Settings → Branches → Branch Protection Rules
✓ Require pull request reviews before merging
✓ Require review from Code Owners
Number of required approvals: 2

Run CI Checks

Automate validation:

# .github/workflows/validate.yml
name: Validate
on: pull_request
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: YAML Lint
      run: yamllint k8s/

Use Semantic Commits

Follow conventional commits:

feat: Add rate limiting to API gateway
fix: Correct memory limit causing OOMKills
chore: Update nginx image to 1.21.6
docs: Update deployment README

Link Issues

Reference related issues:

Closes #123
Related to #456
Fixes #789

Auto-closes issues on merge

Test in Staging

Deploy to staging before production:

Create PR to staging branch
Merge and test
Create PR from staging to main
Merge to production

Small PRs

Keep PRs focused:✅ One logical change per PR ❌ Multiple unrelated changesEasier to review and safer to merge

Troubleshooting

PR Creation Failed

Symptom: “Failed to create PR” Check:

Permissions
- Orphelix App has write access?
- Repository not archived?
Branch Conflicts
- Branch already exists?
- Try different branch name
GitHub API Limits
- Rate limit exceeded?
- Wait 1 hour and retry

Merge Conflicts

Symptom: PR shows conflicts Resolution:

View Conflicts

Click “Resolve conflicts” on GitHub

Choose Resolution

Accept Theirs
Accept Yours
Manual Edit

Keep base branch version

Mark Resolved

Click “Mark as resolved”

Commit Resolution

Commit merge resolution

CI Checks Failing

Symptom: PR blocked by failed checks Solutions:

Review Check Logs
- Click “Details” next to failed check
- Read error messages
- Fix issues
Common Failures
- YAML Lint: Fix syntax errors
- Policy: Adjust to meet policies
- Tests: Fix broken tests
- Security: Update vulnerable images
Re-run Checks
- Push new commit
- Or click “Re-run checks”

Next Steps

YAML Editor

Learn about editing manifests

GitHub Setup

Configure GitHub integration

Deployments

Back to deployments

Repository Browser

Browse repository files

Features

GitHub Integration

Configuration

Overview

What are Pull Requests?

Code Review

Discussion

CI/CD Integration

Audit Trail

Creating Pull Requests

From YAML Editor

Multi-file Pull Requests

From Repository Browser

PR Templates

Default Template

Custom Templates

Managing Pull Requests

Viewing PRs

PR Status Indicators

Review Status

CI/CD Checks

PR Actions

Merging

Closing without Merging

Updating PRs

GitOps Workflow

Integration with GitOps Tools

Best Practices

Troubleshooting

PR Creation Failed

Merge Conflicts

CI Checks Failing

Next Steps

YAML Editor

GitHub Setup

Deployments

Repository Browser

Features

GitHub Integration

Configuration

​Overview

​What are Pull Requests?

Code Review

Discussion

CI/CD Integration

Audit Trail

​Creating Pull Requests

​From YAML Editor

​Multi-file Pull Requests

​From Repository Browser

​PR Templates

​Default Template

​Custom Templates

​Managing Pull Requests

​Viewing PRs

​PR Status Indicators

​Review Status

​CI/CD Checks

​PR Actions

​Merging

​Closing without Merging

​Updating PRs

​GitOps Workflow

​Integration with GitOps Tools

​Best Practices

​Troubleshooting

​PR Creation Failed

​Merge Conflicts

​CI Checks Failing

​Next Steps

YAML Editor

GitHub Setup

Deployments

Repository Browser

Overview

What are Pull Requests?

Creating Pull Requests

From YAML Editor

Multi-file Pull Requests

From Repository Browser

PR Templates

Default Template

Custom Templates

Managing Pull Requests

Viewing PRs

PR Status Indicators

Review Status

CI/CD Checks

PR Actions

Merging

Closing without Merging

Updating PRs

GitOps Workflow

Integration with GitOps Tools

Best Practices

Troubleshooting

PR Creation Failed

Merge Conflicts

CI Checks Failing

Next Steps