Update Choreo documentation to reflect support for build variables in BYOC components

[YashodhaSamarawickrama]

Description

This pull request updates the documentation to clarify how to configure build-time environment variables for both Buildpack and BYOC (Bring Your Own Container) components. The changes provide clearer guidance and examples for each deployment method.

Documentation improvements:

• Added a new section explaining how to configure build-time environment variables for BYOC components, including how these variables are passed as build arguments (ARG) during Docker image builds.
• Clarified the process for setting environment variables for Buildpack components, and improved the example for overriding Maven commands.
• Removed an external link and replaced it with a direct reference to Google Cloud's buildpacks documentation for additional examples.

Related issue - https://github.com/wso2-enterprise/choreo/issues/39214

Type of change

• Change is only applicable for Developer view
• Change is only applicable for Platform Engineer view
• Change is applicable for both Developer and Platform Engineer views

Testing

• Change is tested in Developer view
• Change is tested in Platform Engineer view

Related issues

List related issues here

[coderabbitai]

Warning

Rate limit exceeded

@YashodhaSamarawickrama has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 40 minutes and 32 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 40 minutes and 32 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 41a9b92c-ddea-41fd-8bad-97d3ab68be4a

📥 Commits

Reviewing files that changed from the base of the PR and between 5794534 and 77c5656.

📒 Files selected for processing (1)

• en/developer-docs/docs/develop-components/deploy-an-application-with-buildpacks.md

📝 Walkthrough

Walkthrough

This documentation update clarifies how build-time environment variables are configured based on component type. Changes include labeling existing behavior specific to Buildpack components, updating a Maven override example by removing unnecessary inline-code formatting, removing a Google Cloud buildpacks hyperlink, and adding a new BYOC section. The BYOC section explains that build-time environment variables are supplied as Docker build ARGs during the Dockerfile build stage, with an example demonstrating ARG-referenced settings for build modes, feature flags, and dependency options.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: updating documentation to reflect support for build variables in BYOC components, which aligns with the core objective of the pull request.
Description check	✅ Passed	The description is comprehensive and includes all required sections from the template: clear description of changes, type of change selection, and related issue reference. The documentation improvements are well-documented.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

en/developer-docs/docs/develop-components/deploy-an-application-with-buildpacks.md (1)

174-174: Add a clickable link for the Google Cloud buildpacks reference.

Line 174 currently points to external documentation as plain text; adding a direct Markdown link will make this immediately actionable for readers.

Suggested doc tweak

-For more examples, see Google Cloud's buildpacks documentation.
+For more examples, see [Google Cloud buildpacks documentation](https://cloud.google.com/docs/buildpacks/overview).

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In
`@en/developer-docs/docs/develop-components/deploy-an-application-with-buildpacks.md`
at line 174, Replace the plain-text sentence "For more examples, see Google
Cloud's buildpacks documentation." with a Markdown clickable link to the Google
Cloud buildpacks page so readers can open it directly (e.g., "For more examples,
see Google Cloud's buildpacks documentation:
https://cloud.google.com/buildpacks" converted to a Markdown link). Update the
line in the deploy-an-application-with-buildpacks.md content where that sentence
appears so it uses the Markdown link syntax and preserves surrounding
punctuation and styling.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In
`@en/developer-docs/docs/develop-components/deploy-an-application-with-buildpacks.md`:
- Line 174: Replace the plain-text sentence "For more examples, see Google
Cloud's buildpacks documentation." with a Markdown clickable link to the Google
Cloud buildpacks page so readers can open it directly (e.g., "For more examples,
see Google Cloud's buildpacks documentation:
https://cloud.google.com/buildpacks" converted to a Markdown link). Update the
line in the deploy-an-application-with-buildpacks.md content where that sentence
appears so it uses the Markdown link syntax and preserves surrounding
punctuation and styling.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ed7fea03-618a-4d06-a52d-d42db97ee0cf

📥 Commits

Reviewing files that changed from the base of the PR and between 4edb734 and 5794534.

📒 Files selected for processing (1)

• en/developer-docs/docs/develop-components/deploy-an-application-with-buildpacks.md