-
Notifications
You must be signed in to change notification settings - Fork 150
Extended debug logging #1729
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
Extended debug logging #1729
Conversation
Leaving this is draft state until I come back from vacation. |
…ons to print groups and color support for regular logs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! The extended debug logging improvements look good and will help with troubleshooting AL-Go workflows. The changes appear well-structured and maintain backward compatibility.
…debug mode, as we automatically handle that now.
…nto ExtendedDebugLogging
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One more iteration is needed perhaps.
Release notes are currently missing.
There was a problem hiding this 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 adds extended debug logging support by introducing a shared DebugLogHelper
module, wiring it into existing scripts, and updating documentation.
- Introduce
DebugLogHelper.psm1
with reusable logging functions - Update various dev environment and action scripts to download/import the new module
- Remove inline logging functions from
AL-Go-Helper.ps1
and note the change inRELEASENOTES.md
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
Tests/TestActionsHelper.psm1 | Import DebugLogHelper for test helper functions |
Templates/Per Tenant Extension/.AL-Go/localDevEnv.ps1 | Download & import DebugLogHelper |
Templates/Per Tenant Extension/.AL-Go/cloudDevEnv.ps1 | Download & import DebugLogHelper |
Templates/AppSource App/.AL-Go/localDevEnv.ps1 | Download & import DebugLogHelper |
Templates/AppSource App/.AL-Go/cloudDevEnv.ps1 | Download & import DebugLogHelper |
RELEASENOTES.md | Add section about extended debug logging |
Actions/Invoke-AlGoAction.ps1 | Import DebugLogHelper |
Actions/DetermineDeploymentEnvironments/DetermineDeploymentEnvironments.ps1 | Add OutputDebugFunctionCall and OutputDebug calls |
Actions/AL-Go-Helper.ps1 | Import DebugLogHelper and remove legacy logging code |
Actions/.Modules/DebugLogHelper.psm1 | New module defining debug/logging helper functions |
Comments suppressed due to low confidence (3)
Templates/Per Tenant Extension/.AL-Go/localDevEnv.ps1:60
- [nitpick] Variable naming is inconsistent with other path variables (
$GitHubHelperPath
,$ReadSettingsModule
); consider renaming$debugLoggingModule
to$DebugLoggingModule
for consistency.
$debugLoggingModule = DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/.Modules/DebugLogHelper.psm1' -folder $tmpFolder
Actions/.Modules/DebugLogHelper.psm1:2
- New debug helper functions (
OutputDebugFunctionCall
,OutputGroupStart
, etc.) are introduced here but there are no unit tests covering them; consider adding tests to validate their behavior.
if ($env:GITHUB_ACTIONS -eq "true") {
Actions/.Modules/DebugLogHelper.psm1:217
- The module attempts to export a variable
debugLoggingEnabled
, but this variable is never defined; either declare and initializedebugLoggingEnabled
or remove it fromExport-ModuleMember
.
Export-ModuleMember -Function OutputColor, OutputDebugFunctionCall, OutputGroupStart, OutputGroupEnd, OutputError, OutputWarning, OutputNotice, MaskValueInLog, OutputDebug
No description provided.