[improve][ci] update pulsarbot to use github-script based implementation #24940

liangyepianzhou · 2025-11-04T08:01:52Z

Motivation

The ci-pulsarbot.yaml is slightly out-dated, update pulsarbot with github-script

Verifying this change

test in liangyepianzhou#19

Documentation

doc
doc-required
doc-not-needed
doc-complete

.github/workflows/ci-pulsarbot.yaml

(cherry picked from commit 678c92b)

.github/workflows/ci-pulsarbot.yaml

Co-authored-by: Lari Hotari <[email protected]>

lhotari

LGTM

lhotari · 2025-11-04T13:21:37Z

/pulsarbot rerun-failure-checks

lhotari · 2025-11-04T15:27:41Z

.github/workflows/ci-pulsarbot.yaml

+                  continue;
+                }
+                try {
+                  await github.rest.actions.reRunWorkflow({


According to LLM, this should use reRunWorkflowFailedJobs instead of reRunWorkflow to rerun only the failed jobs.

Suggested change

await github.rest.actions.reRunWorkflow({

await github.rest.actions.reRunWorkflowFailedJobs({

Octokit API reference: https://octokit.github.io/rest.js/v22/#actions-re-run-workflow-failed-jobs

Copilot

Pull Request Overview

This PR replaces the external apache/pulsar-test-infra/pulsarbot@master action with an inline implementation using actions/github-script@v7. The change provides direct control over the pulsarbot functionality for managing PR workflow runs.

Key changes:

Migrated from external action to inline JavaScript implementation
Implements commands: /pulsarbot rerun, /pulsarbot rerun <jobname>, /pulsarbot stop/cancel, and /pulsarbot rerun-failure-checks
Adds comprehensive logging and error handling for workflow/job management operations

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-04T15:29:09Z

.github/workflows/ci-pulsarbot.yaml

+            const arg = parts.length > 2 ? parts.slice(2).join(' ') : '';
+            const supported = ['rerun', 'stop', 'cancel', 'rerun-failure-checks'];
+            if (!supported.includes(sub)) {
+              console.log(`Unsupported command '${sub}'. Supported: '/pulsarbot rerun [jobName?]', '/pulsarbot stop', '/pulsarbot cancel'.`);


The error message lists supported commands but omits 'rerun-failure-checks' which is included in the supported array on line 62. The message should include all supported commands or reference them generically.

Suggested change

console.log(`Unsupported command '${sub}'. Supported: '/pulsarbot rerun [jobName?]', '/pulsarbot stop', '/pulsarbot cancel'.`);

console.log(`Unsupported command '${sub}'. Supported: ${supported.map(cmd => `'/pulsarbot ${cmd}'`).join(', ')}.`);

Copilot · 2025-11-04T15:29:10Z

.github/workflows/ci-pulsarbot.yaml

+                if (github.rest.actions.reRunJobForWorkflowRun) {
+                  await github.rest.actions.reRunJobForWorkflowRun({
+                    owner: context.repo.owner,
+                    repo: context.repo.repo,
+                    job_id: job.id
+                  });
+                } else {
+                  await github.request('POST /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun', {
+                    owner: context.repo.owner,
+                    repo: context.repo.repo,
+                    job_id: job.id
+                  });
+                }


The fallback logic checks if reRunJobForWorkflowRun exists at runtime, but this adds unnecessary complexity. The GitHub REST API for rerunning jobs should be consistently available in the @v7 version of actions/github-script. Consider using only the primary method or documenting why the fallback is necessary.

Suggested change

if (github.rest.actions.reRunJobForWorkflowRun) {

await github.rest.actions.reRunJobForWorkflowRun({

owner: context.repo.owner,

repo: context.repo.repo,

job_id: job.id

});

} else {

await github.request('POST /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun', {

owner: context.repo.owner,

repo: context.repo.repo,

job_id: job.id

});

}

await github.rest.actions.reRunJobForWorkflowRun({

owner: context.repo.owner,

repo: context.repo.repo,

job_id: job.id

});

lhotari · 2025-11-04T15:33:19Z

.github/workflows/ci-pulsarbot.yaml

+              if (fullRerunCount === 0) {
+                console.error(`No eligible workflow runs to re-run. Skipped running=${skippedRunning}, skipped by conclusion=${skippedConclusion}.`);
+              } else {
+                console.log(`Finished. Triggered full re-run for ${fullRerunCount} workflow run(s). Skipped running=${skippedRunning}, skipped by conclusion=${skippedConclusion}.`);


There is no intention to do a "full re-run". Please update this comment to be consistent with the intention about re-running failed jobs.

full re-run: https://docs.github.com/en/rest/actions/workflow-runs?apiVersion=2022-11-28#re-run-a-workflow / https://octokit.github.io/rest.js/v22/#actions-re-run-workflow
re-run failed jobs: https://docs.github.com/en/rest/actions/workflow-runs?apiVersion=2022-11-28#re-run-failed-jobs-from-a-workflow-run / https://octokit.github.io/rest.js/v22/#actions-re-run-workflow-failed-jobs

Check re-running of failed jobs only

lhotari · 2025-11-04T15:37:06Z

.github/workflows/ci-pulsarbot.yaml

-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        uses: apache/pulsar-test-infra/pulsarbot@master
+        uses: actions/github-script@v7


Use most recent version, v8:

Suggested change

uses: actions/github-script@v7

uses: actions/github-script@v8

lhotari · 2025-11-04T15:40:28Z

.github/workflows/ci-pulsarbot.yaml

+            let page = 1;
+            const allRunsRaw = [];
+            while (true) {
+              const { data } = await github.rest.actions.listWorkflowRunsForRepo({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                actor: prUser,
+                branch: prBranch,
+                per_page: 100,
+                page
+              });
+              const wr = data.workflow_runs || [];
+              if (wr.length === 0) break;
+              allRunsRaw.push(...wr);
+              if (wr.length < 100) break;
+              page++;
+            }


Octokit has built-in support for pagination and retrieving all results in a single call: https://github.com/octokit/octokit.js?tab=readme-ov-file#pagination (check the last example for the single call)

codecov-commenter · 2025-11-04T15:49:12Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.33%. Comparing base (fefe771) to head (d74f9cd).
⚠️ Report is 8 commits behind head on master.

Additional details and impacted files

@@              Coverage Diff              @@
##             master   #24940       +/-   ##
=============================================
+ Coverage     38.46%   74.33%   +35.86%     
- Complexity    13239    33535    +20296     
=============================================
  Files          1856     1913       +57     
  Lines        145283   149446     +4163     
  Branches      16876    17362      +486     
=============================================
+ Hits          55890   111088    +55198     
+ Misses        81827    29505    -52322     
- Partials       7566     8853     +1287

Flag	Coverage Δ
inttests	`26.38% <ø> (+0.12%)`	⬆️
systests	`22.73% <ø> (+<0.01%)`	⬆️
unittests	`73.85% <ø> (+39.15%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1417 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

liangyepianzhou · 2025-12-30T08:19:11Z

@lhotari The above comments had been fixed. do you have time take a look?
I have test it in liangyepianzhou#19 (comment)

lhotari · 2026-01-07T08:16:11Z

.github/workflows/ci-pulsarbot.yaml

-#
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements.  See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership.  The ASF licenses this file
-# to you under the Apache License, Version 2.0 (the
-# "License"); you may not use this file except in compliance
-# with the License.  You may obtain a copy of the License at
-#
-#   http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing,
-# software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied.  See the License for the
-# specific language governing permissions and limitations
-# under the License.
-#
-


Please don't remove the license header

lhotari · 2026-01-07T08:19:42Z

.github/workflows/ci-pulsarbot.yaml

+            async function listAllJobs(runId) {
+              const jobs = [];
+              let p = 1;
+              while (true) {
+                const { data } = await github.rest.actions.listJobsForWorkflowRun({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  run_id: runId,
+                  per_page: 100,
+                  page: p,
+                });
+                const js = data.jobs || [];
+                if (js.length === 0) break;
+                jobs.push(...js);
+                if (js.length < 100) break;
+                p++;
+              }


could we use github.paginate also in this case?

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-07T08:30:24Z

.github/workflows/ci-pulsarbot.yaml

+                per_page: 100,
+              },
+            );
+            console.log(`DEBUG runs for head_sha=${headSha}: total_count=${runsAtHeadRaw.total_count}, returned=${(runsAtHeadRaw.workflow_runs||[]).length}`);


The debug log references total_count property which does not exist on the paginated response. The github.paginate method returns an array of items directly, not an object with a total_count property. This will log undefined for the total_count value.

Suggested change

console.log(`DEBUG runs for head_sha=${headSha}: total_count=${runsAtHeadRaw.total_count}, returned=${(runsAtHeadRaw.workflow_runs||[]).length}`);

console.log(`DEBUG runs for head_sha=${headSha}: runs_returned=${runsAtHeadRaw.length}`);

Copilot · 2026-01-07T08:30:24Z

.github/workflows/ci-pulsarbot.yaml

+              },
+            );
+            console.log(`DEBUG runs for head_sha=${headSha}: total_count=${runsAtHeadRaw.total_count}, returned=${(runsAtHeadRaw.workflow_runs||[]).length}`);
+            const runsAtHead = runsAtHeadRaw.filter(r => r && typeof r === 'object');


The filter on line 84 is redundant. The github.paginate method already returns an array of workflow run objects. This filter checking if items are objects doesn't add value and could be removed for cleaner code.

Suggested change

const runsAtHead = runsAtHeadRaw.filter(r => r && typeof r === 'object');

const runsAtHead = runsAtHeadRaw;

Copilot · 2026-01-07T08:30:25Z

.github/workflows/ci-pulsarbot.yaml

+              const jobs = [];
+              let p = 1;
+              while (true) {
+                const { data } = await github.rest.actions.listJobsForWorkflowRun({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  run_id: runId,
+                  per_page: 100,
+                  page: p,
+                });
+                const js = data.jobs || [];
+                if (js.length === 0) break;
+                jobs.push(...js);
+                if (js.length < 100) break;
+                p++;
+              }


The manual pagination implementation for listing jobs is unnecessary. The github.paginate utility method can be used here instead, which would simplify the code and reduce the risk of pagination bugs.

Suggested change

const jobs = [];

let p = 1;

while (true) {

const { data } = await github.rest.actions.listJobsForWorkflowRun({

owner: context.repo.owner,

repo: context.repo.repo,

run_id: runId,

per_page: 100,

page: p,

});

const js = data.jobs || [];

if (js.length === 0) break;

jobs.push(...js);

if (js.length < 100) break;

p++;

}

const jobs = await github.paginate(

github.rest.actions.listJobsForWorkflowRun,

{

owner: context.repo.owner,

repo: context.repo.repo,

run_id: runId,

per_page: 100,

},

(response) => response.data.jobs || []

);

Copilot · 2026-01-07T08:30:25Z

.github/workflows/ci-pulsarbot.yaml

+              if (a.workflow_id !== b.workflow_id) return a.workflow_id - b.workflow_id;
+              return new Date(b.created_at) - new Date(a.created_at);


The sorting logic uses numeric subtraction for workflow_id comparison, but workflow_id values can be very large numbers that might exceed JavaScript's safe integer range. This could lead to incorrect sorting. Use a comparison that works reliably with large numbers.

Suggested change

if (a.workflow_id !== b.workflow_id) return a.workflow_id - b.workflow_id;

return new Date(b.created_at) - new Date(a.created_at);

const aw = String(a.workflow_id);

const bw = String(b.workflow_id);

if (aw !== bw) {

if (aw.length < bw.length) return -1;

if (aw.length > bw.length) return 1;

return aw < bw ? -1 : 1;

}

const at = new Date(a.created_at).getTime();

const bt = new Date(b.created_at).getTime();

if (bt > at) return 1;

if (bt < at) return -1;

return 0;

PulsarBot

161dd0a

liangyepianzhou requested a review from lhotari November 4, 2025 08:02

github-actions bot added the doc-required Your PR changes impact docs and you will update later. label Nov 4, 2025

lhotari reviewed Nov 4, 2025

View reviewed changes

.github/workflows/ci-pulsarbot.yaml Outdated Show resolved Hide resolved

lhotari reviewed Nov 4, 2025

View reviewed changes

.github/workflows/ci-pulsarbot.yaml Show resolved Hide resolved

xiangying added 2 commits November 4, 2025 17:08

fix

0158736

fix

b6b8e97

(cherry picked from commit 678c92b)

lhotari reviewed Nov 4, 2025

View reviewed changes

.github/workflows/ci-pulsarbot.yaml Outdated Show resolved Hide resolved

Update .github/workflows/ci-pulsarbot.yaml

d74f9cd

Co-authored-by: Lari Hotari <[email protected]>

lhotari previously approved these changes Nov 4, 2025

View reviewed changes

lhotari changed the title ~~[improve][ci] update pulsarbot with github-script~~ [improve][ci] update pulsarbot to use github-script based implementation Nov 4, 2025

lhotari reviewed Nov 4, 2025

View reviewed changes

lhotari requested a review from Copilot November 4, 2025 15:27

Copilot AI reviewed Nov 4, 2025

View reviewed changes

lhotari reviewed Nov 4, 2025

View reviewed changes

address comments

b923338

liangyepianzhou force-pushed the pulsarbot branch from 067d20c to b923338 Compare December 30, 2025 08:17

lhotari reviewed Jan 7, 2026

View reviewed changes

lhotari requested a review from Copilot January 7, 2026 08:21

Copilot started reviewing on behalf of lhotari January 7, 2026 08:27 View session

Copilot AI reviewed Jan 7, 2026

View reviewed changes

	await github.rest.actions.reRunWorkflow({
	await github.rest.actions.reRunWorkflowFailedJobs({

	console.log(`Unsupported command '${sub}'. Supported: '/pulsarbot rerun [jobName?]', '/pulsarbot stop', '/pulsarbot cancel'.`);
	console.log(`Unsupported command '${sub}'. Supported: ${supported.map(cmd => `'/pulsarbot ${cmd}'`).join(', ')}.`);

	uses: actions/github-script@v7
	uses: actions/github-script@v8

	console.log(`DEBUG runs for head_sha=${headSha}: total_count=${runsAtHeadRaw.total_count}, returned=${(runsAtHeadRaw.workflow_runs\|\|[]).length}`);
	console.log(`DEBUG runs for head_sha=${headSha}: runs_returned=${runsAtHeadRaw.length}`);

	const runsAtHead = runsAtHeadRaw.filter(r => r && typeof r === 'object');
	const runsAtHead = runsAtHeadRaw;

		if (a.workflow_id !== b.workflow_id) return a.workflow_id - b.workflow_id;
		return new Date(b.created_at) - new Date(a.created_at);

-              if (a.workflow_id !== b.workflow_id) return a.workflow_id - b.workflow_id;
-              return new Date(b.created_at) - new Date(a.created_at);
+              const aw = String(a.workflow_id);
+              const bw = String(b.workflow_id);
+              if (aw !== bw) {
+                if (aw.length < bw.length) return -1;
+                if (aw.length > bw.length) return 1;
+                return aw < bw ? -1 : 1;
+              }
+              const at = new Date(a.created_at).getTime();
+              const bt = new Date(b.created_at).getTime();
+              if (bt > at) return 1;
+              if (bt < at) return -1;
+              return 0;

[improve][ci] update pulsarbot to use github-script based implementation #24940

Are you sure you want to change the base?

[improve][ci] update pulsarbot to use github-script based implementation #24940

Conversation

liangyepianzhou commented Nov 4, 2025

Motivation

Verifying this change

Documentation

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lhotari left a comment

Choose a reason for hiding this comment

Uh oh!

lhotari commented Nov 4, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Nov 4, 2025

Codecov Report

Uh oh!

liangyepianzhou commented Dec 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

liangyepianzhou commented Dec 30, 2025 •

edited

Loading