-
Notifications
You must be signed in to change notification settings - Fork 4k
Neon GA PowerShell CLI Command lets #27669
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?
Conversation
Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
… neon-ga-ps-cli-generator
…2/azure-powershell into neon-ga-ps-cli-generator
… neon-ga-ps-cli-generator
… neon-ga-ps-cli-generator
… neon-ga-ps-cli-generator
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 prepares the Neon GA PowerShell CLI commands for general availability by adding example markdown files with placeholders, updating command documentation with new parameter details, and aligning API and module versions.
- Added new example and help documentation files (e.g. Get-AzNeonPostgresCompute.md, Get-AzNeonPostgresBranch.md) with placeholders for titles, code, and outputs.
- Updated command documentation for organization, project, branch, compute, endpoint, database, and role operations with new parameter additions and adjusted API versions in UX JSON and AssemblyInfo files.
Reviewed Changes
Copilot reviewed 74 out of 74 changed files in this pull request and generated 4 comments.
Show a summary per file
File | Description |
---|---|
examples/*.md | Added placeholder examples for various cmdlets. |
docs/*.md | Updated command syntax and parameter lists; added new parameters. |
UX/Neon.Postgres/*.json | Updated API version and refined command specifications. |
README.md | Updated commit id and module version information. |
Properties/AssemblyInfo.cs | Updated assembly version to align with GA release. |
src/NeonPostgres/NeonPostgres.Autorest/examples/Get-AzNeonPostgresCompute.md
Outdated
Show resolved
Hide resolved
src/NeonPostgres/NeonPostgres.Autorest/docs/Update-AzNeonPostgresOrganization.md
Show resolved
Hide resolved
src/NeonPostgres/NeonPostgres.Autorest/examples/Get-AzNeonPostgresNeonRole.md
Show resolved
Hide resolved
… neon-ga-ps-cli-generator
… neon-ga-ps-cli-generator
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
The reported issues for the md files
|
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
@alluri02 Please fix the following issues. |
@vidai-msft fixed this issue, could you please run the /azp run. |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
… neon-ga-ps-cli-generator
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
``` | ||
|
||
```output | ||
{{ Add output here (remove the output block if the example doesn't have an output) }} |
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.
Can you replace the place holder with the real output or delete this section if not necessary?
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.
updated the doc with example output
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.
@alluri02 Looks like the place holder is still there. Could you please remove it?
``` | ||
|
||
```output | ||
{{ Add output here (remove the output block if the example doesn't have an output) }} |
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.
Please remove the place holder.
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.
updated with the example output
. ($mockingPath | Select-Object -First 1).FullName | ||
} | ||
|
||
Describe 'Get-AzNeonPostgresProjectConnectionUri' { |
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.
There is no test cases for this cmdlet. Is it possible to provide one?
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.
Done
. ($mockingPath | Select-Object -First 1).FullName | ||
} | ||
|
||
Describe 'New-AzNeonPostgresBranch' { |
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.
There is no test case for this cmdlet. Is it possible to provide at least one case?
## Version 0.1.1 | ||
|
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.
Remove this empty line.
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.
done
|
||
* First preview release for module Az.NeonPostgres |
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.
Remove the empty line above.
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.
done
@@ -19,9 +19,17 @@ | |||
--> | |||
## Upcoming Release | |||
|
|||
## Version 1.0.0 |
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.
Instead of adding a new version number section, please move the release notes to under the Upcoming Release section.
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.
Done
@alluri02 I noticed there is no test case for some of the cmdlets. Is it possible to add at least 1 test case for each cmdlet? If not possible, please add at least 1 test case with -live switch. |
… neon-ga-ps-cli-generator
… neon-ga-ps-cli-generator
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
Done |
``` | ||
|
||
```output | ||
{{ Add output here (remove the output block if the example doesn't have an output) }} |
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.
@alluri02 Looks like the place holder is still there. Could you please remove it?
Description
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.md
and reviewed the following information:ChangeLog.md
file(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
.## Upcoming Release
header in the past tense.ChangeLog.md
if no new release is required, such as fixing test case only.