Skip to content

GITHUB_SETUP.md

Latest commit

 

History

History
220 lines (174 loc) · 4.84 KB

GITHUB_SETUP.md

File metadata and controls

220 lines (174 loc) · 4.84 KB
Raw

GitHub Setup Instructions

Step 1: Create GitHub Repository

Option A: Using GitHub Web UI

  1. Go to https://github.com/new
  2. Repository name: ai-project
  3. Description: "Production-ready AI data pipeline with TDD"
  4. Choose: Public or Private
  5. Do NOT initialize with README (we have one)
  6. Click "Create repository"

Option B: Using GitHub CLI

gh repo create ai-project \
  --description "Production-ready AI data pipeline with TDD" \
  --public \
  --source=. \
  --remote=origin \
  --push

Step 2: Initialize Git (If Not Already Done)

cd /Users/rellonaut/Projects/KIRO

# Initialize git
git init

# Add all files
git add .

# Create initial commit
git commit -m "feat: initial project scaffold with TDD"

# Add remote (replace YOUR_USERNAME)
git remote add origin https://github.com/YOUR_USERNAME/ai-project.git

# Rename branch to main (if needed)
git branch -M main

# Push to GitHub
git push -u origin main

Step 3: Configure GitHub Pages

Enable GitHub Pages

  1. Go to repository Settings
  2. Pages (left sidebar)
  3. Source: Deploy from a branch
  4. Branch: main
  5. Folder: /docs
  6. Save

Create GitHub Pages Site

# Create docs directory if not exists
mkdir -p docs

# Create index.html
cat > docs/index.html << 'EOF'
<!DOCTYPE html>
<html>
<head>
    <title>AI Data Pipeline</title>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <style>
        body { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif; margin: 40px; }
        h1 { color: #333; }
        a { color: #0066cc; text-decoration: none; }
        a:hover { text-decoration: underline; }
        .links { margin-top: 20px; }
        .links a { display: block; margin: 10px 0; }
    </style>
</head>
<body>
    <h1>AI Data Pipeline</h1>
    <p>Production-ready Python 3.12 data pipeline with test-driven development.</p>
    
    <h2>Documentation</h2>
    <div class="links">
        <a href="https://github.com/YOUR_USERNAME/ai-project">GitHub Repository</a>
        <a href="https://github.com/YOUR_USERNAME/ai-project#readme">README</a>
        <a href="https://github.com/YOUR_USERNAME/ai-project/blob/main/docs/INSTALLATION.md">Installation</a>
        <a href="https://github.com/YOUR_USERNAME/ai-project/blob/main/docs/DEVELOPMENT.md">Development</a>
        <a href="https://github.com/YOUR_USERNAME/ai-project/blob/main/docs/CONTRIBUTING.md">Contributing</a>
    </div>
</body>
</html>
EOF

# Commit and push
git add docs/index.html
git commit -m "docs: add GitHub Pages site"
git push origin main

Step 4: Verify Local Setup

# Install dependencies
pip install -e ".[dev]"

# Run tests
pytest --cov

# Run quality checks
make quality

# Run CLI
ai-project info

Step 5: Create First Release

# Create tag
git tag v0.1.0

# Push tag
git push origin v0.1.0

# GitHub Actions will automatically:
# - Run all tests
# - Build distributions
# - Publish to PyPI (if configured)
# - Create GitHub Release

Step 6: Configure Secrets (For CI/CD)

Add PyPI Token

  1. Go to repository Settings
  2. Secrets and variables → Actions
  3. New repository secret
  4. Name: PYPI_API_TOKEN
  5. Value: Your PyPI token from https://pypi.org/manage/account/tokens/

Create PyPI Environment

  1. Settings → Environments
  2. New environment
  3. Name: pypi

Troubleshooting

Issue: "fatal: not a git repository"

Solution: Initialize git

git init
git add .
git commit -m "initial commit"

Issue: "fatal: 'origin' does not appear to be a 'git' repository"

Solution: Add remote

git remote add origin https://github.com/YOUR_USERNAME/ai-project.git

Issue: "Permission denied (publickey)"

Solution: Setup SSH key

ssh-keygen -t ed25519 -C "your_email@example.com"
# Add public key to GitHub: https://github.com/settings/keys

Issue: GitHub Pages not showing

Solution: Check settings

  1. Settings → Pages
  2. Verify source is set to main branch, /docs folder
  3. Wait 1-2 minutes for deployment
  4. Check Actions tab for deployment status

Verification Checklist

  • Repository created on GitHub
  • Code pushed to main branch
  • GitHub Pages enabled
  • GitHub Pages site accessible
  • PyPI token configured (if publishing)
  • Tests passing locally
  • CI/CD workflows running
  • First release tagged

Quick Commands Reference

# Clone repository
git clone https://github.com/YOUR_USERNAME/ai-project.git
cd ai-project

# Setup development
./scripts/setup-dev.sh

# Run tests
pytest

# Run quality checks
make quality

# Create release
git tag v1.0.0
git push origin v1.0.0

Next Steps

  1. ✅ Create GitHub repository
  2. ✅ Push code
  3. ✅ Enable GitHub Pages
  4. ✅ Configure CI/CD secrets
  5. ✅ Create first release
  6. ✅ Share repository link

Last Updated: January 16, 2026