Skip to content

Change Get-​Azure​Rm​Web​App​Publishing​Profile -OutputFile mandatory to option. #4827

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

Merged
merged 8 commits into from
Nov 1, 2017

Conversation

takekazuomi
Copy link
Contributor

@takekazuomi takekazuomi commented Oct 21, 2017

Description

OutputFile contains credentials. The current cmdlet returns XML, so you do not need to write it in a file.
Mandatory is bad design.

fix #4212

This checklist is used to make sure that common guidelines for a pull request are followed. You can find a more complete discussion of PowerShell cmdlet best practices here.

General Guidelines

  • [ x] Title of the pull request is clear and informative.
  • [ x] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.
  • [ x] The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).

Testing Guidelines

  • [ x] Pull request includes test coverage for the included changes.
  • [ x] PowerShell scripts used in tests should do any necessary setup as part of the test or suite setup, and should not use hard-coded values for locations or existing resources.

Cmdlet Signature Guidelines

  • [x ] New cmdlets that make changes or have side effects should implement ShouldProcess and have SupportShouldProcess=true specified in the cmdlet attribute. You can find more information on ShouldProcess here.
  • [ x] Cmdlet specifies OutputType attribute if any output is produced - if the cmdlet produces no output, it should implement a PassThru parameter.

Cmdlet Parameter Guidelines

  • [ x] Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
  • [ x] Complex parameter types are discouraged - a parameter type should be simple types as often as possible. If complex types are used, they should be shallow and easily creatable from a constructor or another cmdlet.
  • [ x] Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

… to option.

OutputFile contains credentials. The current cmdlet returns XML, so you do not need to write it in a file.
Mandatory is bad design.

fix #4212
@takekazuomi
Copy link
Contributor Author

I had some mistake in test scenario. I will fix later. Please give me some time.

@takekazuomi
Copy link
Contributor Author

@markcowl I corrected and confirmed that there is no problem locally. But your Jenkins seems to be broken.
Could you help me isolate the problem?

ahmedelnably
ahmedelnably previously approved these changes Oct 31, 2017
Copy link

@ahmedelnably ahmedelnably left a comment

Choose a reason for hiding this comment

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

Thanks for the proposing the change, it is actually a good one.
approving the change.

@maddieclayton
Copy link
Contributor

@takekazuomi Can you regenerate the help files to reflect this change to the cmdlets? The documentation on how to do that is here

@takekazuomi
Copy link
Contributor Author

@maddieclayton I regenerated help and confirmed the preview. LGTM

@cormacpayne cormacpayne merged commit 83a91b2 into Azure:preview Nov 1, 2017
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.

6 participants