Skip to content

Add breaking change documents for each service #3097

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 6 commits into from
Oct 27, 2016

Conversation

cormacpayne
Copy link
Member

@cormacpayne cormacpayne commented Oct 19, 2016

Description

Fix for issue #3028

  • Added documentation folder for each service
    • upcoming-breaking-changes.md
      -current-breaking-changes.md
  • Added script that will maintain breaking change documents during release and move the contents of each current-breaking-changes.md to the master file that will serve as the overall migration guide
  • Updated contributing guide to include this information

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

  • Title of the pull request is clear and informative.
  • 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.
  • The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).

Testing Guidelines

  • Pull request includes test coverage for the included changes.
  • 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

  • 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.
  • Cmdlet specifies OutputType attribute if any output is produced - if the cmdlet produces no output, it should implement a PassThrough parameter.

Cmdlet Parameter Guidelines

  • Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
  • 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.
  • Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

@markcowl markcowl self-assigned this Oct 20, 2016
Copy link
Member

@markcowl markcowl left a comment

Choose a reason for hiding this comment

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

Looks good, a couple of comments.

@@ -104,6 +104,12 @@ If splitting up the pull request is not an option, we recommend **creating indiv

For more information on cleaning up the commits in a pull request, such as how to rebase, squash, and cherry-pick, click [here](./documentation/cleaning-up-commits.md).

#### Breaking Changes

Breaking changes should **not** be introduced into the repository without giving customers at least six months notice. For a full list of breaking changes in Azure PowerShell, click [here](https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes.md).
Copy link
Member

Choose a reason for hiding this comment

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

For a description of breaking changes in powershell, see...

function GetModuleVersion([string]$PathToModule)
{
# Get the content of the psd1 file
$content = Get-Content -Path $PathToModule -Encoding UTF8
Copy link
Member

Choose a reason for hiding this comment

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

Can we use Test-ModuleManifest

@markcowl
Copy link
Member

@cormacpayne there are conflicts, please update

@markcowl markcowl assigned cormacpayne and unassigned markcowl Oct 25, 2016
$PathToRepo = "$PSScriptRoot\.."
}

Import-Module PowerShellGet
Copy link
Member

Choose a reason for hiding this comment

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

@markcowl
Copy link
Member

on demand run here: http://azuresdkci.cloudapp.net/view/1-AzurePowerShell/job/powershell-demand/1261/

LGTM once the ci build passes.

@markcowl markcowl merged commit 51c8809 into Azure:dev Oct 27, 2016
@cormacpayne cormacpayne deleted the breaking-change-module-docs branch October 28, 2016 20:39
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.

3 participants