Skip to content

Add Ballerina config variable naming convention note - #180

Open
Skynettheone wants to merge 1 commit into
wso2:mainfrom
Skynettheone:fix/env-var-ballerina-config-convention
Open

Add Ballerina config variable naming convention note#180
Skynettheone wants to merge 1 commit into
wso2:mainfrom
Skynettheone:fix/env-var-ballerina-config-convention

Conversation

@Skynettheone

Copy link
Copy Markdown

Summary

Fixes #158.

The "Add an environment variable to your container" section didn't mention the naming convention required for Ballerina configurable variables, so users setting these via environment variables had no guidance on the expected key format.

Change

Added a note after the existing .env file import tip, explaining that Ballerina configurable variables should use the BAL_CONFIG_VAR_key=value naming convention, as requested in the issue.

Test plan

  • Confirmed the new note is inserted in the correct location and uses the same admonition formatting (!!!info "Note") as the rest of the document.

@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 694e610c-d5bb-4497-a9c7-4a4eddff959d

📥 Commits

Reviewing files that changed from the base of the PR and between 2928db6 and 39582a8.

📒 Files selected for processing (1)
  • en/docs/devops-and-ci-cd/manage-configurations-and-secrets.md

📝 Walkthrough

Summary

  • Document the BAL_CONFIG_VAR_key=value naming convention for Ballerina configurable variables.
  • Link to the Ballerina guide for additional configuration details.

Walkthrough

The documentation now states that environment variables for Ballerina configurable variables must use the BAL_CONFIG_VAR_key=value naming convention.

Suggested reviewers: pcnfernando

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the issue, change, and test plan, but it omits most required template sections, including release, documentation, security, and test-environment details. Complete the required template sections, or mark non-applicable sections as N/A with brief explanations.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the documentation change for the Ballerina configuration variable naming convention.
Linked Issues check ✅ Passed The change satisfies [#158] by adding the BAL_CONFIG_VAR_key=value format and linking to the Ballerina configurable variables guide.
Out of Scope Changes check ✅ Passed The pull request contains only the documentation note required by [#158] and no unrelated changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add an environment variable to your container section should say about naming conventions for ballerina config

1 participant