Skip to content

Add change log for each service #3085

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 9 commits into from
Oct 25, 2016
Merged

Conversation

cormacpayne
Copy link
Member

@cormacpayne cormacpayne commented Oct 14, 2016

Description

Fix for issue #3027

  • Added change log for each service
  • Added script that will maintain change logs during release and move their contents to the "Release Notes" section of the respective .psd1 file
  • Updated documentation and pull request template to include these changes

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.

@cormacpayne cormacpayne changed the title Add change log for each service [HOLD] Add change log for each service Oct 17, 2016
@cormacpayne cormacpayne changed the title [HOLD] Add change log for each service Add change log for each service Oct 18, 2016
@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.

If we can use Test_moduelManifest to get manifest information and Update-ModuleManifest to update it, we should. One textual change, otherwise this looks great.

@@ -104,6 +105,16 @@ 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).

#### Updating the change log

Any large changes that are made to a service must be reflected in the respecitve change log. This change log will allow customers to easily track what has been changed between releases of a service.
Copy link
Member

Choose a reason for hiding this comment

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

Any public API changes...


# The size of the new file will be everything in the array we got from
# UpdateServiceChangeLog, except we exclude the last line (which is assumed to be blank)
$size = $content.Length + $ChangeLogContent.Length - 1
Copy link
Member

Choose a reason for hiding this comment

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

Is there a reason we cannot use Update-ModuleManifest?

<#
This function will use the psd1 file to grab the module version.
#>
function GetModuleVersion([string]$PathToModule)
Copy link
Member

Choose a reason for hiding this comment

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

is there a reason we can't use Test-ModuleManifest

@markcowl markcowl merged commit c2b6dc7 into Azure:dev Oct 25, 2016
@cormacpayne cormacpayne mentioned this pull request Oct 25, 2016
4 tasks
@cormacpayne cormacpayne deleted the add-changelogs branch October 28, 2016 20:40
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