Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
There was a problem hiding this comment.
Pull request overview
This PR updates the Az.ComputeLimit module’s packaging and documentation assets to address an out-of-box failure scenario, primarily by aligning help/solution/manifest artifacts with the generated AutoRest output.
Changes:
- Updated cmdlet markdown help files (parameter sets/signatures and external help file metadata).
- Updated module packaging artifacts (module manifest exports and solution project reference to generated csproj).
- Adjusted test environment loading script and added module docs/resources metadata files.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| src/ComputeLimit/ComputeLimit/help/Add-AzGuestSubscription.md | Refreshes help metadata and parameter set sections for Add-AzGuestSubscription. |
| src/ComputeLimit/ComputeLimit/help/Add-AzSharedLimit.md | Refreshes help metadata and parameter set sections for Add-AzSharedLimit. |
| src/ComputeLimit/ComputeLimit/help/Get-AzGuestSubscription.md | Refreshes help metadata and parameter set sections for Get-AzGuestSubscription. |
| src/ComputeLimit/ComputeLimit/help/Get-AzSharedLimit.md | Refreshes help metadata and parameter set sections for Get-AzSharedLimit. |
| src/ComputeLimit/ComputeLimit/help/Remove-AzGuestSubscription.md | Refreshes help metadata and parameter set sections for Remove-AzGuestSubscription. |
| src/ComputeLimit/ComputeLimit/help/Remove-AzSharedLimit.md | Refreshes help metadata and parameter set sections for Remove-AzSharedLimit. |
| src/ComputeLimit/ComputeLimit/ChangeLog.md | Touches release notes structure around Upcoming Release / initial version section. |
| src/ComputeLimit/ComputeLimit/Az.ComputeLimit.psd1 | Adjusts manifest export settings (aliases/variables) and updates generated timestamp. |
| src/ComputeLimit/ComputeLimit.sln | Repoints Az.ComputeLimit project to the generated ComputeLimit.Autorest csproj and updates project GUID mappings. |
| src/ComputeLimit/ComputeLimit.Autorest/test/loadEnv.ps1 | Updates how env json is read for tests. |
| src/ComputeLimit/ComputeLimit.Autorest/resources/README.md | Adds repository-only resources folder README for the module. |
| src/ComputeLimit/ComputeLimit.Autorest/generate-info.json | Updates generation tracking id. |
| src/ComputeLimit/ComputeLimit.Autorest/docs/Az.ComputeLimit.md | Adds module landing page for generated help docs. |
| @@ -0,0 +1,11 @@ | |||
| # Resources | |||
| This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `..\custom` folder. | |||
There was a problem hiding this comment.
This README uses a Windows-style relative path (..\custom). Other module template READMEs in this repo use forward-slash relative paths (../custom) for consistency and to avoid confusion on non-Windows platforms; update the path accordingly.
| This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `..\custom` folder. | |
| This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `../custom` folder. |
| @@ -18,4 +18,6 @@ | |||
| - Additional information about change #1 | |||
| --> | |||
| ## Upcoming Release | |||
There was a problem hiding this comment.
## Upcoming Release is empty, but this PR changes module packaging/build artifacts (manifest/solution/help). Either add a brief user-facing entry under ## Upcoming Release describing the fix (and reference the related issue if applicable), or revert the changelog edit if no release note is intended.
| ## Upcoming Release | |
| ## Upcoming Release | |
| * Updated packaging configuration for Az.ComputeLimit module | |
| - No changes to cmdlet behavior, improved build and manifest setup |
| --> | ||
| ## Upcoming Release | ||
|
|
||
| ## Version 0.1.0 |
There was a problem hiding this comment.
The changelog template at the top specifies release sections should be titled ## YYYY.MM.DD - Version X.Y.Z. ## Version 0.1.0 doesn’t follow that format; please include the release date in the header to match the documented convention.
| ## Version 0.1.0 | |
| ## 2024.01.01 - Version 0.1.0 |
| $env = @{} | ||
| if (Test-Path -Path $envFilePath) { | ||
| $env = Get-Content $envFilePath | ConvertFrom-Json | ||
| $env = Get-Content (Join-Path $PSScriptRoot $envFile) | ConvertFrom-Json |
There was a problem hiding this comment.
$envFilePath is computed above (including the fallback to the parent directory), but the file is read using (Join-Path $PSScriptRoot $envFile) instead. This ignores the fallback logic and will fail when the env json only exists at $envFilePath. Use $envFilePath for Get-Content (and keep path resolution in one place).
| $env = Get-Content (Join-Path $PSScriptRoot $envFile) | ConvertFrom-Json | |
| $env = Get-Content -Path $envFilePath | ConvertFrom-Json |
| } else { | ||
| $envFilePath = Join-Path $PSScriptRoot '..\$envFile' | ||
| } |
There was a problem hiding this comment.
The fallback path uses Join-Path $PSScriptRoot '..\$envFile' inside single quotes, so $envFile is not expanded and the literal string ..\$envFile is used. Build the fallback path without single-quoting the variable portion (e.g., join .. and $envFile as separate path segments).
| @@ -1,4 +1,4 @@ | |||
| | |||
|
|
|||
There was a problem hiding this comment.
The solution file now has a blank first line before Microsoft Visual Studio Solution File, Format Version 12.00. Some tooling expects the header on the first line; remove the leading empty line (if the intent was to drop a UTF-8 BOM, ensure the header remains the first line).
Description
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.