-
-
Notifications
You must be signed in to change notification settings - Fork 193
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 2.1.x: Added the documentation.yml to the workflows Applying latest coding standards Remove override of template type: causing psalm errors Upgrade to Psalm 5 (#370)
- Loading branch information
Showing
5 changed files
with
62 additions
and
5 deletions.
There are no files selected for viewing
This file contains 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,47 @@ | ||
name: "Documentation" | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- "*.x" | ||
paths: | ||
- .github/workflows/documentation.yml | ||
- docs/** | ||
push: | ||
branches: | ||
- "*.x" | ||
paths: | ||
- .github/workflows/documentation.yml | ||
- docs/** | ||
|
||
jobs: | ||
validate-with-guides: | ||
name: "Validate documentation with phpDocumentor/guides" | ||
runs-on: "ubuntu-22.04" | ||
|
||
steps: | ||
- name: "Checkout code" | ||
uses: "actions/checkout@v3" | ||
|
||
- name: "Install PHP" | ||
uses: "shivammathur/setup-php@v2" | ||
with: | ||
coverage: "none" | ||
php-version: "8.2" | ||
|
||
- name: "Remove existing composer file" | ||
run: "rm composer.json" | ||
|
||
- name: "Require phpdocumentor/guides-cli" | ||
run: "composer require --dev phpdocumentor/guides-cli dev-main@dev --no-update" | ||
|
||
- name: "Configure minimum stability" | ||
run: "composer config minimum-stability dev" | ||
|
||
- name: "Install dependencies with Composer" | ||
uses: "ramsey/composer-install@v2" | ||
with: | ||
dependency-versions: "highest" | ||
|
||
- name: "Run guides-cli" | ||
run: "vendor/bin/guides -vvv --no-progress --fail-on-log docs/en /tmp/test" |
This file contains 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
This file contains 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
This file contains 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 |
---|---|---|
|
@@ -49,8 +49,6 @@ public function clear(): void | |
|
||
/** | ||
Check failure on line 50 in src/AbstractLazyCollection.php GitHub Actions / Coding Standards / Coding Standards (8.1)
|
||
* {@inheritDoc} | ||
* | ||
* @template TMaybeContained | ||
*/ | ||
public function contains(mixed $element): bool | ||
{ | ||
|
This file contains 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 |
---|---|---|
|
@@ -197,8 +197,6 @@ public function containsKey(string|int $key): bool | |
|
||
/** | ||
Check failure on line 198 in src/ArrayCollection.php GitHub Actions / Coding Standards / Coding Standards (8.1)
|
||
* {@inheritDoc} | ||
* | ||
* @template TMaybeContained | ||
*/ | ||
public function contains(mixed $element): bool | ||
{ | ||
|