Skip to content
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.

Sign up for GitHub

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

Added docs generator. #318

Merged
merged 1 commit into from
Nov 6, 2024
Merged

Added docs generator. #318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .ahoy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,14 @@ commands:
&& ahoy cli "cd /app/build && ./vendor/bin/rector --clear-cache" \
&& ahoy cli "cd /app/build && ./vendor/bin/phpcbf"

lint-docs:
usage: Lint docs.
cmd: ahoy cli "php docs.php --fail-on-change"

update-docs:
usage: Lint docs.
cmd: ahoy cli "php docs.php"

test-bdd:
usage: Run BDD tests.
cmd: ahoy cli "cd /app/build && vendor/bin/behat -c /app/behat.yml --strict --colors $@"
Expand Down
4 changes: 4 additions & 0 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ jobs:
name: Lint code
command: ahoy lint || [ "${CI_LINT_IGNORE_FAILURE:-0}" -eq 1 ]

- run:
name: Lint documentation
command: ahoy lint-docs || [ "${CI_LINT_DOCS_IGNORE_FAILURE:-0}" -eq 1 ]

- run:
name: Run tests with coverage
command: ahoy test-bdd-coverage || [ "${CI_TEST_IGNORE_FAILURE:-0}" -eq 1 ]
Expand Down
4 changes: 2 additions & 2 deletions MIGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A migration map of the step definitions available in v2 to v3.

| V2 | V3 |
|------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[`DraggableViewsTrait`](src/DraggableViewsTrait.php) ([example](tests/behat/features/draggableviews.feature))** | |
| **[`DraggableviewsTrait`](src/DraggableviewsTrait.php) ([example](tests/behat/features/draggableviews.feature))** | |
| `Then I save draggable views :view_id view :views_display_id display :bundle items in the following order:` | `When I save the draggable views items of the view :view_id and the display :views_display_id for the :bundle content in the following order:` |
|   | |
| **[`EckTrait`](src/EckTrait.php) ([example](tests/behat/features/eck.feature))** | |
Expand All @@ -24,7 +24,7 @@ A migration map of the step definitions available in v2 to v3.
| `Given I press the :char key` | `When I press the key :char` |
| `Given I press the :char key on :selector` | `When I press the key :char on the element :selector` |
|   | |
| **[`MetaTagTrait`](src/MetaTagTrait.php) ([example](tests/behat/features/metatag.feature))** | |
| **[`MetatagTrait`](src/MetatagTrait.php) ([example](tests/behat/features/metatag.feature))** | |
| `Then I should see a meta tag with the following attributes:` | `Then the meta tag should exist with the following attributes:` |
| `Then I should not see a meta tag with the following attributes:` | `Then the meta tag should not exist with the following attributes:` |
|   | |
Expand Down
Loading