Skip to content

Commit

Permalink
fix(phpstan): Fix doc about tools symlinks
Browse files Browse the repository at this point in the history
  • Loading branch information
welcoMattic committed Aug 17, 2023
1 parent e171d86 commit 99d4842
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ jobs:
name: 'Check PHP coding standards'
run: 'castor qa:cs'

-
name: 'Run PHPStan'
run: 'castor qa:phpstan'

-
name: 'Test HTTP server'
run: |
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,10 @@ We suggest to:

1. create a composer.json which requires only this tool in `tools/<tool name>/composer.json`;

1. create a symbolic link to the tool executable in `tools/bin/<tool bin>`: `ln -s ../<tool name>/vendor/bin/<tool bin> tools/bin/<tool bin>`;
1. create an executable symbolic link to the tool from the root directory of the project: `ln -s ../<tool name>/vendor/bin/<tool bin> tools/bin/<tool bin>`;

> **Note**
> Relative symlinks works here, because the first part of the command is relative to the second part, not to the current directory.

Since `tools/bin` path is appended to the `$PATH`, tools will be available globally in the builder container.

Expand Down
2 changes: 1 addition & 1 deletion phpstan.neon
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ parameters:

# symfony:
# container_xml_path: '%rootDir%/../../../../../application/var/cache/dev/App_KernelDevDebugContainer.xml'

typeAliases:
ContextData: '''
array{
Expand Down

0 comments on commit 99d4842

Please sign in to comment.