Skip to content

Commit 2be4d7a

Browse files
committed
Update documentation and add logic for AzureRM.psd1 release notes
1 parent 2e4f35b commit 2be4d7a

File tree

3 files changed

+16
-0
lines changed

3 files changed

+16
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ If applicable, reference the bug/issue that this pull request fixes here.
1212
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](https://msdn.microsoft.com/en-us/library/dd878270(v=vs.85).aspx).
1313

1414
- [ ] **I have read the [contribution guidelines](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md).**
15+
- [ ] **If changes were made to any cmdlet, the XML help was regenerated using the [platyPSHelp module](https://github.com/Azure/azure-powershell/blob/dev/documentation/platyps-help.md).**
16+
- [ ] **If any large changes are made to a service, they are reflected in the respective [change log](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md#updating-the-change-log).**
1517

1618
### [General Guidelines](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md#general-guidelines)
1719
- [ ] Title of the pull request is clear and informative.

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ In the Azure Developer Experience, you are at Step 5:
2626
- [SDK for .NET](#sdk-for-net)
2727
- [Pull Request Guidelines](#pull-request-guidelines)
2828
- [Cleaning up commits](#cleaning-up-commits)
29+
- [Updating the change log](#updating-the-change-log)
2930
- [General guidelines](#general-guidelines)
3031
- [Testing guidelines](#testing-guidelines)
3132
- [Cmdlet signature guidelines](#cmdlet-signature-guidelines)
@@ -104,6 +105,16 @@ If splitting up the pull request is not an option, we recommend **creating indiv
104105

105106
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).
106107

108+
#### Updating the change log
109+
110+
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.
111+
112+
For ResourceManager services, the change log is located at `src\ResourceManager\SERVICE\ChangeLog.md`.
113+
114+
For ServiceManagement services, the change log is located at `src\ServiceManagement\Services\Commands.Utilities\ChangeLog.md`.
115+
116+
For Storage, this change log is located at `src\Storage\ChangeLog.md`.
117+
107118
#### General guidelines
108119

109120
The following guidelines must be followed in **EVERY** pull request that is opened.

tools/UpdateChangeLog.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -384,9 +384,12 @@ $StorageResult = UpdateLog -PathToChangeLog $PathToChangeLog -PathToModule $Path
384384
$result = @()
385385

386386
# If any changes were made to ARM services, add them to the list to be added to the master change log
387+
# Also, we need to update AzureRM.psd1 with all of the changes made to ARM services
387388
if ($ResourceManagerResult.Length -gt 0)
388389
{
389390
$result += $ResourceManagerResult
391+
392+
UpdateModule -PathToModule "$PathToRepo\tools\AzureRM\AzureRM.psd1" -ChangeLogContent $ResourceManagerResult
390393
}
391394

392395
# If any changes were made to RDFE services, add them to the list to be added to the master change log

0 commit comments

Comments
 (0)