Skip to content
Closed
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions src/VCS/DeploymentSkippable.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?php

namespace Utopia\VCS;

final class DeploymentSkippable
{
private function __construct()
{
}

private const PATTERNS = [
'[skip ci]',
'[ci skip]',
'[no ci]',
'[skip action]',
'[action skip]',
'[no action]',
'[skip actions]',
'[actions skip]',
'[no actions]',
'[skip deploy]',
'[deploy skip]',
'[no deploy]',
'[skip appwrite]',
'[appwrite skip]',
'[no appwrite]',
];

public static function isSkippedByCommitMessage(mixed $message): bool
{
if (!is_string($message)) {
return false;
}

$message = strtolower($message);

foreach (self::PATTERNS as $pattern) {
if (str_contains($message, $pattern)) {
return true;
}
}

return false;
}
}
68 changes: 68 additions & 0 deletions tests/VCS/DeploymentSkippableTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<?php

namespace Utopia\Tests;

use PHPUnit\Framework\TestCase;
use Utopia\VCS\DeploymentSkippable;

class DeploymentSkippableTest extends TestCase
{
public function testKnownSkipDirectivesSkip(): void
{
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[skip ci] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[ci skip] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[no ci] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[skip action] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[action skip] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[no action] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[skip actions] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[actions skip] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[no actions] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[skip deploy] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[deploy skip] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[no deploy] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[skip appwrite] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[appwrite skip] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[no appwrite] update changelog'));
}

public function testKnownSkipDirectivesAreCaseInsensitive(): void
{
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[SKIP CI] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[Skip Deploy] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[SKIP APPWRITE] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[Appwrite Skip] update changelog'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('[No Actions] update changelog'));
}

public function testMessageWithoutKnownDirectiveProceeds(): void
{
$this->assertFalse(DeploymentSkippable::isSkippedByCommitMessage('fix: real bug fix'));
$this->assertFalse(DeploymentSkippable::isSkippedByCommitMessage('feat: add new feature'));
$this->assertFalse(DeploymentSkippable::isSkippedByCommitMessage('skip deploy without brackets'));
$this->assertFalse(DeploymentSkippable::isSkippedByCommitMessage('deploy this please'));
$this->assertFalse(DeploymentSkippable::isSkippedByCommitMessage('skip-checks:true'));
}

public function testDirectiveCanAppearAnywhere(): void
{
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('docs: update readme [skip deploy]'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('docs: update readme[skip deploy]'));
$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage('prefix[skip deploy]suffix'));
$this->assertFalse(DeploymentSkippable::isSkippedByCommitMessage('refactor: skip appwrite cache seeding'));
$this->assertFalse(DeploymentSkippable::isSkippedByCommitMessage('fix: appwrite skip quota check in tests'));
}

public function testMultilineCommitMessageSkips(): void
{
$message = "feat: add new stuff\n\nMore detail here.\n\n[skip deploy]";

$this->assertTrue(DeploymentSkippable::isSkippedByCommitMessage($message));
}

public function testNonStringCommitMessageProceeds(): void
{
$this->assertFalse(DeploymentSkippable::isSkippedByCommitMessage(null));
$this->assertFalse(DeploymentSkippable::isSkippedByCommitMessage([]));
}
}
Loading