mirror of
https://github.com/lifting-bits/sleigh
synced 2026-06-21 13:56:12 +00:00
Eric Kilmer
86f39ba60f
Add functionality to the weekly sync workflow to detect newly added or deleted C++ source files and spec files that may require manual CMake configuration updates. When such files are detected, the PR body will include a warning section listing the files and instructions for maintainers. This addresses issue #121 where new files added to Sleigh in Ghidra weren't being noticed, leading to missing headers that required manual fixes later. Changes: - Add CategorizedChanges dataclass to track added/deleted cpp/spec files - Add helper methods to parse git status and categorize files - Expand IGNORED_EXTENSIONS to filter more non-relevant file types - Set new GitHub Actions outputs: needs_manual_intervention and intervention_details - Update workflow to conditionally add warning section to PR body Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
105 lines
3.2 KiB
YAML
105 lines
3.2 KiB
YAML
name: Update Ghidra Sleigh
|
|
|
|
on:
|
|
schedule:
|
|
- cron: '0 0 * * 1'
|
|
|
|
# Should only be manually run on default branch (master)
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
update:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- uses: actions/checkout@v6
|
|
|
|
- uses: actions/setup-python@v6
|
|
with:
|
|
# Use oldest supported version for maximum script compatibility
|
|
python-version: '3.10'
|
|
|
|
- name: Run Update Script
|
|
id: head_update
|
|
run: |
|
|
# Sets some outputs. See next step
|
|
python3 scripts/update_ghidra_head.py --ci
|
|
|
|
# Need this to run further Actions on the newly created PR
|
|
# See here for more details https://github.com/peter-evans/create-pull-request/blob/28fa4848947e0faa7fa50647691d01477589d5e9/docs/concepts-guidelines.md#authenticating-with-github-app-generated-tokens
|
|
- uses: tibdex/github-app-token@v2
|
|
if: steps.head_update.outputs.did_update
|
|
id: generate-token
|
|
with:
|
|
app_id: ${{ secrets.APP_ID }}
|
|
private_key: ${{ secrets.APP_PRIVATE_KEY }}
|
|
|
|
- name: Commit, push, and create PR
|
|
if: steps.head_update.outputs.did_update
|
|
env:
|
|
GH_TOKEN: ${{ steps.generate-token.outputs.token }}
|
|
run: |
|
|
BRANCH="cron/update-ghidra-${{ steps.head_update.outputs.short_sha }}"
|
|
|
|
# Check if PR already exists for this branch
|
|
if gh pr list --head "$BRANCH" --json number --jq '.[0].number' | grep -q .; then
|
|
echo "PR already exists for branch $BRANCH, skipping"
|
|
exit 0
|
|
fi
|
|
|
|
# Configure git
|
|
git config user.name "github-actions[bot]"
|
|
git config user.email "github-actions[bot]@users.noreply.github.com"
|
|
|
|
# Create branch and commit
|
|
git checkout -b "$BRANCH"
|
|
git add -A
|
|
git commit -m "$(cat <<'EOF'
|
|
Bump Ghidra HEAD commit ${{ steps.head_update.outputs.short_sha }}
|
|
|
|
Changed files:
|
|
|
|
${{ steps.head_update.outputs.changed_files }}
|
|
|
|
Commit details:
|
|
|
|
${{ steps.head_update.outputs.commit_details }}
|
|
EOF
|
|
)"
|
|
|
|
# Push branch
|
|
git push -u origin "$BRANCH"
|
|
|
|
# Build PR body
|
|
PR_BODY="Changed files:
|
|
|
|
${{ steps.head_update.outputs.changed_files }}
|
|
|
|
Commit details:
|
|
|
|
${{ steps.head_update.outputs.commit_details }}"
|
|
|
|
# Add intervention warning if needed
|
|
if [ "${{ steps.head_update.outputs.needs_manual_intervention }}" = "true" ]; then
|
|
PR_BODY="## :warning: Manual Intervention Required
|
|
|
|
The following files were added or deleted and may require manual CMake configuration updates:
|
|
|
|
${{ steps.head_update.outputs.intervention_details }}
|
|
|
|
### Instructions
|
|
- **New C++ sources**: Add to appropriate list in \`src/setup-ghidra-source.cmake\`
|
|
- **Deleted C++ sources**: Remove from \`src/setup-ghidra-source.cmake\`
|
|
- **New spec files**: Review if \`.slaspec\` files are auto-generated; other types may need manual updates
|
|
- **Deleted spec files**: Verify no longer referenced
|
|
|
|
---
|
|
|
|
$PR_BODY"
|
|
fi
|
|
|
|
# Create PR
|
|
gh pr create \
|
|
--title "Update Ghidra HEAD to commit ${{ steps.head_update.outputs.short_sha }}" \
|
|
--body "$PR_BODY"
|