Skip to content
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

[SSH] Update ssh.helper generated code #27222

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

Conversation

lijinpei2008
Copy link
Contributor

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.

@lijinpei2008 lijinpei2008 marked this pull request as ready for review February 25, 2025 08:49
@VeryEarly
Copy link
Collaborator

this PR is similar to #27170, why is changelog needed here?
image

@lijinpei2008
Copy link
Contributor Author

this PR is similar to #27170, why is changelog needed here? image

The original Ssh.Helper code was generated via autorest CSharp, now the commit to code is generated via autorest powershell. Although the functionality provided is the same, the tools used to generate it are different, so it is important to differentiate between the versions, thus updating the changelog.md file.

@lijinpei2008
Copy link
Contributor Author

this PR is similar to #27170, why is changelog needed here? image

The original Ssh.Helper code was generated via autorest CSharp, now the commit to code is generated via autorest powershell. Although the functionality provided is the same, the tools used to generate it are different, so it is important to differentiate between the versions, thus updating the changelog.md file.

what are different from #27170 ?

In the PS Gallery, the current version of Az.SSH is 0.2.2, and the code for Ssh.Helper called by commands in this version is generated by the tool autorest.CSharp.
The code I am submitting for Ssh.Helper is generated by the tool autorest.powershell.
When that code is merged and released, the Az.SSH version number released to the public may be 0.2.3 or 0.3.0, but in any case the version number has changed, so I need to submit a ChangLog note.

Since the difference between the old and new versions is that the code generation tool for Ssh.Helper has changed, a description has been added to the ChangeLog.md file: * Migrated Ssh.Helper generation from autorest csharp to autorest powershell.

In #27170, the module I'm working with is Az.Websites, in the current PR the module I'm working with is Az.SSH.

@lijinpei2008
Copy link
Contributor Author

lijinpei2008 commented Feb 27, 2025

The changelog is described as: * Implemented code refactoring, no behavior changes expected.

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

Successfully merging this pull request may close these issues.

2 participants