microsoft/azure-pipelines-task-lib

Implement log grouping commands

MariusStorhaug opened this issue · 4 comments

Objective

To enhance the Azure Pipelines Task Library (azure-pipelines-task-lib) by introducing functionality for log grouping commands. This feature aims to provide developers with an easy and standardized way to group log outputs in Azure DevOps tasks, improving log readability and organization.

Links:

Proposed Feature

  • Log Group Commands: Implement two new commands in the task library:
    • group: Starts a new log group with an optional name.
    • endgroup: Ends the current log group.

Details

  • The group command should format the log as '##[group]Group name here', where "Group name here" is the optional name of the log group.
  • The endgroup command should simply be '##[endgroup]', signaling the end of the current log group.
  • These commands will be implemented as methods in a class (possibly similar as TaskCommand) in the Node.js version of the library.
  • The implementation should ensure compatibility with existing logging mechanisms and should not break any current functionality.

Use Case

  • Task developers can use these commands to group related log outputs, making the logs more organized and easier to navigate, especially in complex tasks with multiple operations.

Expected Impact

  • Improved log readability and management in Azure DevOps pipelines.
  • Enhanced developer experience when creating and debugging Azure DevOps tasks.

Feedback and suggestions on this proposal are welcome!

@MariusStorhaug thanks for reporting!
We are working on more prioritized issues at the moment but will get back to this one soon.

@max-zaytsev any update on the following issue? I have the PR #994 that should add this functionality.

This issue has had no activity in 90 days. Please comment if it is not actually stale