Creating index.json for Docs #5831
Conversation
|
updated: |
tools/CleanupBuild.ps1
Outdated
| @@ -9,6 +9,7 @@ $output = Join-Path (Get-Item $PSScriptRoot).Parent.FullName "src\Package\$Build | |||
| Write-Verbose "The output folder is set to $output" | |||
| $serviceManagementPath = Join-Path $output "ServiceManagement\Azure" | |||
| $resourceManagerPath = Join-Path $output "ResourceManager\AzureResourceManager" | |||
| $stackPath = "src\Stack\$BuildConfig\ResourceManager\AzureResourceManager" | |||
There was a problem hiding this comment.
@maddieclayton we should make sure that we're using the full path here, like we do for the above $output variable
$stackOutput = Join-Path (Get-Item $PSScriptRoot).Parent.FullName "src\Stack\$BuildConfig"
$stackPath = Join-Path $stackOutput "ResourceManager\AzureResourceManager"
tools/CreateMappings.ps1
Outdated
| [string] $OutputFile = "groupMapping.json", | ||
| [string] $WarningFile = "groupMappingWarnings.json", | ||
| [string] $RulesFile = "CreateMappings_rules.json" | ||
| [string] $RootPath = "$PSCommandPath\..\..\src", |
There was a problem hiding this comment.
@maddieclayton any reason to not keep these variables the same?
| @@ -50,14 +50,14 @@ function Get-TargetModules | |||
| if ($listOfModules.Count -ge 1) | |||
| { | |||
| $moduleList | ForEach-Object { | |||
| $targets += Find-Module -Name $_ -Repository $repoName | |||
| $targets += Find-Module -Name $_ -Repository $repoName -AllowPrerelease | |||
There was a problem hiding this comment.
@maddieclayton we may need to check for version 1.6.0 or greater of PowerShellGet before calling one of the module's cmdlets with -AllowPrerelease, or we could put a #requires at the top that specifies you need at least that version of PowerShellGet before running this script
tools/NewHelpIndex.ps1
Outdated
| if ([string]::isNullOrEmpty($Version)) | ||
| { | ||
| Import-LocalizedData -BindingVariable "AzureRMpsd1" -BaseDirectory $PSCommandPath/../AzureRM -FileName "AzureRM.psd1" | ||
| $Version = $AzureRMpsd1.ModuleVersion |
There was a problem hiding this comment.
@maddieclayton for the places where we're using "default values" (Version, SourceBaseUri, EditBaseUri), we should write a message to the screen letting the user know what the values are being set to
tools/NewHelpIndex.ps1
Outdated
| [Parameter(Mandatory = $false)] | ||
| [string] $BuildConfig = "Debug", | ||
| [Parameter(Mandatory = $false)] | ||
| [string] $OutputFile = "$PSCommandPath/../index.json" |
There was a problem hiding this comment.
@maddieclayton any reason for using $PSCommandPath over $PSScriptRoot? You could save yourself from typing an extra /.. each time
tools/DeleteModules.ps1
Outdated
| @@ -12,7 +12,7 @@ | |||
| # limitations under the License. | |||
| # ---------------------------------------------------------------------------------- | |||
|
|
|||
| #Requires -Modules AzureRM.KeyVault | |||
| #Requires -Modules AzureRM.KeyVault, PowerShellGet > 1,6,0 | |||
There was a problem hiding this comment.
#Requires -Modules AzureRM.KeyVault, @{ModuleName='PowerShellGet';ModuleVersion='1.6.0'}
| # ---------------------------------------------------------------------------------- | ||
|
|
||
| [CmdletBinding( | ||
| SupportsShouldProcess=$true |
There was a problem hiding this comment.
@maddieclayton nit: if we're not doing anything with this in the script, we should remove it
Description
Won't merge until we get sign-off from Docs.
#5806
Checklist
CONTRIBUTING.mdplatyPSmodule