-
Notifications
You must be signed in to change notification settings - Fork 424
Expand file tree
/
Copy pathcommit-changes-analyzer.lock.yml
More file actions
7620 lines (7472 loc) · 360 KB
/
Copy pathcommit-changes-analyzer.lock.yml
File metadata and controls
7620 lines (7472 loc) · 360 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# ___ _ _
# / _ \ | | (_)
# | |_| | __ _ ___ _ __ | |_ _ ___
# | _ |/ _` |/ _ \ '_ \| __| |/ __|
# | | | | (_| | __/ | | | |_| | (__
# \_| |_/\__, |\___|_| |_|\__|_|\___|
# __/ |
# _ _ |___/
# | | | | / _| |
# | | | | ___ _ __ _ __| |_| | _____ ____
# | |/\| |/ _ \ '__| |/ /| _| |/ _ \ \ /\ / / ___|
# \ /\ / (_) | | | | ( | | | | (_) \ V V /\__ \
# \/ \/ \___/|_| |_|\_\|_| |_|\___/ \_/\_/ |___/
#
# This file was automatically generated by gh-aw. DO NOT EDIT.
#
# To update this file, edit the corresponding .md file and run:
# gh aw compile
# For more information: https://github.com/githubnext/gh-aw/blob/main/.github/aw/github-agentic-workflows.md
#
#
# Analyzes and provides a comprehensive developer-focused report of all changes in the repository since a specified commit
#
# Original Frontmatter:
# ```yaml
# name: Commit Changes Analyzer
# description: Analyzes and provides a comprehensive developer-focused report of all changes in the repository since a specified commit
# on:
# workflow_dispatch:
# inputs:
# commit_url:
# description: 'GitHub commit URL to analyze changes since (e.g., https://github.com/owner/repo/commit/abc123)'
# required: true
# type: string
# permissions:
# contents: read
# issues: read
# pull-requests: read
# engine:
# id: claude
# max-turns: 100
# tools:
# github:
# toolsets: [default]
# bash:
# - "*"
# edit:
# safe-outputs:
# create-discussion:
# category: "dev"
# max: 1
# timeout-minutes: 30
# imports:
# - shared/reporting.md
# ```
#
# Resolved workflow manifest:
# Imports:
# - shared/reporting.md
#
# Job Dependency Graph:
# ```mermaid
# graph LR
# activation["activation"]
# agent["agent"]
# conclusion["conclusion"]
# create_discussion["create_discussion"]
# detection["detection"]
# activation --> agent
# activation --> conclusion
# agent --> conclusion
# agent --> create_discussion
# agent --> detection
# create_discussion --> conclusion
# detection --> conclusion
# detection --> create_discussion
# ```
#
# Original Prompt:
# ```markdown
# ## Report Formatting
#
# Structure your report with an overview followed by detailed content:
#
# 1. **Content Overview**: Start with 1-2 paragraphs that summarize the key findings, highlights, or main points of your report. This should give readers a quick understanding of what the report contains without needing to expand the details.
#
# 2. **Detailed Content**: Place the rest of your report inside HTML `<details>` and `<summary>` tags to allow readers to expand and view the full information. **IMPORTANT**: Always wrap the summary text in `<b>` tags to make it bold.
#
# **Example format:**
#
# `````markdown
# Brief overview paragraph 1 introducing the report and its main findings.
#
# Optional overview paragraph 2 with additional context or highlights.
#
# <details>
# <summary><b>Full Report Details</b></summary>
#
# ## Detailed Analysis
#
# Full report content with all sections, tables, and detailed information goes here.
#
# ### Section 1
# [Content]
#
# ### Section 2
# [Content]
#
# </details>
# `````
#
# ## Reporting Workflow Run Information
#
# When analyzing workflow run logs or reporting information from GitHub Actions runs:
#
# ### 1. Workflow Run ID Formatting
#
# **Always render workflow run IDs as clickable URLs** when mentioning them in your report. The workflow run data includes a `url` field that provides the full GitHub Actions run page URL.
#
# **Format:**
#
# `````markdown
# [§12345](https://github.com/owner/repo/actions/runs/12345)
# `````
#
# **Example:**
#
# `````markdown
# Analysis based on [§456789](https://github.com/githubnext/gh-aw/actions/runs/456789)
# `````
#
# ### 2. Document References for Workflow Runs
#
# When your analysis is based on information mined from one or more workflow runs, **include up to 3 workflow run URLs as document references** at the end of your report.
#
# **Format:**
#
# `````markdown
# ---
#
# **References:**
# - [§12345](https://github.com/owner/repo/actions/runs/12345)
# - [§12346](https://github.com/owner/repo/actions/runs/12346)
# - [§12347](https://github.com/owner/repo/actions/runs/12347)
# `````
#
# **Guidelines:**
#
# - Include **maximum 3 references** to keep reports concise
# - Choose the most relevant or representative runs (e.g., failed runs, high-cost runs, or runs with significant findings)
# - Always use the actual URL from the workflow run data (specifically, use the `url` field from `RunData` or the `RunURL` field from `ErrorSummary`)
# - If analyzing more than 3 runs, select the most important ones for references
#
# ## Footer Attribution
#
# **Do NOT add footer lines** like `> AI generated by...` to your comment. The system automatically appends attribution after your content to prevent duplicates.
#
# # Commit Changes Analyzer
#
# Analyze and provide a comprehensive description of all changes in the repository since a given commit.
#
# ## Mission
#
# Generate a detailed developer-focused report analyzing all changes in the repository since the commit specified in the input URL.
#
# ## Context
#
# - **Repository**: ${{ github.repository }}
# - **Commit URL**: ${{ github.event.inputs.commit_url }}
# - **Triggered by**: ${{ github.actor }}
#
# ## Task
#
# Your task is to analyze all changes since the specified commit and create a comprehensive report for developers on the team.
#
# ### 1. Extract Commit SHA from URL
#
# Parse the commit URL provided in the input to extract:
# - Repository owner and name (validate it matches current repo)
# - Commit SHA
#
# The URL format is typically: `https://github.com/OWNER/REPO/commit/SHA`
#
# ### 2. Validate the Commit
#
# Before proceeding, verify:
# - The commit SHA exists in the repository
# - The repository in the URL matches the current repository
# - The commit is an ancestor of the current HEAD (can trace history from current to that commit)
#
# Use bash commands like:
# ```bash
# # Verify commit exists
# git cat-file -t <SHA>
#
# # Check if commit is ancestor
# git merge-base --is-ancestor <SHA> HEAD
# ```
#
# ### 3. Analyze Changes
#
# Collect comprehensive information about all changes since the specified commit:
#
# #### File Changes
# - **Files added**: List all new files with brief description of purpose
# - **Files modified**: List changed files with summary of modifications
# - **Files deleted**: List removed files
# - **Files renamed/moved**: Track file movements
# - **Binary files changed**: Note any binary file changes
#
# Use commands like:
# ```bash
# # Get list of changed files with status
# git diff --name-status <SHA>..HEAD
#
# # Get detailed statistics
# git diff --stat <SHA>..HEAD
#
# # Get number of commits
# git rev-list --count <SHA>..HEAD
# ```
#
# #### Commit Analysis
# - **Number of commits** since the specified commit
# - **Commit authors** and their contribution counts
# - **Commit timeline**: First and most recent commit dates
# - **Commit messages**: Extract key themes and patterns
#
# Use commands like:
# ```bash
# # List commits with authors
# git log --pretty=format:"%h - %an, %ar : %s" <SHA>..HEAD
#
# # Count commits by author
# git shortlog -s -n <SHA>..HEAD
#
# # Get commit timeline
# git log --pretty=format:"%ai" <SHA>..HEAD | head -1 # Most recent
# git log --pretty=format:"%ai" <SHA>..HEAD | tail -1 # Oldest in range
# ```
#
# #### Code Impact Analysis
# - **Lines added**: Total lines of code added
# - **Lines removed**: Total lines of code removed
# - **Net change**: Overall code delta
# - **Language breakdown**: Changes by file type/language
# - **Largest changes**: Files with most modifications
#
# Use commands like:
# ```bash
# # Detailed diff statistics
# git diff --numstat <SHA>..HEAD
#
# # Count by file extension
# git diff --name-only <SHA>..HEAD | sed 's/.*\.//' | sort | uniq -c | sort -rn
# ```
#
# #### Functional Areas Affected
# Analyze which parts of the codebase were touched:
# - **Package/module changes**: Which packages/directories had changes
# - **Configuration changes**: Any config file updates
# - **Documentation changes**: README, docs, comments
# - **Test changes**: New or modified tests
# - **Build/CI changes**: Workflow, Makefile, build script changes
#
# ### 4. GitHub Integration Analysis
#
# Use GitHub tools to enrich the analysis:
# - **Associated Pull Requests**: Find PRs that include commits in this range
# - **Issues referenced**: Extract issue numbers from commit messages
# - **Release context**: Check if any releases occurred in this range
#
# Example GitHub tool usage:
# ```
# Use list_commits to get commit details
# Use search_issues or search_pull_requests to find related items
# Use list_releases to check for releases in the timeframe
# ```
#
# ### 5. Generate Developer Report
#
# Create a comprehensive markdown report with the following sections:
#
# #### Executive Summary
# - Brief overview of the change scope
# - Time period covered
# - Number of commits and authors involved
# - High-level impact assessment
#
# #### Detailed Changes
#
# **Files Changed Summary**
# - Breakdown by change type (added/modified/deleted/renamed)
# - Statistics table with counts and percentages
#
# **Code Impact**
# - Lines added/removed/changed
# - Net code growth/reduction
# - Language/file type breakdown
#
# **Commit History**
# - Total commits in range
# - Top contributors with commit counts
# - Timeline (date range)
# - Commit message themes/patterns
#
# **Functional Areas**
# - List of affected packages/modules
# - Configuration changes
# - Documentation updates
# - Test coverage changes
# - CI/CD modifications
#
# **Notable Changes**
# - Largest file changes (top 10)
# - New files of significance
# - Deleted files worth noting
# - Breaking changes or major refactors
#
# **Related Work**
# - Associated pull requests (if found)
# - Referenced issues
# - Related releases
#
# #### Developer Notes
# - Potential migration concerns
# - Breaking changes to be aware of
# - New dependencies or tools introduced
# - Recommended review areas for code reviewers
#
# ### 6. Output Format
#
# Create a GitHub discussion with:
# - **Title**: "Changes Analysis: Since commit [short-SHA] - [current date]"
# - **Category**: "dev" (for development discussions)
# - **Body**: Your complete analysis report in well-formatted markdown
#
# Use proper markdown formatting:
# - Tables for statistics
# - Code blocks for examples
# - Bullet lists for file changes
# - Emphasis for important items
# - Links to commits, PRs, issues where relevant
#
# ## Guidelines
#
# - **Be thorough**: This is for developers who need detailed information
# - **Be accurate**: Verify all data before including it
# - **Be organized**: Use clear sections and formatting
# - **Be actionable**: Highlight things developers need to know
# - **Include context**: Don't just list changes, explain their significance
# - **Handle errors gracefully**: If the commit URL is invalid or commit doesn't exist, explain the issue clearly
# - **Use relative references**: When mentioning commits, include both short SHA and subject line
# - **Link to GitHub**: Include links to relevant commits, PRs, files when helpful
#
# ## Security
#
# - Validate that the commit SHA from the URL is a valid git SHA format
# - Ensure the repository in the URL matches the current repository
# - Don't execute any code files during analysis
# - Focus on metadata and diffs, not file contents unless relevant
#
# ## Examples of Good Analysis
#
# When describing a commit:
# - ✅ `abc1234 - Refactor parser to use streaming approach (reduces memory by 40%)`
# - ❌ `abc1234 - parser changes`
#
# When listing files:
# - ✅ `pkg/parser/stream.go - New streaming parser implementation to handle large files`
# - ❌ `pkg/parser/stream.go - added`
#
# When describing impact:
# - ✅ `Breaking change: CLI flag --output renamed to --format (affects all users)`
# - ❌ `CLI changes made`
#
# ## Error Handling
#
# If any of these conditions occur, explain clearly in the discussion:
# - Invalid commit URL format
# - Commit SHA not found in repository
# - Repository mismatch between URL and current repo
# - Commit is not an ancestor of HEAD
# - No commits found in the range (commit is already at HEAD)
#
# Make the error message helpful so the user knows how to correct the input.
# ```
#
# Pinned GitHub Actions:
# - actions/checkout@v5 (93cb6efe18208431cddfb8368fd83d5badbf9bfd)
# https://github.com/actions/checkout/commit/93cb6efe18208431cddfb8368fd83d5badbf9bfd
# - actions/download-artifact@v6 (018cc2cf5baa6db3ef3c5f8a56943fffe632ef53)
# https://github.com/actions/download-artifact/commit/018cc2cf5baa6db3ef3c5f8a56943fffe632ef53
# - actions/github-script@v8 (ed597411d8f924073f98dfc5c65a23a2325f34cd)
# https://github.com/actions/github-script/commit/ed597411d8f924073f98dfc5c65a23a2325f34cd
# - actions/setup-node@v6 (395ad3262231945c25e8478fd5baf05154b1d79f)
# https://github.com/actions/setup-node/commit/395ad3262231945c25e8478fd5baf05154b1d79f
# - actions/upload-artifact@v5 (330a01c490aca151604b8cf639adc76d48f6c5d4)
# https://github.com/actions/upload-artifact/commit/330a01c490aca151604b8cf639adc76d48f6c5d4
name: "Commit Changes Analyzer"
"on":
workflow_dispatch:
inputs:
commit_url:
description: GitHub commit URL to analyze changes since (e.g., https://github.com/owner/repo/commit/abc123)
required: true
type: string
permissions: {}
concurrency:
group: "gh-aw-${{ github.workflow }}"
run-name: "Commit Changes Analyzer"
jobs:
activation:
runs-on: ubuntu-slim
permissions:
contents: read
outputs:
comment_id: ""
comment_repo: ""
steps:
- name: Check workflow file timestamps
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
env:
GH_AW_WORKFLOW_FILE: "commit-changes-analyzer.lock.yml"
with:
script: |
async function main() {
const workflowFile = process.env.GH_AW_WORKFLOW_FILE;
if (!workflowFile) {
core.setFailed("Configuration error: GH_AW_WORKFLOW_FILE not available.");
return;
}
const workflowBasename = workflowFile.replace(".lock.yml", "");
const workflowMdPath = `.github/workflows/${workflowBasename}.md`;
const lockFilePath = `.github/workflows/${workflowFile}`;
core.info(`Checking workflow timestamps using GitHub API:`);
core.info(` Source: ${workflowMdPath}`);
core.info(` Lock file: ${lockFilePath}`);
const { owner, repo } = context.repo;
const ref = context.sha;
async function getLastCommitForFile(path) {
try {
const response = await github.rest.repos.listCommits({
owner,
repo,
path,
per_page: 1,
sha: ref,
});
if (response.data && response.data.length > 0) {
const commit = response.data[0];
return {
sha: commit.sha,
date: commit.commit.committer.date,
message: commit.commit.message,
};
}
return null;
} catch (error) {
core.info(`Could not fetch commit for ${path}: ${error.message}`);
return null;
}
}
const workflowCommit = await getLastCommitForFile(workflowMdPath);
const lockCommit = await getLastCommitForFile(lockFilePath);
if (!workflowCommit) {
core.info(`Source file does not exist: ${workflowMdPath}`);
}
if (!lockCommit) {
core.info(`Lock file does not exist: ${lockFilePath}`);
}
if (!workflowCommit || !lockCommit) {
core.info("Skipping timestamp check - one or both files not found");
return;
}
const workflowDate = new Date(workflowCommit.date);
const lockDate = new Date(lockCommit.date);
core.info(` Source last commit: ${workflowDate.toISOString()} (${workflowCommit.sha.substring(0, 7)})`);
core.info(` Lock last commit: ${lockDate.toISOString()} (${lockCommit.sha.substring(0, 7)})`);
if (workflowDate > lockDate) {
const warningMessage = `WARNING: Lock file '${lockFilePath}' is outdated! The workflow file '${workflowMdPath}' has been modified more recently. Run 'gh aw compile' to regenerate the lock file.`;
core.error(warningMessage);
const workflowTimestamp = workflowDate.toISOString();
const lockTimestamp = lockDate.toISOString();
let summary = core.summary
.addRaw("### ⚠️ Workflow Lock File Warning\n\n")
.addRaw("**WARNING**: Lock file is outdated and needs to be regenerated.\n\n")
.addRaw("**Files:**\n")
.addRaw(`- Source: \`${workflowMdPath}\`\n`)
.addRaw(` - Last commit: ${workflowTimestamp}\n`)
.addRaw(
` - Commit SHA: [\`${workflowCommit.sha.substring(0, 7)}\`](https://github.com/${owner}/${repo}/commit/${workflowCommit.sha})\n`
)
.addRaw(`- Lock: \`${lockFilePath}\`\n`)
.addRaw(` - Last commit: ${lockTimestamp}\n`)
.addRaw(` - Commit SHA: [\`${lockCommit.sha.substring(0, 7)}\`](https://github.com/${owner}/${repo}/commit/${lockCommit.sha})\n\n`)
.addRaw("**Action Required:** Run `gh aw compile` to regenerate the lock file.\n\n");
await summary.write();
} else if (workflowCommit.sha === lockCommit.sha) {
core.info("✅ Lock file is up to date (same commit)");
} else {
core.info("✅ Lock file is up to date");
}
}
main().catch(error => {
core.setFailed(error instanceof Error ? error.message : String(error));
});
agent:
needs: activation
runs-on: ubuntu-latest
permissions:
contents: read
issues: read
pull-requests: read
concurrency:
group: "gh-aw-claude-${{ github.workflow }}"
env:
GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs
GH_AW_SAFE_OUTPUTS: /tmp/gh-aw/safeoutputs/outputs.jsonl
GH_AW_SAFE_OUTPUTS_CONFIG_PATH: /tmp/gh-aw/safeoutputs/config.json
GH_AW_SAFE_OUTPUTS_TOOLS_PATH: /tmp/gh-aw/safeoutputs/tools.json
outputs:
has_patch: ${{ steps.collect_output.outputs.has_patch }}
model: ${{ steps.generate_aw_info.outputs.model }}
output: ${{ steps.collect_output.outputs.output }}
output_types: ${{ steps.collect_output.outputs.output_types }}
steps:
- name: Checkout repository
uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
with:
persist-credentials: false
- name: Create gh-aw temp directory
run: |
mkdir -p /tmp/gh-aw/agent
mkdir -p /tmp/gh-aw/sandbox/agent/logs
echo "Created /tmp/gh-aw/agent directory for agentic workflow temporary files"
- name: Configure Git credentials
env:
REPO_NAME: ${{ github.repository }}
SERVER_URL: ${{ github.server_url }}
run: |
git config --global user.email "github-actions[bot]@users.noreply.github.com"
git config --global user.name "github-actions[bot]"
# Re-authenticate git with GitHub token
SERVER_URL_STRIPPED="${SERVER_URL#https://}"
git remote set-url origin "https://x-access-token:${{ github.token }}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git"
echo "Git configured with standard GitHub Actions identity"
- name: Checkout PR branch
if: |
github.event.pull_request
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
env:
GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
with:
github-token: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
script: |
async function main() {
const eventName = context.eventName;
const pullRequest = context.payload.pull_request;
if (!pullRequest) {
core.info("No pull request context available, skipping checkout");
return;
}
core.info(`Event: ${eventName}`);
core.info(`Pull Request #${pullRequest.number}`);
try {
if (eventName === "pull_request") {
const branchName = pullRequest.head.ref;
core.info(`Checking out PR branch: ${branchName}`);
await exec.exec("git", ["fetch", "origin", branchName]);
await exec.exec("git", ["checkout", branchName]);
core.info(`✅ Successfully checked out branch: ${branchName}`);
} else {
const prNumber = pullRequest.number;
core.info(`Checking out PR #${prNumber} using gh pr checkout`);
await exec.exec("gh", ["pr", "checkout", prNumber.toString()]);
core.info(`✅ Successfully checked out PR #${prNumber}`);
}
} catch (error) {
core.setFailed(`Failed to checkout PR branch: ${error instanceof Error ? error.message : String(error)}`);
}
}
main().catch(error => {
core.setFailed(error instanceof Error ? error.message : String(error));
});
- name: Validate CLAUDE_CODE_OAUTH_TOKEN or ANTHROPIC_API_KEY secret
run: |
if [ -z "$CLAUDE_CODE_OAUTH_TOKEN" ] && [ -z "$ANTHROPIC_API_KEY" ]; then
{
echo "❌ Error: Neither CLAUDE_CODE_OAUTH_TOKEN nor ANTHROPIC_API_KEY secret is set"
echo "The Claude Code engine requires either CLAUDE_CODE_OAUTH_TOKEN or ANTHROPIC_API_KEY secret to be configured."
echo "Please configure one of these secrets in your repository settings."
echo "Documentation: https://githubnext.github.io/gh-aw/reference/engines/#anthropic-claude-code"
} >> "$GITHUB_STEP_SUMMARY"
echo "Error: Neither CLAUDE_CODE_OAUTH_TOKEN nor ANTHROPIC_API_KEY secret is set"
echo "The Claude Code engine requires either CLAUDE_CODE_OAUTH_TOKEN or ANTHROPIC_API_KEY secret to be configured."
echo "Please configure one of these secrets in your repository settings."
echo "Documentation: https://githubnext.github.io/gh-aw/reference/engines/#anthropic-claude-code"
exit 1
fi
# Log success in collapsible section
echo "<details>"
echo "<summary>Agent Environment Validation</summary>"
echo ""
if [ -n "$CLAUDE_CODE_OAUTH_TOKEN" ]; then
echo "✅ CLAUDE_CODE_OAUTH_TOKEN: Configured"
else
echo "✅ ANTHROPIC_API_KEY: Configured (using as fallback for CLAUDE_CODE_OAUTH_TOKEN)"
fi
echo "</details>"
env:
CLAUDE_CODE_OAUTH_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
- name: Setup Node.js
uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6
with:
node-version: '24'
package-manager-cache: false
- name: Install Claude Code CLI
run: npm install -g @anthropic-ai/claude-code@2.0.70
- name: Generate Claude Settings
run: |
mkdir -p /tmp/gh-aw/.claude
cat > /tmp/gh-aw/.claude/settings.json << 'EOF'
{
"hooks": {
"PreToolUse": [
{
"matcher": "WebFetch|WebSearch",
"hooks": [
{
"type": "command",
"command": ".claude/hooks/network_permissions.py"
}
]
}
]
}
}
EOF
- name: Generate Network Permissions Hook
run: |
mkdir -p .claude/hooks
cat > .claude/hooks/network_permissions.py << 'EOF'
#!/usr/bin/env python3
"""
Network permissions validator for Claude Code engine.
Generated by gh-aw from workflow-level network configuration.
"""
import json
import sys
import urllib.parse
import re
# Domain allow-list (populated during generation)
# JSON string is safely parsed using json.loads() to eliminate quoting vulnerabilities
ALLOWED_DOMAINS = json.loads('''["api.snapcraft.io","archive.ubuntu.com","azure.archive.ubuntu.com","crl.geotrust.com","crl.globalsign.com","crl.identrust.com","crl.sectigo.com","crl.thawte.com","crl.usertrust.com","crl.verisign.com","crl3.digicert.com","crl4.digicert.com","crls.ssl.com","json-schema.org","json.schemastore.org","keyserver.ubuntu.com","ocsp.digicert.com","ocsp.geotrust.com","ocsp.globalsign.com","ocsp.identrust.com","ocsp.sectigo.com","ocsp.ssl.com","ocsp.thawte.com","ocsp.usertrust.com","ocsp.verisign.com","packagecloud.io","packages.cloud.google.com","packages.microsoft.com","ppa.launchpad.net","s.symcb.com","s.symcd.com","security.ubuntu.com","ts-crl.ws.symantec.com","ts-ocsp.ws.symantec.com"]''')
def extract_domain(url_or_query):
"""Extract domain from URL or search query."""
if not url_or_query:
return None
if url_or_query.startswith(('http://', 'https://')):
return urllib.parse.urlparse(url_or_query).netloc.lower()
# Check for domain patterns in search queries
match = re.search(r'site:([a-zA-Z0-9.-]+\.[a-zA-Z]{2,})', url_or_query)
if match:
return match.group(1).lower()
return None
def is_domain_allowed(domain):
"""Check if domain is allowed."""
if not domain:
# If no domain detected, allow only if not under deny-all policy
return bool(ALLOWED_DOMAINS) # False if empty list (deny-all), True if has domains
# Empty allowed domains means deny all
if not ALLOWED_DOMAINS:
return False
for pattern in ALLOWED_DOMAINS:
regex = pattern.replace('.', r'\.').replace('*', '.*')
if re.match(f'^{regex}$', domain):
return True
return False
# Main logic
try:
data = json.load(sys.stdin)
tool_name = data.get('tool_name', '')
tool_input = data.get('tool_input', {})
if tool_name not in ['WebFetch', 'WebSearch']:
sys.exit(0) # Allow other tools
target = tool_input.get('url') or tool_input.get('query', '')
domain = extract_domain(target)
# For WebSearch, apply domain restrictions consistently
# If no domain detected in search query, check if restrictions are in place
if tool_name == 'WebSearch' and not domain:
# Since this hook is only generated when network permissions are configured,
# empty ALLOWED_DOMAINS means deny-all policy
if not ALLOWED_DOMAINS: # Empty list means deny all
print(f"Network access blocked: deny-all policy in effect", file=sys.stderr)
print(f"No domains are allowed for WebSearch", file=sys.stderr)
sys.exit(2) # Block under deny-all policy
else:
print(f"Network access blocked for web-search: no specific domain detected", file=sys.stderr)
print(f"Allowed domains: {', '.join(ALLOWED_DOMAINS)}", file=sys.stderr)
sys.exit(2) # Block general searches when domain allowlist is configured
if not is_domain_allowed(domain):
print(f"Network access blocked for domain: {domain}", file=sys.stderr)
print(f"Allowed domains: {', '.join(ALLOWED_DOMAINS)}", file=sys.stderr)
sys.exit(2) # Block with feedback to Claude
sys.exit(0) # Allow
except Exception as e:
print(f"Network validation error: {e}", file=sys.stderr)
sys.exit(2) # Block on errors
EOF
chmod +x .claude/hooks/network_permissions.py
- name: Downloading container images
run: |
set -e
docker pull ghcr.io/github/github-mcp-server:v0.25.0
- name: Write Safe Outputs Config
run: |
mkdir -p /tmp/gh-aw/safeoutputs
mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs
cat > /tmp/gh-aw/safeoutputs/config.json << 'EOF'
{"create_discussion":{"max":1},"missing_tool":{"max":0},"noop":{"max":1}}
EOF
cat > /tmp/gh-aw/safeoutputs/tools.json << 'EOF'
[
{
"description": "Create a GitHub discussion for announcements, Q\u0026A, reports, status updates, or community conversations. Use this for content that benefits from threaded replies, doesn't require task tracking, or serves as documentation. For actionable work items that need assignment and status tracking, use create_issue instead. CONSTRAINTS: Maximum 1 discussion(s) can be created. Discussions will be created in category \"dev\".",
"inputSchema": {
"additionalProperties": false,
"properties": {
"body": {
"description": "Discussion content in Markdown. Do NOT repeat the title as a heading since it already appears as the discussion's h1. Include all relevant context, findings, or questions.",
"type": "string"
},
"category": {
"description": "Discussion category by name (e.g., 'General'), slug (e.g., 'general'), or ID. If omitted, uses the first available category. Category must exist in the repository.",
"type": "string"
},
"title": {
"description": "Concise discussion title summarizing the topic. The title appears as the main heading, so keep it brief and descriptive.",
"type": "string"
}
},
"required": [
"title",
"body"
],
"type": "object"
},
"name": "create_discussion"
},
{
"description": "Report that a tool or capability needed to complete the task is not available. Use this when you cannot accomplish what was requested because the required functionality is missing or access is restricted.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"alternatives": {
"description": "Any workarounds, manual steps, or alternative approaches the user could take (max 256 characters).",
"type": "string"
},
"reason": {
"description": "Explanation of why this tool is needed to complete the task (max 256 characters).",
"type": "string"
},
"tool": {
"description": "Name or description of the missing tool or capability (max 128 characters). Be specific about what functionality is needed.",
"type": "string"
}
},
"required": [
"tool",
"reason"
],
"type": "object"
},
"name": "missing_tool"
},
{
"description": "Log a transparency message when no significant actions are needed. Use this to confirm workflow completion and provide visibility when analysis is complete but no changes or outputs are required (e.g., 'No issues found', 'All checks passed'). This ensures the workflow produces human-visible output even when no other actions are taken.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"message": {
"description": "Status or completion message to log. Should explain what was analyzed and the outcome (e.g., 'Code review complete - no issues found', 'Analysis complete - all tests passing').",
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"name": "noop"
}
]
EOF
cat > /tmp/gh-aw/safeoutputs/validation.json << 'EOF'
{
"create_discussion": {
"defaultMax": 1,
"fields": {
"body": {
"required": true,
"type": "string",
"sanitize": true,
"maxLength": 65000
},
"category": {
"type": "string",
"sanitize": true,
"maxLength": 128
},
"repo": {
"type": "string",
"maxLength": 256
},
"title": {
"required": true,
"type": "string",
"sanitize": true,
"maxLength": 128
}
}
},
"missing_tool": {
"defaultMax": 20,
"fields": {
"alternatives": {
"type": "string",
"sanitize": true,
"maxLength": 512
},
"reason": {
"required": true,
"type": "string",
"sanitize": true,
"maxLength": 256
},
"tool": {
"required": true,
"type": "string",
"sanitize": true,
"maxLength": 128
}
}
},
"noop": {
"defaultMax": 1,
"fields": {
"message": {
"required": true,
"type": "string",
"sanitize": true,
"maxLength": 65000
}
}
}
}
EOF
- name: Write Safe Outputs JavaScript Files
run: |
cat > /tmp/gh-aw/safeoutputs/estimate_tokens.cjs << 'EOF_ESTIMATE_TOKENS'
function estimateTokens(text) {
if (!text) return 0;
return Math.ceil(text.length / 4);
}
module.exports = {
estimateTokens,
};
EOF_ESTIMATE_TOKENS
cat > /tmp/gh-aw/safeoutputs/generate_compact_schema.cjs << 'EOF_GENERATE_COMPACT_SCHEMA'
function generateCompactSchema(content) {
try {
const parsed = JSON.parse(content);
if (Array.isArray(parsed)) {
if (parsed.length === 0) {
return "[]";
}
const firstItem = parsed[0];
if (typeof firstItem === "object" && firstItem !== null) {
const keys = Object.keys(firstItem);
return `[{${keys.join(", ")}}] (${parsed.length} items)`;
}
return `[${typeof firstItem}] (${parsed.length} items)`;
} else if (typeof parsed === "object" && parsed !== null) {
const keys = Object.keys(parsed);
if (keys.length > 10) {
return `{${keys.slice(0, 10).join(", ")}, ...} (${keys.length} keys)`;
}
return `{${keys.join(", ")}}`;
}
return `${typeof parsed}`;
} catch {
return "text content";
}
}
module.exports = {
generateCompactSchema,
};
EOF_GENERATE_COMPACT_SCHEMA
cat > /tmp/gh-aw/safeoutputs/generate_git_patch.cjs << 'EOF_GENERATE_GIT_PATCH'
const fs = require("fs");
const path = require("path");
const { execSync } = require("child_process");
const { getBaseBranch } = require("./get_base_branch.cjs");
function generateGitPatch(branchName) {
const patchPath = "/tmp/gh-aw/aw.patch";
const cwd = process.env.GITHUB_WORKSPACE || process.cwd();
const defaultBranch = process.env.DEFAULT_BRANCH || getBaseBranch();
const githubSha = process.env.GITHUB_SHA;
const patchDir = path.dirname(patchPath);
if (!fs.existsSync(patchDir)) {
fs.mkdirSync(patchDir, { recursive: true });
}
let patchGenerated = false;
let errorMessage = null;
try {
if (branchName) {
try {
execSync(`git show-ref --verify --quiet refs/heads/${branchName}`, { cwd, encoding: "utf8" });
let baseRef;
try {
execSync(`git show-ref --verify --quiet refs/remotes/origin/${branchName}`, { cwd, encoding: "utf8" });
baseRef = `origin/${branchName}`;
} catch {
execSync(`git fetch origin ${defaultBranch}`, { cwd, encoding: "utf8" });
baseRef = execSync(`git merge-base origin/${defaultBranch} ${branchName}`, { cwd, encoding: "utf8" }).trim();
}
const commitCount = parseInt(execSync(`git rev-list --count ${baseRef}..${branchName}`, { cwd, encoding: "utf8" }).trim(), 10);
if (commitCount > 0) {
const patchContent = execSync(`git format-patch ${baseRef}..${branchName} --stdout`, {
cwd,
encoding: "utf8",
});
if (patchContent && patchContent.trim()) {
fs.writeFileSync(patchPath, patchContent, "utf8");
patchGenerated = true;
}
}
} catch (branchError) {
}
}
if (!patchGenerated) {
const currentHead = execSync("git rev-parse HEAD", { cwd, encoding: "utf8" }).trim();
if (!githubSha) {
errorMessage = "GITHUB_SHA environment variable is not set";
} else if (currentHead === githubSha) {
} else {
try {
execSync(`git merge-base --is-ancestor ${githubSha} HEAD`, { cwd, encoding: "utf8" });
const commitCount = parseInt(execSync(`git rev-list --count ${githubSha}..HEAD`, { cwd, encoding: "utf8" }).trim(), 10);
if (commitCount > 0) {
const patchContent = execSync(`git format-patch ${githubSha}..HEAD --stdout`, {
cwd,
encoding: "utf8",
});
if (patchContent && patchContent.trim()) {
fs.writeFileSync(patchPath, patchContent, "utf8");
patchGenerated = true;
}
}
} catch {
}
}
}
} catch (error) {
errorMessage = `Failed to generate patch: ${error instanceof Error ? error.message : String(error)}`;
}
if (patchGenerated && fs.existsSync(patchPath)) {
const patchContent = fs.readFileSync(patchPath, "utf8");
const patchSize = Buffer.byteLength(patchContent, "utf8");
const patchLines = patchContent.split("\n").length;
if (!patchContent.trim()) {
return {
success: false,