Skip to content

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

Open
wants to merge 43 commits into
base: main
Choose a base branch
from

Conversation

alluri02
Copy link
Member

@alluri02 alluri02 commented Apr 29, 2025

Description

Mandatory Checklist

  • SHOULD update ChangeLog.md file(s) appropriately
    • For SDK-based development mode, update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
      • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
    • For autorest-based development mode, include the changelog in the PR description.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT adjust version of module manually in pull request

Copy link

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

@alluri02 alluri02 marked this pull request as ready for review May 6, 2025 10:24
Copy link
Contributor

@Copilot Copilot AI left a 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.

@msJinLei
Copy link
Contributor

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@msJinLei
Copy link
Contributor

msJinLei commented May 20, 2025

The reported issues for the md files


  "Az.NeonPostgres","New-AzNeonPostgresProject","2","0","MissingExampleDescription","5046","1","Description of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\New-AzNeonPostgresProject.md","Add description for the example. Remove any placeholders."
  "Az.NeonPostgres","Remove-AzNeonPostgresBranch","1","0","MissingExampleTitle","5043","1","Title of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Remove-AzNeonPostgresBranch.md","Add title for the example. Remove any placeholders."
  "Az.NeonPostgres","Remove-AzNeonPostgresBranch","1","0","MissingExampleCode","5044","1","Code of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Remove-AzNeonPostgresBranch.md","Add code for the example. Remove any placeholders."
  "Az.NeonPostgres","Remove-AzNeonPostgresBranch","1","0","MissingExampleDescription","5046","1","Description of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Remove-AzNeonPostgresBranch.md","Add description for the example. Remove any placeholders."
  "Az.NeonPostgres","Remove-AzNeonPostgresBranch","2","0","MissingExampleTitle","5043","1","Title of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Remove-AzNeonPostgresBranch.md","Add title for the example. Remove any placeholders."
  "Az.NeonPostgres","Remove-AzNeonPostgresBranch","2","0","MissingExampleCode","5044","1","Code of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Remove-AzNeonPostgresBranch.md","Add code for the example. Remove any placeholders."
  "Az.NeonPostgres","Remove-AzNeonPostgresBranch","2","0","MissingExampleDescription","5046","1","Description of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Remove-AzNeonPostgresBranch.md","Add description for the example. Remove any placeholders."
  "Az.NeonPostgres","Remove-AzNeonPostgresProject","1","0","MissingExampleTitle","5043","1","Title of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Remove-AzNeonPostgresProject.md","Add title for the example. Remove any placeholders."
  "Az.NeonPostgres","Remove-AzNeonPostgresProject","1","0","MissingExampleCode","5044","1","Code of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Remove-AzNeonPostgresProject.md","Add code for the example. Remove any placeholders."
  "Az.NeonPostgres","Remove-AzNeonPostgresProject","1","0","MissingExampleDescription","5046","1","Description of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Remove-AzNeonPostgresProject.md","Add description for the example. Remove any placeholders."
  "Az.NeonPostgres","Remove-AzNeonPostgresProject","2","0","MissingExampleTitle","5043","1","Title of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Remove-AzNeonPostgresProject.md","Add title for the example. Remove any placeholders."
  "Az.NeonPostgres","Remove-AzNeonPostgresProject","2","0","MissingExampleCode","5044","1","Code of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Remove-AzNeonPostgresProject.md","Add code for the example. Remove any placeholders."
  "Az.NeonPostgres","Remove-AzNeonPostgresProject","2","0","MissingExampleDescription","5046","1","Description of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Remove-AzNeonPostgresProject.md","Add description for the example. Remove any placeholders."
  "Az.NeonPostgres","Update-AzNeonPostgresBranch","1","0","MissingExampleTitle","5043","1","Title of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Update-AzNeonPostgresBranch.md","Add title for the example. Remove any placeholders."
  "Az.NeonPostgres","Update-AzNeonPostgresBranch","1","0","MissingExampleCode","5044","1","Code of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Update-AzNeonPostgresBranch.md","Add code for the example. Remove any placeholders."
  "Az.NeonPostgres","Update-AzNeonPostgresBranch","1","0","MissingExampleDescription","5046","1","Description of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Update-AzNeonPostgresBranch.md","Add description for the example. Remove any placeholders."
  "Az.NeonPostgres","Update-AzNeonPostgresBranch","2","0","MissingExampleTitle","5043","1","Title of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Update-AzNeonPostgresBranch.md","Add title for the example. Remove any placeholders."
  "Az.NeonPostgres","Update-AzNeonPostgresBranch","2","0","MissingExampleCode","5044","1","Code of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Update-AzNeonPostgresBranch.md","Add code for the example. Remove any placeholders."
  "Az.NeonPostgres","Update-AzNeonPostgresBranch","2","0","MissingExampleDescription","5046","1","Description of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Update-AzNeonPostgresBranch.md","Add description for the example. Remove any placeholders."
  "Az.NeonPostgres","Update-AzNeonPostgresProject","1","0","MissingExampleTitle","5043","1","Title of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Update-AzNeonPostgresProject.md","Add title for the example. Remove any placeholders."
  "Az.NeonPostgres","Update-AzNeonPostgresProject","1","0","MissingExampleCode","5044","1","Code of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Update-AzNeonPostgresProject.md","Add code for the example. Remove any placeholders."
  "Az.NeonPostgres","Update-AzNeonPostgresProject","1","0","MissingExampleDescription","5046","1","Description of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Update-AzNeonPostgresProject.md","Add description for the example. Remove any placeholders."
  "Az.NeonPostgres","Update-AzNeonPostgresProject","2","0","MissingExampleTitle","5043","1","Title of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Update-AzNeonPostgresProject.md","Add title for the example. Remove any placeholders."
  "Az.NeonPostgres","Update-AzNeonPostgresProject","2","0","MissingExampleCode","5044","1","Code of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Update-AzNeonPostgresProject.md","Add code for the example. Remove any placeholders."
  "Az.NeonPostgres","Update-AzNeonPostgresProject","2","0","MissingExampleDescription","5046","1","Description of the example is missing.","D:\a\_work\1\s\src\NeonPostgres\NeonPostgres\help\Update-AzNeonPostgresProject.md","Add description for the example. Remove any placeholders."
  

