STARK

, _(*1)

Stark is a project to perform VCS hooks and in case of errors stop action and report to user. Stark's use of simple XML hooks file and extensible PHP task classes make it an easy-to-use and highly flexible VCS hooks framework., _(*2)

Stark was written in the way how Phing is managing the build system - one simple XML rules all tasks. Additionally system of properties is very similar to one used in Phing, if you know how to use Phing, you're ready to start using Stark., _(*3)

Supports multiple actions per hook
Supports multiple VCS systems
Define everything in one portable XML file
Plug-in architecture allows super-easy extensions

Stark solved all issues with creating VCS-related scripts. With one clean XML you can manage all hooks in all your repositories . With big set of predefined tasks you are able to start checking your commits integrity just in a few seconds., _(*4)

Usage

stark vcs_type action arg1, arg2, arg3, ... argN

param	info
type	repository type. At this moment STARK supports only SVN. Git Support is in progress
action	action you want to perform. Stark will take all tasks defined under hooks/{ACTION} tree and execute them. If at least one of them fails script will stop commit and output error message [only on pre-actions]
arg1, arg2, arg3	arguments set for repository

Sample XML definition

```xml , _(*5)



Available Tasks
----------------

Comment
---
    <comment minLength="10" notEmpty="true" regex="/[a-zA-Z]+/" />

| Parameter  | Default value | Required | Description |
| ---------- | ------------- | --------- | ---------- |
| minLength  | 0  | no | Minimum comment length|
| notEmpty   | true | no | can comment be empty |
| regex      | /.*/ | no | regular expression comment has to match |


Execute external command
---
    <external_command command="ls -la" errorMessage="Cannot execute command" />

| Parameter  | Default value | Required | Description |
| ---------- | ------------- | --------- | ---------- |
| command    |  null    | yes       | command to run |
| errorMessage | Execution of remote command '%s' failed with code '%s | no | Error message to show when command fails (sends exitCode different than successExitCode |
| successExitCode | 0 | no | success exit code |
| includeOutput | false | no | when tasks fails, should error message contain output of script |



File Filter
---
    <file_filter extensions="ini,log,tmp" regex="^\/tmp\/.*$" />

| Parameter  | Default value | Required | Description |
| ---------- | ------------- | --------- | ---------- |
| extensions    |  null    | no       | comma sepearated list of extensions to filter |
| regex | '' | no | file paths cannot match given regular expression |
| noSpaces | false | no | Don't allow spaces in file names |
| UseOnlyAsciiFileNames | false | no | Allow only ASCII chars in file name |
| admins | '' | no | comma separated list of authors who are allowed to commit |

Log
---
    <log file="/tmp/vcs.log" meesage="User ${author} made a commit on ${date} ${time}" />

| Parameter  | Default value | Required | Description |
| ---------- | ------------- | --------- | ---------- |
| file  |  | yes | log file name|
| message |  | yes | line to put into log file |

Mail
---
    <mail to="admin@dev" subject="Successful commit" body="User ${author} made a commit on ${date} ${time}" />

| Parameter  | Default value | Required | Description |
| ---------- | ------------- | --------- | ---------- |
| to  | '' | yes | receiver of message |
| subject | '' | yes | message subject |
| body | '' | yes | email content |
| from | stark@localhost | no | sender |
| replyTo | none@localhost | no | replyTo address |


PHPLint
---
    <php_lint  />

| Parameter  | Default value | Required | Description |
| ---------- | ------------- | --------- | ---------- |
| fileExtensions  | php,php4,php5,phtml | no | comma separated list of php file extensions |

PHP Code Sniffer
---
    <php_cs  />

| Parameter  | Default value | Required | Description |
| ---------- | ------------- | --------- | ---------- |
| fileExtensions  | php,php4,php5,phtml | no | comma separated list of php file extensions |
| standard  | PSR-2 | no | Code Style standard |

RegisterRepository
---
     <register_repository name="vcs" classname="myTaskClass"  />>
Registers a new repository for given hooks.

| Parameter  | Default value | Required | Description |
| ---------- | ------------- | --------- | ---------- |
| name  | '' |  yes | repository name |
| classname  | '' |  yes | class that implments **\Stark\core\Repository** interface |

To use new repository you have to run Stark passing new repository name 
```bash
stark vcs myAction arg1, arg2, arg3

RegisterTask

<register_task name="myTask" classname="myTaskClass"  />

Parameter	Default value	Required	Description
name	''	yes	repository name
classname	''	yes	class that extends \Stark\core\Tasks\Task class

Author

Piotr Miazga piotr.miazga@yahoo.com, _(*6)

License

GNU, _(*7)

21/11 2014

dev-master

9999999-dev

Versioning repositories hooks framework

Sources Download

proprietary

library stark

Versioning repositories hooks framework

polishdeveloper/stark

The README.md