fixing help description for kind argument in az containerapp create command
#9038
Conversation
️✔️Azure CLI Extensions Breaking Change Test
|
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
There was a problem hiding this comment.
Pull Request Overview
This PR improves the help documentation for the --kind argument in the az containerapp create command to provide clearer guidance on its usage for Azure Functions deployments.
- Updates the help text for the
--kindparameter to be more descriptive and specific - Increments the version from 1.2.0b3 to 1.2.0b4
- Adds a changelog entry documenting the help text improvement
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/containerapp/setup.py | Version bump to 1.2.0b4 |
| src/containerapp/azext_containerapp/_params.py | Enhanced help text for the --kind parameter |
| src/containerapp/HISTORY.rst | Added changelog entry for the help text update |
| validator=validate_build_env_vars, is_preview=True) | ||
| c.argument('max_inactive_revisions', type=int, help="Max inactive revisions a Container App can have.", is_preview=True) | ||
| c.argument('kind', type=str, help="Set to 'functionapp' to get built in support and autoscaling to run Azure functions on Azure Container apps", is_preview=True) | ||
| c.argument('kind', type=str, help="Set the kind property to 'functionapp' when deploying Azure Functions container images to Azure Container Apps. This configuration enables built-in support and autoscaling capabilities.", is_preview=True) |
There was a problem hiding this comment.
[nitpick] The help text could be more concise while still being clear. Consider: "Set to 'functionapp' when deploying Azure Functions to enable built-in support and autoscaling for Azure Container Apps."
| c.argument('kind', type=str, help="Set the kind property to 'functionapp' when deploying Azure Functions container images to Azure Container Apps. This configuration enables built-in support and autoscaling capabilities.", is_preview=True) | |
| c.argument('kind', type=str, help="Set to 'functionapp' when deploying Azure Functions to enable built-in support and autoscaling for Azure Container Apps.", is_preview=True) |
microsoft-github-policy-service
bot
requested review from
Greedygre,
JennyLawrance,
chinadragon0515,
ebencarek,
jijohn14,
jsntcy,
pagariyaalok,
ruslany,
sanchitmehta,
torosent,
vinisoto,
vturecek,
wangzelin007,
yanzhudd,
yonzhan and
zhoxing-ms
CodeGen Tools Feedback CollectionThank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey |
khushishah513
changed the title
az containerapp create command
Release SuggestionsModule: containerapp
Notes
|
khushishah513
force-pushed
the
functionapp-help
branch
from
e961eca to
e35d94d
Compare
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
… command (Azure#9038) * fixing help description for kind argument in az containerapp create command * undoing version change * modifying help description for king argument in containerapp create
3 participants
…ommand
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
General Guidelines
azdev style <YOUR_EXT>locally? (pip install azdevrequired)python scripts/ci/test_index.py -qlocally? (pip install wheel==0.30.0required)For new extensions:
About Extension Publish
There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update
src/index.jsonautomatically.You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify
src/index.json.