Skip to content

Conversation

@isra-fel
Copy link
Member

Description

The errors were detected but did not block the PR validation. Need to follow up. For example: #28623

-------------------- Start generating help ... --------------------
MSBuild version 17.11.48+02bf66295 for .NET
  Running help generation...
  
  Target      : Invoke-AzSearchNetworkSecurityPerimeterConfigurationReconcile.md
  Description : Online version in the header of the file is incorrect. The corresponding URL should be the following: htt
                ps://learn.microsoft.com/powershell/module/az.search/invoke-azsearchnetworksecurityperimeterconfiguration
                reconcile
  
  Target      : Invoke-AzSearchServiceUpgrade.md
  Description : Online version in the header of the file is incorrect. The corresponding URL should be the following: 
                https://learn.microsoft.com/powershell/module/az.search/invoke-azsearchserviceupgrade
  
  Exception: D:\a\_work\1\s\tools\GenerateHelp.ps1:74
  Line |
    74 |          throw "A markdown file containing the help for a cmdlet is in .
       |          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
       | A markdown file containing the help for a cmdlet is incomplete. Please check the exceptions provided for more
       | details.
D:\a\_work\1\s\build.proj(205,5): error MSB3073: The command "pwsh -NonInteractive -NoLogo -NoProfile -Command "Set-Variable -Name ProgressPreference -Value 'SilentlyContinue';. D:\a\_work\1\s\tools/GenerateHelp.ps1 -ValidateMarkdownHelp -GenerateMamlHelp -BuildConfig Debug"" exited with code 1.
-------------------- End generating help ... --------------------

Mandatory Checklist

  • SHOULD update ChangeLog.md file(s) appropriately
    • Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
      • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT adjust version of module manually in pull request

Copilot AI review requested due to automatic review settings October 27, 2025 05:50
@azure-client-tools-bot-prd
Copy link

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes missing online documentation links in markdown help files that were causing build failures during help generation. The help generation step was detecting empty online version: fields and throwing errors, blocking the daily release process.

Key Changes:

  • Added proper Microsoft Learn documentation URLs to the online version field in five cmdlet help files
  • Fixed validation errors in both Az.SignalR and Az.Search modules

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/SignalR/SignalR/help/Remove-AzSignalRNetworkIpRule.md Added online documentation link for Remove-AzSignalRNetworkIpRule cmdlet
src/SignalR/SignalR/help/New-AzSignalRNetworkIpRuleObject.md Added online documentation link for New-AzSignalRNetworkIpRuleObject cmdlet
src/SignalR/SignalR/help/Add-AzSignalRNetworkIpRule.md Added online documentation link for Add-AzSignalRNetworkIpRule cmdlet
src/Search/Search/help/Invoke-AzSearchServiceUpgrade.md Added online documentation link for Invoke-AzSearchServiceUpgrade cmdlet
src/Search/Search/help/Invoke-AzSearchNetworkSecurityPerimeterConfigurationReconcile.md Added online documentation link for Invoke-AzSearchNetworkSecurityPerimeterConfigurationReconcile cmdlet

@isra-fel isra-fel enabled auto-merge (squash) October 27, 2025 06:11
@isra-fel isra-fel merged commit 05e01af into main Oct 27, 2025
12 checks passed
@isra-fel isra-fel deleted the isra-fel-patch-1 branch October 27, 2025 06:25
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