fix(github): skip PR previews from head commit flags

This commit is contained in:
Andras Bacsai 2026-07-08 13:31:23 +02:00
parent 18f0f7f6be
commit f4f4274cee
3 changed files with 82 additions and 4 deletions

View file

@ -96,7 +96,16 @@ private function handleOpenAction(Application $application, ?GithubApp $githubAp
return; return;
} }
if (self::shouldSkipDeployAny([$this->pullRequestTitle])) { $repository_parts = explode('/', $this->fullName);
$owner = $repository_parts[0] ?? '';
$repo = $repository_parts[1] ?? '';
$headCommitMessage = null;
if ($this->action === 'synchronize') {
$headCommitMessage = getGithubCommitMessage($githubApp, $owner, $repo, $this->commitSha);
}
if (self::shouldSkipDeployAny([$this->pullRequestTitle, $headCommitMessage])) {
return; return;
} }
@ -120,9 +129,6 @@ private function handleOpenAction(Application $application, ?GithubApp $githubAp
// Get changed files for watch path filtering // Get changed files for watch path filtering
$changed_files = collect(); $changed_files = collect();
$repository_parts = explode('/', $this->fullName);
$owner = $repository_parts[0] ?? '';
$repo = $repository_parts[1] ?? '';
if ($this->action === 'synchronize' && $this->beforeSha && $this->afterSha) { if ($this->action === 'synchronize' && $this->beforeSha && $this->afterSha) {
// For synchronize events, get files changed between before and after commits // For synchronize events, get files changed between before and after commits

View file

@ -414,6 +414,28 @@ function getGithubCommitRangeFiles(?GithubApp $source, string $owner, string $re
} }
} }
function getGithubCommitMessage(?GithubApp $source, string $owner, string $repo, string $commitSha): ?string
{
try {
if (! $source) {
return null;
}
if (blank($owner) || blank($repo) || blank($commitSha) || $commitSha === 'HEAD') {
return null;
}
$endpoint = "/repos/{$owner}/{$repo}/commits/{$commitSha}";
$response = githubApi($source, $endpoint, 'get', null, false);
$message = data_get($response, 'data.commit.message');
return is_string($message) ? $message : null;
} catch (Exception $e) {
return null;
}
}
function getGithubPullRequestFiles(?GithubApp $source, string $owner, string $repo, int $pullRequestId): array function getGithubPullRequestFiles(?GithubApp $source, string $owner, string $repo, int $pullRequestId): array
{ {
try { try {

View file

@ -3,14 +3,19 @@
use App\Actions\Application\CleanupPreviewDeployment; use App\Actions\Application\CleanupPreviewDeployment;
use App\Jobs\ProcessGithubPullRequestWebhook; use App\Jobs\ProcessGithubPullRequestWebhook;
use App\Models\Application; use App\Models\Application;
use App\Models\ApplicationDeploymentQueue;
use App\Models\ApplicationPreview; use App\Models\ApplicationPreview;
use App\Models\Environment; use App\Models\Environment;
use App\Models\GithubApp;
use App\Models\InstanceSettings; use App\Models\InstanceSettings;
use App\Models\Project; use App\Models\Project;
use App\Models\Server; use App\Models\Server;
use App\Models\StandaloneDocker; use App\Models\StandaloneDocker;
use App\Models\Team; use App\Models\Team;
use Illuminate\Foundation\Testing\RefreshDatabase; use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Http\Client\Request;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Queue;
uses(RefreshDatabase::class); uses(RefreshDatabase::class);
@ -58,3 +63,48 @@ protected function dispatchPullRequestClosedUpdate(Application $application, App
$job->handle(); $job->handle();
}); });
it('skips a synchronized GitHub pull request preview when the head commit message contains skip ci', function () {
Queue::fake();
$this->application->settings->update([
'is_preview_deployments_enabled' => true,
]);
$githubApp = GithubApp::create([
'name' => 'Public GitHub',
'api_url' => 'https://api.github.com',
'html_url' => 'https://github.com',
'is_public' => true,
'team_id' => $this->team->id,
]);
Http::fake([
'https://api.github.com/repos/example/repo/commits/after-sha' => Http::response([
'commit' => [
'message' => 'docs: fix typo [skip ci]',
],
]),
]);
$job = new ProcessGithubPullRequestWebhook(
applicationId: $this->application->id,
githubAppId: $githubApp->id,
action: 'synchronize',
pullRequestId: 42,
pullRequestHtmlUrl: 'https://github.com/example/repo/pull/42',
pullRequestTitle: 'Add feature',
beforeSha: 'before-sha',
afterSha: 'after-sha',
commitSha: 'after-sha',
authorAssociation: 'OWNER',
fullName: 'example/repo',
);
$job->handle();
expect(ApplicationPreview::where('application_id', $this->application->id)->where('pull_request_id', 42)->exists())->toBeFalse()
->and(ApplicationDeploymentQueue::where('application_id', $this->application->id)->where('pull_request_id', 42)->exists())->toBeFalse();
Http::assertSent(fn (Request $request): bool => $request->url() === 'https://api.github.com/repos/example/repo/commits/after-sha');
});