File tree Expand file tree Collapse file tree 3 files changed +15
-66
lines changed
Expand file tree Collapse file tree 3 files changed +15
-66
lines changed Load Diff This file was deleted.
Original file line number Diff line number Diff line change @@ -16,24 +16,24 @@ Using composer: ```composer require chemaclass/jira-status-notifier```
1616
1717### Requirements
1818
19- #### GNU Make 4.+ (for Makefile) [ Install for Mac] ( https://stackoverflow.com/questions/43175529/updating-make-version-4-1-on-mac ) | Optional
20-
21- Some make tasks to execute commands inside the docker container such:
22-
23- * ` make bash ` -> access into the bash
24- * ` make csfix ` -> run the code style fixer (` .php_cs ` )
25- * ` make composer ARGS="install" ` -> run composer
26- * ` make tests ARGS="--filter AddressGenerator" ` -> run PHPUnit
27-
2819### Your first try!
2920
30211 . Clone/Fork the project and ` cd ` inside the repository
31222 . ` docker-compose up `
32- 3 . ` make bash ` or ` docker exec -ti -u dev jira_status_notifier_php bash `
23+ 3 . ` docker exec -ti -u dev jira_status_notifier_php bash `
33244 . ` cd examples/using-cli-channel `
34255 . ` cp .env.dist .env `
35266 . Update the [ ` .env ` values] ( docu/mandatory-parameters.md )
36- 7 . ` php console ` or ` ./console `
27+ 7 . ` php console `
28+
29+ ### Composer scripts
30+
31+ ```
32+ composer test # execute phpunit tests
33+ composer csfix # run php-cs-fixer fix
34+ composer psalm # display psalm errors
35+ composer psalm-log # generate a file with psalm suggestions
36+ ```
3737
3838## Documentation
3939
@@ -69,4 +69,3 @@ $result = $jiraConnector->handle(JiraConnectorInput::new(
6969 ['To Do' => 3, 'In Progress' => 2, 'In Review' => 1]
7070));
7171```
72-
Original file line number Diff line number Diff line change 5757 }
5858 },
5959 "scripts" : {
60- "test" : " phpunit"
60+ "test" : " vendor/bin/phpunit" ,
61+ "csfix" : " vendor/bin/php-cs-fixer fix" ,
62+ "psalm" : " vendor/bin/psalm" ,
63+ "psalm-log" : " vendor/bin/psalm --output-format=text --show-info=true > psalm.log"
6164 }
6265}
You can’t perform that action at this time.
0 commit comments