-
Notifications
You must be signed in to change notification settings - Fork 139
8661 lines (8442 loc) · 412 KB
/
Copy pathdaily-workflow-sync.lock.yml
File metadata and controls
8661 lines (8442 loc) · 412 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
#
#
# Original Frontmatter:
# ```yaml
# on:
# schedule:
# - cron: "0 13 * * 1-5" # Daily at 1 PM UTC, weekdays only
# workflow_dispatch:
#
# permissions: read-all
#
# timeout-minutes: 30
#
# network:
# allowed:
# - node
# - raw.githubusercontent.com
#
# steps:
# - name: Checkout repository
# uses: actions/checkout@v4
# with:
# fetch-depth: 0
#
# - name: Install gh-aw extension
# run: gh extension install githubnext/gh-aw || gh extension upgrade githubnext/gh-aw
# env:
# GH_TOKEN: ${{ github.token }}
#
# tools:
# github:
# allowed:
# - search_pull_requests
# - pull_request_read
# - get_file_contents
# - list_commits
# edit:
# bash:
# - "*"
#
# safe-outputs:
# create-pull-request:
# title-prefix: "[auto-update] "
# labels: [automation]
# draft: false
# if-no-changes: "warn"
# push-to-pull-request-branch:
# title-prefix: "[auto-update]"
# if-no-changes: "warn"
# add-comment:
# max: 1
#
# engine: copilot
# ```
#
# Job Dependency Graph:
# ```mermaid
# graph LR
# activation["activation"]
# add_comment["add_comment"]
# agent["agent"]
# conclusion["conclusion"]
# create_pull_request["create_pull_request"]
# detection["detection"]
# push_to_pull_request_branch["push_to_pull_request_branch"]
# activation --> agent
# activation --> conclusion
# activation --> create_pull_request
# activation --> push_to_pull_request_branch
# add_comment --> conclusion
# agent --> add_comment
# agent --> conclusion
# agent --> create_pull_request
# agent --> detection
# agent --> push_to_pull_request_branch
# create_pull_request --> add_comment
# create_pull_request --> conclusion
# detection --> add_comment
# detection --> conclusion
# detection --> create_pull_request
# detection --> push_to_pull_request_branch
# push_to_pull_request_branch --> conclusion
# ```
#
# Original Prompt:
# ```markdown
# # Daily Workflow Sync from githubnext/gh-aw
#
# You are an automated workflow synchronization agent. Your job is to keep the workflows in this repository (`${{ github.repository }}`) in sync with the latest workflows from the `githubnext/gh-aw` repository.
#
# ## Your Mission
#
# Follow these steps carefully to synchronize workflows:
#
# ### 1. Check for existing pull request
#
# Search for an open pull request with title starting with `[auto-update]`:
# - Use the GitHub `search_pull_requests` tool with query: `repo:${{ github.repository }} is:pr is:open "[auto-update]" in:title`
# - If found, note the PR number for later use
# - This determines whether to use `create-pull-request` or `push-to-pull-request-branch`
#
# ### 2. Fetch workflows from githubnext/gh-aw
#
# Get the list of workflow files from the upstream repository:
# - Use GitHub tool to get contents of `githubnext/gh-aw` at path `.github/workflows/`
# - Filter for files ending in `.md` (these are agentic workflow source files)
# - Exclude any `.lock.yml` files (these are generated artifacts)
# - Also check for the `.github/workflows/shared/` directory and list any shared workflows
#
# ### 3. Compare with local workflows
#
# Check what's already in this repository:
# - Use bash to list files in `workflows/` directory: `ls -1 workflows/*.md 2>/dev/null || true`
# - Also list shared workflows: `ls -1 workflows/shared/*.md 2>/dev/null || true`
# - Compare the lists to identify:
# - New workflows that exist in gh-aw but not locally
# - Existing workflows that might need updates
#
# ### 4. Fetch and write workflow content
#
# For each workflow file you want to sync:
# - Use GitHub tool `get_file_contents` to fetch from `githubnext/gh-aw` repository
# - Path: `.github/workflows/<workflow-name>.md`
# - Parse the frontmatter to check for any `imports:` field
# - If imports are present, fetch those shared workflow files too from `.github/workflows/shared/`
# - **Use the `edit` tool** to write or update files:
# - For new files: use `create` functionality
# - For existing files: use `edit` to update the entire content
# - Save to `workflows/<workflow-name>.md` (note: local paths use `workflows/` not `.github/workflows/`)
# - For shared workflows: save to `workflows/shared/<workflow-name>.md`
#
# ### 5. Create or update the pull request
#
# Based on whether a PR exists:
#
# **If no existing PR was found:**
# - Use the `output.create-pull-request` safe output
# - Provide:
# - **title**: "Sync workflows from gh-aw"
# - **body**: A description of what workflows were added/updated, with links to githubnext/gh-aw
# - Note that lock files are excluded and will be generated on merge
# - The built-in safe output will automatically create the PR with your file changes
#
# **If an existing PR was found:**
# - Use the `output.push-to-pull-request-branch` safe output
# - This will push your file changes to the existing PR branch
# - Then use `output.add-comment` to add a comment like: "🔄 Updated with latest changes from githubnext/gh-aw"
#
# ## Important Guidelines
#
# - **Use the `edit` tool for all file changes** - don't try to write files manually
# - **DO NOT include .lock.yml files** - only sync .md source files
# - Focus on workflow source files (`.md` files only)
# - When fetching workflows, get them from `githubnext/gh-aw` repository's `.github/workflows/` directory
# - When saving locally, save to `workflows/` directory (without the `.github/` prefix)
# - Be selective - only sync workflows that are relevant for this repo
# - Include shared workflow dependencies when needed
#
# ## Example Workflow Selection
#
# Consider syncing workflows like:
# - General-purpose automation workflows (triage, maintenance, etc.)
# - Example workflows that demonstrate gh-aw features
# - Shared workflow components that others might import
#
# Skip workflows that are:
# - Specific to the gh-aw repository itself
# - For internal testing only
# - Not applicable to general users
#
# ## Error Handling
#
# - If a workflow fails to fetch, log it and continue with others
# - If no workflows need syncing, that's success - just report it
# - Let the safe outputs handle PR creation/update errors
#
# ## Context
#
# - Current repository: `${{ github.repository }}`
# - Date: Run at 1 PM UTC on weekdays
# ```
#
# 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/upload-artifact@v5 (330a01c490aca151604b8cf639adc76d48f6c5d4)
# https://github.com/actions/upload-artifact/commit/330a01c490aca151604b8cf639adc76d48f6c5d4
name: "Daily Workflow Sync from githubnext/gh-aw"
"on":
schedule:
- cron: "0 13 * * 1-5"
workflow_dispatch: null
permissions: {}
concurrency:
group: "gh-aw-${{ github.workflow }}"
run-name: "Daily Workflow Sync from githubnext/gh-aw"
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: "daily-workflow-sync.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));
});
add_comment:
needs:
- agent
- create_pull_request
- detection
if: >
((((!cancelled()) && (needs.agent.result != 'skipped')) && (contains(needs.agent.outputs.output_types, 'add_comment'))) &&
(((github.event.issue.number) || (github.event.pull_request.number)) || (github.event.discussion.number))) &&
(needs.detection.outputs.success == 'true')
runs-on: ubuntu-slim
permissions:
contents: read
discussions: write
issues: write
pull-requests: write
timeout-minutes: 10
outputs:
comment_id: ${{ steps.add_comment.outputs.comment_id }}
comment_url: ${{ steps.add_comment.outputs.comment_url }}
steps:
- name: Debug agent outputs
env:
AGENT_OUTPUT: ${{ needs.agent.outputs.output }}
AGENT_OUTPUT_TYPES: ${{ needs.agent.outputs.output_types }}
run: |
echo "Output: $AGENT_OUTPUT"
echo "Output types: $AGENT_OUTPUT_TYPES"
- name: Download agent output artifact
continue-on-error: true
uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6
with:
name: agent_output.json
path: /tmp/gh-aw/safeoutputs/
- name: Setup agent output environment variable
run: |
mkdir -p /tmp/gh-aw/safeoutputs/
find "/tmp/gh-aw/safeoutputs/" -type f -print
echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/safeoutputs/agent_output.json" >> "$GITHUB_ENV"
- name: Add Issue Comment
id: add_comment
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
env:
GH_AW_AGENT_OUTPUT: ${{ env.GH_AW_AGENT_OUTPUT }}
GH_AW_CREATED_PULL_REQUEST_URL: ${{ needs.create_pull_request.outputs.pull_request_url }}
GH_AW_CREATED_PULL_REQUEST_NUMBER: ${{ needs.create_pull_request.outputs.pull_request_number }}
GH_AW_WORKFLOW_NAME: "Daily Workflow Sync from githubnext/gh-aw"
GH_AW_ENGINE_ID: "copilot"
with:
github-token: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
script: |
const fs = require("fs");
const crypto = require("crypto");
const MAX_LOG_CONTENT_LENGTH = 10000;
function truncateForLogging(content) {
if (content.length <= MAX_LOG_CONTENT_LENGTH) {
return content;
}
return content.substring(0, MAX_LOG_CONTENT_LENGTH) + `\n... (truncated, total length: ${content.length})`;
}
function loadAgentOutput() {
const agentOutputFile = process.env.GH_AW_AGENT_OUTPUT;
if (!agentOutputFile) {
core.info("No GH_AW_AGENT_OUTPUT environment variable found");
return { success: false };
}
let outputContent;
try {
outputContent = fs.readFileSync(agentOutputFile, "utf8");
} catch (error) {
const errorMessage = `Error reading agent output file: ${error instanceof Error ? error.message : String(error)}`;
core.error(errorMessage);
return { success: false, error: errorMessage };
}
if (outputContent.trim() === "") {
core.info("Agent output content is empty");
return { success: false };
}
core.info(`Agent output content length: ${outputContent.length}`);
let validatedOutput;
try {
validatedOutput = JSON.parse(outputContent);
} catch (error) {
const errorMessage = `Error parsing agent output JSON: ${error instanceof Error ? error.message : String(error)}`;
core.error(errorMessage);
core.info(`Failed to parse content:\n${truncateForLogging(outputContent)}`);
return { success: false, error: errorMessage };
}
if (!validatedOutput.items || !Array.isArray(validatedOutput.items)) {
core.info("No valid items found in agent output");
core.info(`Parsed content: ${truncateForLogging(JSON.stringify(validatedOutput))}`);
return { success: false };
}
return { success: true, items: validatedOutput.items };
}
function getMessages() {
const messagesEnv = process.env.GH_AW_SAFE_OUTPUT_MESSAGES;
if (!messagesEnv) {
return null;
}
try {
return JSON.parse(messagesEnv);
} catch (error) {
core.warning(`Failed to parse GH_AW_SAFE_OUTPUT_MESSAGES: ${error instanceof Error ? error.message : String(error)}`);
return null;
}
}
function renderTemplate(template, context) {
return template.replace(/\{(\w+)\}/g, (match, key) => {
const value = context[key];
return value !== undefined && value !== null ? String(value) : match;
});
}
function toSnakeCase(obj) {
const result = {};
for (const [key, value] of Object.entries(obj)) {
const snakeKey = key.replace(/([A-Z])/g, "_$1").toLowerCase();
result[snakeKey] = value;
result[key] = value;
}
return result;
}
function getFooterMessage(ctx) {
const messages = getMessages();
const templateContext = toSnakeCase(ctx);
const defaultFooter = "> Ahoy! This treasure was crafted by [🏴☠️ {workflow_name}]({run_url})";
let footer = messages?.footer ? renderTemplate(messages.footer, templateContext) : renderTemplate(defaultFooter, templateContext);
if (ctx.triggeringNumber) {
footer += ` fer issue #{triggering_number} 🗺️`.replace("{triggering_number}", String(ctx.triggeringNumber));
}
return footer;
}
function getFooterInstallMessage(ctx) {
if (!ctx.workflowSource || !ctx.workflowSourceUrl) {
return "";
}
const messages = getMessages();
const templateContext = toSnakeCase(ctx);
const defaultInstall =
"> Arr! To plunder this workflow fer yer own ship, run `gh aw add {workflow_source}`. Chart yer course at [🦜 {workflow_source_url}]({workflow_source_url})!";
return messages?.footerInstall
? renderTemplate(messages.footerInstall, templateContext)
: renderTemplate(defaultInstall, templateContext);
}
function generateXMLMarker(workflowName, runUrl) {
const engineId = process.env.GH_AW_ENGINE_ID || "";
const engineVersion = process.env.GH_AW_ENGINE_VERSION || "";
const engineModel = process.env.GH_AW_ENGINE_MODEL || "";
const trackerId = process.env.GH_AW_TRACKER_ID || "";
const parts = [];
parts.push(`agentic-workflow: ${workflowName}`);
if (trackerId) {
parts.push(`tracker-id: ${trackerId}`);
}
if (engineId) {
parts.push(`engine: ${engineId}`);
}
if (engineVersion) {
parts.push(`version: ${engineVersion}`);
}
if (engineModel) {
parts.push(`model: ${engineModel}`);
}
parts.push(`run: ${runUrl}`);
return `<!-- ${parts.join(", ")} -->`;
}
function generateFooterWithMessages(
workflowName,
runUrl,
workflowSource,
workflowSourceURL,
triggeringIssueNumber,
triggeringPRNumber,
triggeringDiscussionNumber
) {
let triggeringNumber;
if (triggeringIssueNumber) {
triggeringNumber = triggeringIssueNumber;
} else if (triggeringPRNumber) {
triggeringNumber = triggeringPRNumber;
} else if (triggeringDiscussionNumber) {
triggeringNumber = `discussion #${triggeringDiscussionNumber}`;
}
const ctx = {
workflowName,
runUrl,
workflowSource,
workflowSourceUrl: workflowSourceURL,
triggeringNumber,
};
let footer = "\n\n" + getFooterMessage(ctx);
const installMessage = getFooterInstallMessage(ctx);
if (installMessage) {
footer += "\n>\n" + installMessage;
}
footer += "\n\n" + generateXMLMarker(workflowName, runUrl);
footer += "\n";
return footer;
}
function getRepositoryUrl() {
const targetRepoSlug = process.env.GH_AW_TARGET_REPO_SLUG;
if (targetRepoSlug) {
const githubServer = process.env.GITHUB_SERVER_URL || "https://github.com";
return `${githubServer}/${targetRepoSlug}`;
} else if (context.payload.repository?.html_url) {
return context.payload.repository.html_url;
} else {
const githubServer = process.env.GITHUB_SERVER_URL || "https://github.com";
return `${githubServer}/${context.repo.owner}/${context.repo.repo}`;
}
}
const TEMPORARY_ID_PATTERN = /#(aw_[0-9a-f]{12})/gi;
function generateTemporaryId() {
return "aw_" + crypto.randomBytes(6).toString("hex");
}
function isTemporaryId(value) {
if (typeof value === "string") {
return /^aw_[0-9a-f]{12}$/i.test(value);
}
return false;
}
function normalizeTemporaryId(tempId) {
return String(tempId).toLowerCase();
}
function replaceTemporaryIdReferences(text, tempIdMap, currentRepo) {
return text.replace(TEMPORARY_ID_PATTERN, (match, tempId) => {
const resolved = tempIdMap.get(normalizeTemporaryId(tempId));
if (resolved !== undefined) {
if (currentRepo && resolved.repo === currentRepo) {
return `#${resolved.number}`;
}
return `${resolved.repo}#${resolved.number}`;
}
return match;
});
}
function replaceTemporaryIdReferencesLegacy(text, tempIdMap) {
return text.replace(TEMPORARY_ID_PATTERN, (match, tempId) => {
const issueNumber = tempIdMap.get(normalizeTemporaryId(tempId));
if (issueNumber !== undefined) {
return `#${issueNumber}`;
}
return match;
});
}
function loadTemporaryIdMap() {
const mapJson = process.env.GH_AW_TEMPORARY_ID_MAP;
if (!mapJson || mapJson === "{}") {
return new Map();
}
try {
const mapObject = JSON.parse(mapJson);
const result = new Map();
for (const [key, value] of Object.entries(mapObject)) {
const normalizedKey = normalizeTemporaryId(key);
if (typeof value === "number") {
const contextRepo = `${context.repo.owner}/${context.repo.repo}`;
result.set(normalizedKey, { repo: contextRepo, number: value });
} else if (typeof value === "object" && value !== null && "repo" in value && "number" in value) {
result.set(normalizedKey, { repo: String(value.repo), number: Number(value.number) });
}
}
return result;
} catch (error) {
if (typeof core !== "undefined") {
core.warning(`Failed to parse temporary ID map: ${error instanceof Error ? error.message : String(error)}`);
}
return new Map();
}
}
function resolveIssueNumber(value, temporaryIdMap) {
if (value === undefined || value === null) {
return { resolved: null, wasTemporaryId: false, errorMessage: "Issue number is missing" };
}
const valueStr = String(value);
if (isTemporaryId(valueStr)) {
const resolvedPair = temporaryIdMap.get(normalizeTemporaryId(valueStr));
if (resolvedPair !== undefined) {
return { resolved: resolvedPair, wasTemporaryId: true, errorMessage: null };
}
return {
resolved: null,
wasTemporaryId: true,
errorMessage: `Temporary ID '${valueStr}' not found in map. Ensure the issue was created before linking.`,
};
}
const issueNumber = typeof value === "number" ? value : parseInt(valueStr, 10);
if (isNaN(issueNumber) || issueNumber <= 0) {
return { resolved: null, wasTemporaryId: false, errorMessage: `Invalid issue number: ${value}` };
}
const contextRepo = typeof context !== "undefined" ? `${context.repo.owner}/${context.repo.repo}` : "";
return { resolved: { repo: contextRepo, number: issueNumber }, wasTemporaryId: false, errorMessage: null };
}
function serializeTemporaryIdMap(tempIdMap) {
const obj = Object.fromEntries(tempIdMap);
return JSON.stringify(obj);
}
function getTrackerID(format) {
const trackerID = process.env.GH_AW_TRACKER_ID || "";
if (trackerID) {
core.info(`Tracker ID: ${trackerID}`);
return format === "markdown" ? `\n\n<!-- tracker-id: ${trackerID} -->` : trackerID;
}
return "";
}
async function minimizeComment(github, nodeId, reason = "outdated") {
const query = `
mutation ($nodeId: ID!, $classifier: ReportedContentClassifiers!) {
minimizeComment(input: { subjectId: $nodeId, classifier: $classifier }) {
minimizedComment {
isMinimized
}
}
}
`;
const result = await github.graphql(query, { nodeId, classifier: reason });
return {
id: nodeId,
isMinimized: result.minimizeComment.minimizedComment.isMinimized,
};
}
async function findCommentsWithTrackerId(github, owner, repo, issueNumber, workflowId) {
const comments = [];
let page = 1;
const perPage = 100;
while (true) {
const { data } = await github.rest.issues.listComments({
owner,
repo,
issue_number: issueNumber,
per_page: perPage,
page,
});
if (data.length === 0) {
break;
}
for (const comment of data) {
if (comment.body && comment.body.includes(`<!-- workflow-id: ${workflowId} -->`)) {
if (comment.body.includes(`<!-- comment-type: reaction -->`)) {
continue;
}
comments.push({
id: comment.id,
node_id: comment.node_id,
body: comment.body,
});
}
}
if (data.length < perPage) {
break;
}
page++;
}
return comments;
}
async function findDiscussionCommentsWithTrackerId(github, owner, repo, discussionNumber, workflowId) {
const query = `
query ($owner: String!, $repo: String!, $num: Int!, $cursor: String) {
repository(owner: $owner, name: $repo) {
discussion(number: $num) {
comments(first: 100, after: $cursor) {
nodes {
id
body
}
pageInfo {
hasNextPage
endCursor
}
}
}
}
}
`;
const comments = [];
let cursor = null;
while (true) {
const result = await github.graphql(query, { owner, repo, num: discussionNumber, cursor });
if (!result.repository?.discussion?.comments?.nodes) {
break;
}
const nodes = result.repository.discussion.comments.nodes;
for (const comment of nodes) {
if (comment.body && comment.body.includes(`<!-- workflow-id: ${workflowId} -->`)) {
if (comment.body.includes(`<!-- comment-type: reaction -->`)) {
continue;
}
comments.push({
id: comment.id,
body: comment.body,
});
}
}
if (!result.repository.discussion.comments.pageInfo.hasNextPage) {
break;
}
cursor = result.repository.discussion.comments.pageInfo.endCursor;
}
return comments;
}
async function hideOlderComments(github, owner, repo, itemNumber, workflowId, isDiscussion, reason = "outdated", allowedReasons = null) {
if (!workflowId) {
core.info("No workflow ID available, skipping hide-older-comments");
return 0;
}
const normalizedReason = reason.toUpperCase();
if (allowedReasons && allowedReasons.length > 0) {
const normalizedAllowedReasons = allowedReasons.map(r => r.toUpperCase());
if (!normalizedAllowedReasons.includes(normalizedReason)) {
core.warning(`Reason "${reason}" is not in allowed-reasons list [${allowedReasons.join(", ")}]. Skipping hide-older-comments.`);
return 0;
}
}
core.info(`Searching for previous comments with workflow ID: ${workflowId}`);
let comments;
if (isDiscussion) {
comments = await findDiscussionCommentsWithTrackerId(github, owner, repo, itemNumber, workflowId);
} else {
comments = await findCommentsWithTrackerId(github, owner, repo, itemNumber, workflowId);
}
if (comments.length === 0) {
core.info("No previous comments found with matching workflow ID");
return 0;
}
core.info(`Found ${comments.length} previous comment(s) to hide with reason: ${normalizedReason}`);
let hiddenCount = 0;
for (const comment of comments) {
try {
const nodeId = isDiscussion ? String(comment.id) : comment.node_id;
core.info(`Hiding comment: ${nodeId}`);
await minimizeComment(github, nodeId, normalizedReason);
hiddenCount++;
core.info(`✓ Hidden comment: ${nodeId}`);
} catch (error) {
core.warning(`Failed to hide comment: ${error instanceof Error ? error.message : String(error)}`);
}
}
core.info(`Successfully hidden ${hiddenCount} comment(s)`);
return hiddenCount;
}
async function commentOnDiscussion(github, owner, repo, discussionNumber, message, replyToId) {
const { repository } = await github.graphql(
`
query($owner: String!, $repo: String!, $num: Int!) {
repository(owner: $owner, name: $repo) {
discussion(number: $num) {
id
url
}
}
}`,
{ owner, repo, num: discussionNumber }
);
if (!repository || !repository.discussion) {
throw new Error(`Discussion #${discussionNumber} not found in ${owner}/${repo}`);
}
const discussionId = repository.discussion.id;
const discussionUrl = repository.discussion.url;
let result;
if (replyToId) {
result = await github.graphql(
`
mutation($dId: ID!, $body: String!, $replyToId: ID!) {
addDiscussionComment(input: { discussionId: $dId, body: $body, replyToId: $replyToId }) {
comment {
id
body
createdAt
url
}
}
}`,
{ dId: discussionId, body: message, replyToId }
);
} else {
result = await github.graphql(
`
mutation($dId: ID!, $body: String!) {
addDiscussionComment(input: { discussionId: $dId, body: $body }) {
comment {
id
body
createdAt
url
}
}
}`,
{ dId: discussionId, body: message }
);
}
const comment = result.addDiscussionComment.comment;
return {
id: comment.id,
html_url: comment.url,
discussion_url: discussionUrl,
};
}
async function main() {
const isStaged = process.env.GH_AW_SAFE_OUTPUTS_STAGED === "true";
const isDiscussionExplicit = process.env.GITHUB_AW_COMMENT_DISCUSSION === "true";
const hideOlderCommentsEnabled = process.env.GH_AW_HIDE_OLDER_COMMENTS === "true";
const temporaryIdMap = loadTemporaryIdMap();
if (temporaryIdMap.size > 0) {
core.info(`Loaded temporary ID map with ${temporaryIdMap.size} entries`);
}
const result = loadAgentOutput();
if (!result.success) {
return;
}
const commentItems = result.items.filter( item => item.type === "add_comment");
if (commentItems.length === 0) {
core.info("No add-comment items found in agent output");
return;
}
core.info(`Found ${commentItems.length} add-comment item(s)`);
function getTargetNumber(item) {
return item.item_number;
}
const commentTarget = process.env.GH_AW_COMMENT_TARGET || "triggering";
core.info(`Comment target configuration: ${commentTarget}`);
const isIssueContext = context.eventName === "issues" || context.eventName === "issue_comment";
const isPRContext =
context.eventName === "pull_request" ||
context.eventName === "pull_request_review" ||
context.eventName === "pull_request_review_comment";
const isDiscussionContext = context.eventName === "discussion" || context.eventName === "discussion_comment";
const isDiscussion = isDiscussionContext || isDiscussionExplicit;
const workflowId = process.env.GITHUB_WORKFLOW || "";
let allowedReasons = null;
if (process.env.GH_AW_ALLOWED_REASONS) {
try {
allowedReasons = JSON.parse(process.env.GH_AW_ALLOWED_REASONS);
core.info(`Allowed reasons for hiding: [${allowedReasons.join(", ")}]`);
} catch (error) {
core.warning(`Failed to parse GH_AW_ALLOWED_REASONS: ${error instanceof Error ? error.message : String(error)}`);
}
}
if (hideOlderCommentsEnabled) {
core.info(`Hide-older-comments is enabled with workflow ID: ${workflowId || "(none)"}`);
}
if (isStaged) {
let summaryContent = "## 🎭 Staged Mode: Add Comments Preview\n\n";
summaryContent += "The following comments would be added if staged mode was disabled:\n\n";
const createdIssueUrl = process.env.GH_AW_CREATED_ISSUE_URL;
const createdIssueNumber = process.env.GH_AW_CREATED_ISSUE_NUMBER;
const createdDiscussionUrl = process.env.GH_AW_CREATED_DISCUSSION_URL;
const createdDiscussionNumber = process.env.GH_AW_CREATED_DISCUSSION_NUMBER;
const createdPullRequestUrl = process.env.GH_AW_CREATED_PULL_REQUEST_URL;
const createdPullRequestNumber = process.env.GH_AW_CREATED_PULL_REQUEST_NUMBER;
if (createdIssueUrl || createdDiscussionUrl || createdPullRequestUrl) {
summaryContent += "#### Related Items\n\n";
if (createdIssueUrl && createdIssueNumber) {
summaryContent += `- Issue: [#${createdIssueNumber}](${createdIssueUrl})\n`;
}
if (createdDiscussionUrl && createdDiscussionNumber) {
summaryContent += `- Discussion: [#${createdDiscussionNumber}](${createdDiscussionUrl})\n`;
}
if (createdPullRequestUrl && createdPullRequestNumber) {
summaryContent += `- Pull Request: [#${createdPullRequestNumber}](${createdPullRequestUrl})\n`;
}
summaryContent += "\n";
}
for (let i = 0; i < commentItems.length; i++) {
const item = commentItems[i];
summaryContent += `### Comment ${i + 1}\n`;
const targetNumber = getTargetNumber(item);
if (targetNumber) {
const repoUrl = getRepositoryUrl();
if (isDiscussion) {
const discussionUrl = `${repoUrl}/discussions/${targetNumber}`;
summaryContent += `**Target Discussion:** [#${targetNumber}](${discussionUrl})\n\n`;
} else {
const issueUrl = `${repoUrl}/issues/${targetNumber}`;
summaryContent += `**Target Issue:** [#${targetNumber}](${issueUrl})\n\n`;
}
} else {
if (isDiscussion) {
summaryContent += `**Target:** Current discussion\n\n`;
} else {
summaryContent += `**Target:** Current issue/PR\n\n`;
}
}
summaryContent += `**Body:**\n${item.body || "No content provided"}\n\n`;
summaryContent += "---\n\n";
}
await core.summary.addRaw(summaryContent).write();
core.info("📝 Comment creation preview written to step summary");
return;
}
if (commentTarget === "triggering" && !isIssueContext && !isPRContext && !isDiscussionContext) {
core.info('Target is "triggering" but not running in issue, pull request, or discussion context, skipping comment creation');
return;
}
const triggeringIssueNumber =
context.payload?.issue?.number && !context.payload?.issue?.pull_request ? context.payload.issue.number : undefined;
const triggeringPRNumber =
context.payload?.pull_request?.number || (context.payload?.issue?.pull_request ? context.payload.issue.number : undefined);
const triggeringDiscussionNumber = context.payload?.discussion?.number;
const createdComments = [];
for (let i = 0; i < commentItems.length; i++) {
const commentItem = commentItems[i];
core.info(`Processing add-comment item ${i + 1}/${commentItems.length}: bodyLength=${commentItem.body.length}`);
let itemNumber;
let commentEndpoint;
if (commentTarget === "*") {
const targetNumber = getTargetNumber(commentItem);
if (targetNumber) {
itemNumber = parseInt(targetNumber, 10);
if (isNaN(itemNumber) || itemNumber <= 0) {
core.info(`Invalid target number specified: ${targetNumber}`);
continue;
}
commentEndpoint = isDiscussion ? "discussions" : "issues";
} else {
core.info(`Target is "*" but no number specified in comment item`);
continue;
}
} else if (commentTarget && commentTarget !== "triggering") {
itemNumber = parseInt(commentTarget, 10);
if (isNaN(itemNumber) || itemNumber <= 0) {
core.info(`Invalid target number in target configuration: ${commentTarget}`);
continue;
}
commentEndpoint = isDiscussion ? "discussions" : "issues";
} else {
if (isIssueContext) {
itemNumber = context.payload.issue?.number || context.payload.pull_request?.number || context.payload.discussion?.number;
if (context.payload.issue) {
commentEndpoint = "issues";
} else {
core.info("Issue context detected but no issue found in payload");
continue;
}
} else if (isPRContext) {
itemNumber = context.payload.pull_request?.number || context.payload.issue?.number || context.payload.discussion?.number;
if (context.payload.pull_request) {
commentEndpoint = "issues";
} else {
core.info("Pull request context detected but no pull request found in payload");
continue;
}
} else if (isDiscussionContext) {
itemNumber = context.payload.discussion?.number || context.payload.issue?.number || context.payload.pull_request?.number;
if (context.payload.discussion) {
commentEndpoint = "discussions";
} else {
core.info("Discussion context detected but no discussion found in payload");
continue;
}
}
}
if (!itemNumber) {
core.info("Could not determine issue, pull request, or discussion number");
continue;
}
let body = replaceTemporaryIdReferences(commentItem.body.trim(), temporaryIdMap);
const createdIssueUrl = process.env.GH_AW_CREATED_ISSUE_URL;
const createdIssueNumber = process.env.GH_AW_CREATED_ISSUE_NUMBER;
const createdDiscussionUrl = process.env.GH_AW_CREATED_DISCUSSION_URL;
const createdDiscussionNumber = process.env.GH_AW_CREATED_DISCUSSION_NUMBER;
const createdPullRequestUrl = process.env.GH_AW_CREATED_PULL_REQUEST_URL;
const createdPullRequestNumber = process.env.GH_AW_CREATED_PULL_REQUEST_NUMBER;
let hasReferences = false;
let referencesSection = "\n\n#### Related Items\n\n";
if (createdIssueUrl && createdIssueNumber) {
referencesSection += `- Issue: [#${createdIssueNumber}](${createdIssueUrl})\n`;
hasReferences = true;
}
if (createdDiscussionUrl && createdDiscussionNumber) {
referencesSection += `- Discussion: [#${createdDiscussionNumber}](${createdDiscussionUrl})\n`;
hasReferences = true;
}
if (createdPullRequestUrl && createdPullRequestNumber) {
referencesSection += `- Pull Request: [#${createdPullRequestNumber}](${createdPullRequestUrl})\n`;
hasReferences = true;
}
if (hasReferences) {
body += referencesSection;
}