-
Notifications
You must be signed in to change notification settings - Fork 1.5k
[Safeguards] Fix verb tense in help text and add pre-existence check #9433
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
[Safeguards] Fix verb tense in help text and add pre-existence check #9433
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>
|
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 |
|
Hi @ShantingLiu Release SuggestionsModule: aks-preview
Notes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR fixes verb tense in safeguards help text to align with Azure CLI documentation guidelines by changing from third-person present tense (e.g., "Creates", "Deletes", "Gets") to first-person imperative verbs (e.g., "Create", "Delete", "Get"). The version is also bumped to 19.0.0b17 with a corresponding changelog entry.
- Updated help text examples in
_show.py,_delete.py, and_create.pyto use imperative verb forms - Incremented version from 19.0.0b16 to 19.0.0b17 in setup.py
- Added changelog entry documenting the help text fix
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/aks-preview/setup.py | Version bump from 19.0.0b16 to 19.0.0b17 |
| src/aks-preview/azext_aks_preview/aaz/latest/aks/safeguards/_show.py | Changed "Gets" to "Get" in example descriptions |
| src/aks-preview/azext_aks_preview/aaz/latest/aks/safeguards/_delete.py | Changed "Deletes" to "Delete" in example descriptions |
| src/aks-preview/azext_aks_preview/aaz/latest/aks/safeguards/_create.py | Changed "Creates" to "Create" in example descriptions |
| src/aks-preview/HISTORY.rst | Added changelog entry for version 19.0.0b17 |
|
please fix failed CI checks |
src/aks-preview/azext_aks_preview/aaz/latest/aks/safeguards/_create.py
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Queued live test to validate the change, test passed!
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
c295313 to
ad5a256
Compare
| 'aks_name': self.create_random_name(prefix='akssafeguards-', length=20), | ||
| 'ssh_key_value': self.generate_ssh_keys(), | ||
| 'vm_size': 'standard_a8_v2' | ||
| 'vm_size': 'Standard_DS2_v2' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @ShantingLiu, since you've updated the argument value in the test case, please make sure to update the value in the recording files as well so the CI checks can pass.
ad5a256 to
c4bc7a3
Compare
c4bc7a3 to
8eb3b38
Compare
|
The current recordings are still not passing the CI checks. I have re-queued the live test for the safeguard-related tests. If the live test passes, you can download the new recording files from the pipeline artifact, and they should pass the CI. |
Changes Made
az aks safeguards createto prevent duplicate resource creationThis checklist is used to make sure that common guidelines for a pull request are followed.
Related command
az aks safeguards create,az aks safeguards delete,az aks safeguards showDescription
This PR addresses two improvements to the safeguards commands:
Help text verb tense fix: Updated examples in
_create.py,_delete.py, and_show.pyto use first-person imperative verbs per Azure CLI guidelines (e.g., "Create" instead of "Creates").Pre-existence validation: Added a check in
az aks safeguards createto prevent duplicate resource creation. The command now:az aks safeguards updateoraz aks safeguards delete-g/-nand--managed-clusterURI syntaxTesting
-g/-nand--managed-clusterURI syntaxGeneral Guidelines
azdev style <YOUR_EXT>locally? (pip install azdevrequired)azdevrequires a full Azure CLI development environment with bothazure-cliandazure-cli-extensionsrepos configured viaazdev setup. This PR contains help text changes in AAZ-generated files and validation logic. The CI pipeline will validate this automatically.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.Addresses feedback from PR #897