fix: correct indentation for extra environmental variable examples #254
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.
What this PR does / why we need it
This PR corrects a critical indentation error within the example configuration for
webhook.extraEnv
in bothREADME.md
andcharts/n8n/values.yaml
.The previous indentation for the commented-out
value
field of the exampleWEBHOOK_URL
would result in an invalid YAML structure if a user simply uncommented the lines, leading to potential misconfiguration or chart failures.Before:
# WEBHOOK_URL: - # value: "http://webhook.domain.tld"
After:
# WEBHOOK_URL: + # value: "http://webhook.domain.tld"
The corrected indentation aligns the
value
key properly under theWEBHOOK_URL
map.Which issue this PR fixes
Special notes for your reviewer
This is a minor but important fix to ensure the YAML syntax is correct for users who rely on the examples in
values.yaml
andREADME.md
. No functional code changes were made.Checklist
Please place an 'x' in all applicable fields and remove unrelated items.
Version and Documentation
Chart.yaml
following semantic versioningChart.yaml
if applicableartifacthub.io/changes
section updated inChart.yaml
(see ArtifactHub annotation reference)README.md
(Corrects formatting in documentation/examples)Testing and Validation
ah lint
locally without errors (A YAML syntax fix is covered by linting)ct lint --chart-dirs charts/n8n --charts charts/n8n --validate-maintainers=false
/examples
directorySummary by CodeRabbit