@vidai-msft
Copy link
Contributor

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@vidai-msft
Copy link
Contributor

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@vidai-msft
Copy link
Contributor

@alluri02 Please fix the following issues.
"Module","Cmdlet","Example","Line","RuleName","ProblemId","Severity","Description","Extent","Remediation"
"Az.NeonPostgres","Get-AzNeonPostgresNeonDatabase","2","1","Invalid_Parameter_Name","5011","1","Get-AzNeonPostgresNeonDatabase -DatabaseName is not a valid parameter name.","-DatabaseName","Check validity of the parameter -DatabaseName."
"Az.NeonPostgres","Get-AzNeonPostgresNeonDatabase","2","1","Invalid_Parameter_Name","5011","1","Get-AzNeonPostgresNeonDatabase -DatabaseName is not a valid parameter name.","-DatabaseName","Check validity of the parameter -DatabaseName."

@alluri02
Copy link
Member Author

@alluri02 Please fix the following issues. "Module","Cmdlet","Example","Line","RuleName","ProblemId","Severity","Description","Extent","Remediation" "Az.NeonPostgres","Get-AzNeonPostgresNeonDatabase","2","1","Invalid_Parameter_Name","5011","1","Get-AzNeonPostgresNeonDatabase -DatabaseName is not a valid parameter name.","-DatabaseName","Check validity of the parameter -DatabaseName." "Az.NeonPostgres","Get-AzNeonPostgresNeonDatabase","2","1","Invalid_Parameter_Name","5011","1","Get-AzNeonPostgresNeonDatabase -DatabaseName is not a valid parameter name.","-DatabaseName","Check validity of the parameter -DatabaseName."

@vidai-msft fixed this issue, could you please run the /azp run.

@vidai-msft
Copy link
Contributor

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@vidai-msft
Copy link
Contributor

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@vidai-msft
Copy link
Contributor

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

```

```output
{{ Add output here (remove the output block if the example doesn't have an output) }}
Copy link
Contributor

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?

Copy link
Member Author

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

Copy link
Contributor

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) }}
Copy link
Contributor

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.

Copy link
Member Author

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' {
Copy link
Contributor

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?

Copy link
Member Author

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' {
Copy link
Contributor

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this empty line.

Copy link
Member Author

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
Copy link
Contributor

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.

Copy link
Member Author

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
Copy link
Contributor

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@vidai-msft
Copy link
Contributor

@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.

@vidai-msft
Copy link
Contributor

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@alluri02
Copy link
Member Author

@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.

Done

```

```output
{{ Add output here (remove the output block if the example doesn't have an output) }}
Copy link
Contributor

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?

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

Successfully merging this pull request may close these issues.

4 participants