-
Notifications
You must be signed in to change notification settings - Fork 4k
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
Conversation
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.
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). |
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.
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 |
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 we use Test-ModuleManifest
@cormacpayne there are conflicts, please update |
$PathToRepo = "$PSScriptRoot\.." | ||
} | ||
|
||
Import-Module PowerShellGet |
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.
You can use #Requires here: https://technet.microsoft.com/en-us/library/hh847765.aspx
on demand run here: http://azuresdkci.cloudapp.net/view/1-AzurePowerShell/job/powershell-demand/1261/ LGTM once the ci build passes. |
Description
Fix for issue #3028
upcoming-breaking-changes.md
-
current-breaking-changes.md
current-breaking-changes.md
to the master file that will serve as the overall migration guideThis 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
Testing Guidelines
Cmdlet Signature Guidelines
ShouldProcess
and haveSupportShouldProcess=true
specified in the cmdlet attribute. You can find more information onShouldProcess
here.OutputType
attribute if any output is produced - if the cmdlet produces no output, it should implement aPassThrough
parameter.Cmdlet Parameter Guidelines