fix: Remove incompatible GitHub Actions workflow for Gitea
Validate Project / validate (push) Successful in 15s
Validate Project / validate (push) Successful in 15s
This commit is contained in:
@@ -1,254 +0,0 @@
|
|||||||
name: Create Pull Request
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- move_docs
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
create-pr:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Analyze Changes and Prepare PR
|
|
||||||
id: analyze
|
|
||||||
run: |
|
|
||||||
# Get current branch
|
|
||||||
CURRENT_BRANCH=$(git branch --show-current)
|
|
||||||
|
|
||||||
# Check remote branches for develop
|
|
||||||
if git ls-remote --heads origin develop > /dev/null 2>&1; then
|
|
||||||
TARGET_BRANCH=develop
|
|
||||||
else
|
|
||||||
TARGET_BRANCH=main
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "current_branch=$CURRENT_BRANCH" >> $GITHUB_OUTPUT
|
|
||||||
echo "target_branch=$TARGET_BRANCH" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- name: Get Git Diff Summary
|
|
||||||
id: diff
|
|
||||||
run: |
|
|
||||||
# Get changed files count
|
|
||||||
CHANGED_FILES=$(git diff --name-only ${{ steps.analyze.outputs.target_branch }}...HEAD | wc -l)
|
|
||||||
INSERTIONS=$(git diff --numstat ${{ steps.analyze.outputs.target_branch }}...HEAD 2>/dev/null | awk '{sum += $1} END {print sum+0}')
|
|
||||||
DELETIONS=$(git diff --numstat ${{ steps.analyze.outputs.target_branch }}...HEAD 2>/dev/null | awk '{sum += $2} END {print sum+0}')
|
|
||||||
|
|
||||||
echo "changed_files=$CHANGED_FILES" >> $GITHUB_OUTPUT
|
|
||||||
echo "insertions=$INSERTIONS" >> $GITHUB_OUTPUT
|
|
||||||
echo "deletions=$DELETIONS" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- name: Validate Project Before PR
|
|
||||||
id: validate
|
|
||||||
run: |
|
|
||||||
# Check if project is valid (basic check)
|
|
||||||
git log --oneline -1 --quiet > /dev/null 2>&1
|
|
||||||
|
|
||||||
if [ $? -eq 0 ]; then
|
|
||||||
echo "VALIDATION_STATUS=passed" >> $GITHUB_OUTPUT
|
|
||||||
else
|
|
||||||
echo "VALIDATION_STATUS=failed" >> $GITHUB_OUTPUT
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Generate PR Description
|
|
||||||
id: pr_desc
|
|
||||||
run: |
|
|
||||||
# Get current branch info
|
|
||||||
CURRENT_BRANCH=$(git branch --show-current)
|
|
||||||
|
|
||||||
# Determine target branch
|
|
||||||
if git ls-remote --heads origin develop > /dev/null 2>&1; then
|
|
||||||
TARGET_BRANCH=develop
|
|
||||||
else
|
|
||||||
TARGET_BRANCH=main
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Get commit count since last common ancestor
|
|
||||||
COMMIT_COUNT=$(git rev-list --count ${{ steps.analyze.outputs.target_branch }}..HEAD 2>/dev/null || echo "1")
|
|
||||||
|
|
||||||
# Generate comprehensive PR description using the make-pr skill logic
|
|
||||||
cat > ${{ github.workspace }}/pr_template.md << 'PR_DESC'
|
|
||||||
---
|
|
||||||
**Pull Request Description - Generated by make-pr skill**
|
|
||||||
|
|
||||||
## Context
|
|
||||||
|
|
||||||
This PR organizes and consolidates all AI documentation files into a structured folder (`AI Docs/`) to improve maintainability and clarity for AI-assisted development workflows.
|
|
||||||
|
|
||||||
The changes move documentation from the root directory into an organized folder structure, ensuring all planning, architectural, skills, and testing guides are co-located.
|
|
||||||
|
|
||||||
### Files Affected
|
|
||||||
- **Moved:** `AI Docs/01-AI-GUIDE.md` → `AI_HELP.md` (renamed for clarity)
|
|
||||||
- **Moved:** `AI Docs/02-ARCHITECTURE.md` → `ARCHITECTURE.md` (renamed to remove version prefix)
|
|
||||||
- **New:** `AI Docs/PLAN.md` (reorganized content)
|
|
||||||
- **New:** `AI Docs/PLAN_MORE.md` (additional planning notes)
|
|
||||||
- **Modified:** `AI Docs/04-TESTING-WORKFLOW.md` (updated with make-pr skill reference)
|
|
||||||
- **Modified:** `AI Docs/05-SKILLS-REFERENCE.md` (added make-pr skill documentation)
|
|
||||||
|
|
||||||
## Changes Overview
|
|
||||||
|
|
||||||
### 📁 File Structure Reorganization
|
|
||||||
|
|
||||||
**Previously:**
|
|
||||||
```
|
|
||||||
- 01-AI-GUIDE.md
|
|
||||||
- 02-ARCHITECTURE.md
|
|
||||||
- PLAN.md
|
|
||||||
- PLAN_MORE.md
|
|
||||||
- TESTING-WORKFLOW.md
|
|
||||||
- SKILLS-REFERENCE.md
|
|
||||||
```
|
|
||||||
|
|
||||||
**Now:**
|
|
||||||
```
|
|
||||||
AI Docs/
|
|
||||||
├── 01-AI-GUIDE.md → AI_HELP.md (helpful for AI assistants)
|
|
||||||
├── 02-ARCHITECTURE.md → ARCHITECTURE.md (clean naming)
|
|
||||||
├── PLAN.md (reorganized planning documentation)
|
|
||||||
├── PLAN_MORE.md (additional planning notes)
|
|
||||||
├── 04-TESTING-WORKFLOW.md (testing procedures)
|
|
||||||
└── 05-SKILLS-REFERENCE.md (skills and commands reference)
|
|
||||||
```
|
|
||||||
|
|
||||||
### ✨ New Features & Improvements
|
|
||||||
|
|
||||||
1. **make-pr Skill Added** - A new AI skill that automatically creates pull requests with:
|
|
||||||
- Human-readable change overviews
|
|
||||||
- Testing strategy suggestions
|
|
||||||
- Validation status reporting
|
|
||||||
- Clear context for reviewers
|
|
||||||
|
|
||||||
2. **Improved Documentation Organization** - All AI-related documentation now lives in a single folder, making it easier to:
|
|
||||||
- Find relevant guides when prompting AI assistants
|
|
||||||
- Maintain consistent documentation structure
|
|
||||||
- Onboard new developers to AI-assisted workflows
|
|
||||||
|
|
||||||
3. **Enhanced Skills Reference** - The `05-SKILLS-REFERENCE.md` now includes comprehensive documentation for the `make-pr` skill, explaining:
|
|
||||||
- When to use it
|
|
||||||
- Input requirements
|
|
||||||
- Prompt templates
|
|
||||||
- Output format expectations
|
|
||||||
|
|
||||||
### 🧪 Testing Strategy
|
|
||||||
|
|
||||||
#### Unit Testing
|
|
||||||
- No unit tests were added or removed as part of this documentation reorganization
|
|
||||||
- Documentation changes are non-functional and require no code testing
|
|
||||||
|
|
||||||
#### Integration Testing
|
|
||||||
- Manual verification that all documentation files are accessible
|
|
||||||
- Ensure AI assistants can reference `AI Docs/` folder contents
|
|
||||||
- Verify `05-SKILLS-REFERENCE.md` includes all new skills correctly
|
|
||||||
|
|
||||||
#### Manual QA Steps
|
|
||||||
1. Open the project in Git/Gitea and verify all files are present:
|
|
||||||
- Navigate to `/AI Docs/` directory
|
|
||||||
- Confirm all 6 files exist with expected content
|
|
||||||
|
|
||||||
2. Test AI Assistant Integration:
|
|
||||||
- Prompt: "Use the make-pr skill to create a PR from move_docs to develop"
|
|
||||||
- Verify the skill correctly identifies the current branch and changes
|
|
||||||
|
|
||||||
3. Review Documentation Accessibility:
|
|
||||||
- Confirm `AI_HELP.md` contains helpful AI prompting context
|
|
||||||
- Verify `ARCHITECTURE.md` has system boundaries documented
|
|
||||||
- Check `SKILLS-REFERENCE.md` lists all available skills correctly
|
|
||||||
|
|
||||||
#### Regression Areas to Check
|
|
||||||
- **No regression testing required** for documentation-only changes
|
|
||||||
- **However**, verify that:
|
|
||||||
- No code files were accidentally moved or deleted
|
|
||||||
- Git history remains intact and readable
|
|
||||||
- All file permissions are preserved
|
|
||||||
|
|
||||||
### ✅ Validation Performed
|
|
||||||
|
|
||||||
The following validation has been completed:
|
|
||||||
|
|
||||||
1. **Local Commit Verification**:
|
|
||||||
- ✅ Changes successfully committed on `move_docs` branch
|
|
||||||
- ✅ Commit message: "Moving documents to their own folder"
|
|
||||||
- ✅ Git diff shows expected files changed (6 files)
|
|
||||||
- ✅ No merge conflicts detected
|
|
||||||
|
|
||||||
2. **File Integrity Check**:
|
|
||||||
- ✅ All 6 target files present in `AI Docs/` directory
|
|
||||||
- ✅ File sizes and permissions preserved
|
|
||||||
- ✅ Content verified for key files (`AI_HELP.md`, `ARCHITECTURE.md`)
|
|
||||||
|
|
||||||
3. **Branch Structure Validation**:
|
|
||||||
- ✅ `move_docs` branch contains all changes
|
|
||||||
- ✅ Changes are ready to merge into `develop`
|
|
||||||
- ✅ No sensitive files or secrets included
|
|
||||||
|
|
||||||
4. **PR Creation Prerequisites**:
|
|
||||||
- ✅ Target branch (`develop`) exists and is reachable
|
|
||||||
- ✅ No unmerged conflicts with current state
|
|
||||||
- ✅ Project validates on local checkout
|
|
||||||
|
|
||||||
### ⚠️ Known Issues & Limitations
|
|
||||||
|
|
||||||
- **None identified** - This is a documentation-only change with no code modifications
|
|
||||||
- All files are text-based markdown with no binary dependencies
|
|
||||||
- Changes are purely organizational and additive (improved discoverability)
|
|
||||||
|
|
||||||
### 📋 Reviewer Notes
|
|
||||||
|
|
||||||
**Key Areas Requiring Attention:**
|
|
||||||
|
|
||||||
1. **AI Assistant Testing**: Before merging, verify that AI assistants can:
|
|
||||||
- Read the `AI Docs/` folder successfully
|
|
||||||
- Parse the new skills reference correctly
|
|
||||||
- Access `make-pr` skill documentation
|
|
||||||
|
|
||||||
2. **Naming Convention Consistency**: Note that:
|
|
||||||
- `01-AI-GUIDE.md` was renamed to `AI_HELP.md` (more AI-friendly name)
|
|
||||||
- `02-ARCHITECTURE.md` had version prefix removed (cleaner naming)
|
|
||||||
- Reviewers should understand this is intentional for better organization
|
|
||||||
|
|
||||||
3. **Future Documentation Additions**: Going forward, consider:
|
|
||||||
- Adding new docs to `AI Docs/` folder rather than root
|
|
||||||
- Following the existing numbering scheme (01-05) for guide files
|
|
||||||
- Using descriptive names over versioned prefixes where possible
|
|
||||||
|
|
||||||
### 🔄 Migration Notes (If Merged)
|
|
||||||
|
|
||||||
After this PR merges, the old location of these files will become stale:
|
|
||||||
|
|
||||||
**Old paths (will be deleted or archived):**
|
|
||||||
- `01-AI-GUIDE.md` → now at `AI Docs/AI_HELP.md`
|
|
||||||
- `02-ARCHITECTURE.md` → now at `AI Docs/ARCHITECTURE.md`
|
|
||||||
- `PLAN.md` → now at `AI Docs/PLAN.md`
|
|
||||||
- `PLAN_MORE.md` → now at `AI Docs/PLAN_MORE.md`
|
|
||||||
- `TESTING-WORKFLOW.md` → now at `AI Docs/04-TESTING-WORKFLOW.md`
|
|
||||||
- `SKILLS-REFERENCE.md` → now at `AI Docs/05-SKILLS-REFERENCE.md`
|
|
||||||
|
|
||||||
**Recommended action for existing references:**
|
|
||||||
Update any code, scripts, or documentation that references the old paths to point to the new locations.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Summary
|
|
||||||
|
|
||||||
This PR reorganizes AI documentation into a well-structured folder with:
|
|
||||||
- ✅ 6 files moved/renamed for better organization
|
|
||||||
- ✅ New `make-pr` skill for automated PR creation
|
|
||||||
- ✅ Enhanced skills reference documentation
|
|
||||||
- ✅ No code changes - purely organizational improvements
|
|
||||||
|
|
||||||
**Ready to merge?** ✅ Yes, all validation checks passed.
|
|
||||||
PR_DESC
|
|
||||||
|
|
||||||
# Output the PR description
|
|
||||||
echo "### Generated PR Description" >> $GITHUB_OUTPUT
|
|
||||||
cat ${{ github.workspace }}/pr_template.md >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- name: Create Pull Request
|
|
||||||
uses: repo-sync/create-pull-request@v2
|
|
||||||
with:
|
|
||||||
source-branch: ${{ steps.analyze.outputs.current_branch }}
|
|
||||||
destination-branch: ${{ steps.analyze.outputs.target_branch }}
|
|
||||||
title: "[AI Docs] Reorganize documentation into structured folder"
|
|
||||||
body: ${{ steps.pr_desc.outputs.body }}
|
|
||||||
author-email: andrew@example.com
|
|
||||||
author-name: Andrew Yeet
|
|
||||||
Reference in New Issue
Block a user