-
Notifications
You must be signed in to change notification settings - Fork 6
feat: add DeploymentSkippable for commit-message skip detection #99
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
8133457
feat: add DeploymentSkippable for commit-message skip detection
HarshMN2345 6506e94
refactor: rename fromCommitMessage to isSkippedByCommitMessage, add f…
HarshMN2345 3555188
fix lint
HarshMN2345 8e649da
refactor: move DeploymentSkippable to Validator folder, extend Utopia…
HarshMN2345 7f3e599
Merge branch 'main' into feat/deployment-skippable
HarshMN2345 2d04e80
refactor: move DeploymentSkippableTest to Unit/Validator folder
HarshMN2345 a1ab7bc
fix: add missing comma in composer.json require block
HarshMN2345 14ef81e
chore: update composer.lock with utopia-php/framework
HarshMN2345 8ded73a
fix: replace utopia-php/framework with utopia-php/validators to avoid…
HarshMN2345 0191746
refactor: keep only [skip ci] pattern, update tests accordingly
HarshMN2345 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| <?php | ||
|
|
||
| namespace Utopia\VCS; | ||
|
|
||
| class DeploymentSkippable | ||
| { | ||
| 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 fromCommitMessage(mixed $message): bool | ||
|
greptile-apps[bot] marked this conversation as resolved.
Outdated
|
||
| { | ||
| if (!is_string($message)) { | ||
| return false; | ||
| } | ||
|
|
||
| $message = strtolower($message); | ||
|
|
||
| foreach (self::PATTERNS as $pattern) { | ||
| if (str_contains($message, $pattern)) { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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::fromCommitMessage('[skip ci] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[ci skip] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[no ci] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[skip action] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[action skip] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[no action] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[skip actions] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[actions skip] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[no actions] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[skip deploy] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[deploy skip] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[no deploy] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[skip appwrite] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[appwrite skip] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[no appwrite] update changelog')); | ||
| } | ||
|
|
||
| public function testKnownSkipDirectivesAreCaseInsensitive(): void | ||
| { | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[SKIP CI] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[Skip Deploy] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[SKIP APPWRITE] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[Appwrite Skip] update changelog')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('[No Actions] update changelog')); | ||
| } | ||
|
|
||
| public function testMessageWithoutKnownDirectiveProceeds(): void | ||
| { | ||
| $this->assertFalse(DeploymentSkippable::fromCommitMessage('fix: real bug fix')); | ||
| $this->assertFalse(DeploymentSkippable::fromCommitMessage('feat: add new feature')); | ||
| $this->assertFalse(DeploymentSkippable::fromCommitMessage('skip deploy without brackets')); | ||
| $this->assertFalse(DeploymentSkippable::fromCommitMessage('deploy this please')); | ||
| $this->assertFalse(DeploymentSkippable::fromCommitMessage('skip-checks:true')); | ||
| } | ||
|
|
||
| public function testDirectiveCanAppearAnywhere(): void | ||
| { | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('docs: update readme [skip deploy]')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('docs: update readme[skip deploy]')); | ||
| $this->assertTrue(DeploymentSkippable::fromCommitMessage('prefix[skip deploy]suffix')); | ||
| $this->assertFalse(DeploymentSkippable::fromCommitMessage('refactor: skip appwrite cache seeding')); | ||
| $this->assertFalse(DeploymentSkippable::fromCommitMessage('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::fromCommitMessage($message)); | ||
| } | ||
|
|
||
| public function testNonStringCommitMessageProceeds(): void | ||
| { | ||
| $this->assertFalse(DeploymentSkippable::fromCommitMessage(null)); | ||
| $this->assertFalse(DeploymentSkippable::fromCommitMessage([])); | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.