Detecting and fixing incorrect YAML samples#3165
Open
mnocon wants to merge 16 commits into
Open
Conversation
mnocon
force-pushed
the
test-yamls
branch
2 times, most recently
from
32845fd to
b144d93
Compare
mnocon
changed the title
mnocon
commented
Apr 23, 2026
| @@ -1,13 +0,0 @@ | |||
| ibexa: | |||
Contributor
Author
There was a problem hiding this comment.
Not used - but it should be toolbar, not toolbars
mnocon
commented
Apr 23, 2026
| security: | ||
| firewalls: | ||
| # ... | ||
| ibexa_cdp: |
Contributor
Author
There was a problem hiding this comment.
Was outdated - the new config was stolen from configuration provided when installing the project
mnocon
commented
Apr 23, 2026
| # Raptor Recommendations API URL, optional, set by default | ||
| recommendations_api_url: '%ibexa.connector.raptor.recommendations.api_url%' | ||
| # Raptor Recommendations API URI, optional, set by default | ||
| recommendations_api_uri: '%ibexa.connector.raptor.recommendations.api_uri%' |
mnocon
commented
Apr 23, 2026
| http: | ||
| enabled: true | ||
| batch_size: 64 | ||
| enabled: true |
Contributor
Author
There was a problem hiding this comment.
This sample had mixed tabs and spaces
mnocon
commented
Apr 23, 2026
| - | ||
| path: docs/users/user_authentication.md | ||
| line: 41 | ||
| message: '~Unrecognized option "encoders" under "security"\. Available options are "access_control", "access_decision_manager", "access_denied_url", "erase_credentials", "expose_security_errors", "firewalls", "hide_user_not_found", "password_hashers", "providers", "role_hierarchy", "session_fixation_strategy"\.~' |
Contributor
Author
There was a problem hiding this comment.
This one is valid (incorrect code sample), but I want to tackle this in a follow-up
adriendupuis
requested changes
Apr 23, 2026
Contributor
adriendupuis
left a comment
adriendupuis
left a comment
There was a problem hiding this comment.
I focused on everything not in docs/ dir for this first pass
| content: | ||
| tree_root: | ||
| location_id: location_id_of_customer_portals_root_folder | ||
| location_id: 9999 # location_id_of_customer_portals_root_folder |
Contributor
There was a problem hiding this comment.
Consistency with the changes above and below:
location_id_of_customer_portal = 9999
location_id_of_customer_portals_root_folder = 999
Suggested change
| location_id: 9999 # location_id_of_customer_portals_root_folder | |
| location_id: 999 # location_id_of_customer_portals_root_folder |
| run: | | ||
| curl -H "Authorization: token $TOKEN" -L https://github.com/ibexa/vale-styles/archive/refs/heads/main.zip -o vale.zip | ||
| rm -rf tests | ||
| unzip vale.zip |
Contributor
There was a problem hiding this comment.
Keep archive removal
Suggested change
| unzip vale.zip | |
| unzip vale.zip | |
| rm vale.zip |
adriendupuis
approved these changes
Apr 24, 2026
Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>
code_samples/ change report
|
mnocon
commented
May 16, 2026
| if: steps.list.outputs.CODE_SAMPLES_CHANGE != '' | ||
| run: | | ||
| git fetch origin | ||
| git fetch origin --depth=1 ${{ github.head_ref }} |
Contributor
Author
There was a problem hiding this comment.
Added after I've noticed that this step takes 11 minutes in one of the runs:
https://github.com/ibexa/documentation-developer/actions/runs/25958230826/job/76308753865
with this change it's reduced to 36 seconds:
https://github.com/ibexa/documentation-developer/actions/runs/25958591368/job/76309740366?pr=3165
ibexa-workflow-automation-1
Bot
requested review from
adriendupuis,
dabrt and
julitafalcondusza
and removed request for
a team
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| if: steps.list.outputs.CODE_SAMPLES_CHANGE != '' | ||
| run: | | ||
| git fetch origin | ||
| git fetch origin --depth=1 ${{ github.head_ref }} |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR allows us to test the YAML code samples in the doc - both in the code_samples directory (.yaml files) and the ones embedded directly in Markdown (by extracting the ``` yaml code blocks).
There are two checks:
ibexa,security,ibexa_migrationsconfiguration keysNot everything is checked - for example, Ibexa Migration files are not validated.
Running the tests
To run the tests, execute:
Example output:
Either fix the code sample, or add the error to the list of ignored lists by running:
Thats a baseline for samples that should be ignored - to put something in the baseline, run
composer yaml-update-baselineand commit the modifiedtests/yaml-validation-baseline.yamlBaseline
Baseline depends on a hash of the code sample (SHA-256), not the line number itself - the line number is there just for us to locate the code sample easily. This prevent raising the same issue every time the line numbers of the code sample changes (for example, when it's modified).